diff --git a/docs/search/search_index.json b/docs/search/search_index.json deleted file mode 100644 index 7e2704f..0000000 --- a/docs/search/search_index.json +++ /dev/null @@ -1 +0,0 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"WebBTC A common convention in the Bitcoin web application ecosystem is for key management software (\u201cwallets\u201d) to expose their API via a JavaScript object in the web page. This object is called the common web wallet interface. Historically, Provider implementations have exhibited conflicting interfaces and behaviors between wallets. This working group formalizes an Bitcoin extension API to promote wallet interoperability. The API is designed to be minimal, event-driven, and agnostic of transport and RPC protocols. Its functionality is easily extended by defining new RPC methods and message event types. Historically, providers have been made available as window.bitcoin or window.webln in web browsers, but this convention is not part of the specification. A list of current work in progress can be tracked from the issues tab in the playground repository , which includes a functional spec demonstration. A hosted instance of the demo can be found here together with the accompanying specification documentation .","title":"Overview"},{"location":"#webbtc","text":"A common convention in the Bitcoin web application ecosystem is for key management software (\u201cwallets\u201d) to expose their API via a JavaScript object in the web page. This object is called the common web wallet interface. Historically, Provider implementations have exhibited conflicting interfaces and behaviors between wallets. This working group formalizes an Bitcoin extension API to promote wallet interoperability. The API is designed to be minimal, event-driven, and agnostic of transport and RPC protocols. Its functionality is easily extended by defining new RPC methods and message event types. Historically, providers have been made available as window.bitcoin or window.webln in web browsers, but this convention is not part of the specification. A list of current work in progress can be tracked from the issues tab in the playground repository , which includes a functional spec demonstration. A hosted instance of the demo can be found here together with the accompanying specification documentation .","title":"WebBTC"},{"location":"authentication/","text":"","title":"Authentication"},{"location":"enable/","text":"Enable Wallet The enable method is called to allow access to further API methods from the wallet. Syntax enable() Parameters None Returns Object enabled : Boolean Required addresses : AddressObjArray Optional address: String derivationPath: String publicKey: String NOTE: The AddressObjArray here can be returned for Onchain wallets but can also be used ny WebLN wallets which also expose the onchain wallet functions. This typically is used to show that a wallet is connected to the page. Example // Enable wallet window.webbtc.enable() { address: { address: \"bc1q9zw3q496dcx2qu5pvhvg0zwfsxgj79nhh5rqct\" derivationPath: \"84'/0'/0'/0/0\" publicKey: \"031ecb71f390fcffc8727bedc5fb563e7bf90cd9725b1519e1ef74a16ca7a30fe3\" }, success: true } // Check if the wallet is enabled window.webbtc.enabled true // Check if wallet is enabled, invoke enable when false if (!window.webbtc.enabled) window.webbtc.enable() Notes Application specific on wether or not to trust once or always. On invoking the enable call the application developer provides an interface which may or may not prompt the user to accept the request.","title":"Enabling"},{"location":"enable/#enable-wallet","text":"The enable method is called to allow access to further API methods from the wallet.","title":"Enable Wallet"},{"location":"enable/#syntax","text":"enable()","title":"Syntax"},{"location":"enable/#parameters","text":"None","title":"Parameters"},{"location":"enable/#returns","text":"Object enabled : Boolean Required addresses : AddressObjArray Optional address: String derivationPath: String publicKey: String NOTE: The AddressObjArray here can be returned for Onchain wallets but can also be used ny WebLN wallets which also expose the onchain wallet functions. This typically is used to show that a wallet is connected to the page.","title":"Returns"},{"location":"enable/#example","text":"// Enable wallet window.webbtc.enable() { address: { address: \"bc1q9zw3q496dcx2qu5pvhvg0zwfsxgj79nhh5rqct\" derivationPath: \"84'/0'/0'/0/0\" publicKey: \"031ecb71f390fcffc8727bedc5fb563e7bf90cd9725b1519e1ef74a16ca7a30fe3\" }, success: true } // Check if the wallet is enabled window.webbtc.enabled true // Check if wallet is enabled, invoke enable when false if (!window.webbtc.enabled) window.webbtc.enable()","title":"Example"},{"location":"enable/#notes","text":"Application specific on wether or not to trust once or always. On invoking the enable call the application developer provides an interface which may or may not prompt the user to accept the request.","title":"Notes"},{"location":"getting_started/","text":"Getting Started","title":"Getting Started"},{"location":"getting_started/#getting-started","text":"","title":"Getting Started"},{"location":"info/","text":"Get wallet information The getInfo method is called to obtain supported features and capabilities of the wallet. Syntax getInfo() Parameters None Returns Object version : Number | String Required methods : Array Optional supports : Array Optional Example window.webbtc.getInfo() { \"version\" : 1, \"supports\" : [ \"bip39\", \"bip32\" ], \"methods\": [ // schema for available methods \"enable\", \"getInfo\", \"getAddress\", \"signMessage\", \"verifyMessage\", \"makeInvoice\", \"sendPayment\" ] } Additional notes The above method might be extended to include helper methods which include. window.webbtc.getMethods() window.webbtc.getVersion() window.webbtc.getServices() NOTE: Method for obtaining existing supported permissions that the user could approve when enabling the wallet. Application specific implementation details can vary based on the security preference. Concerns and security observations Possible finger printing of users if this method is accessible without enabling it first.","title":"info"},{"location":"info/#get-wallet-information","text":"The getInfo method is called to obtain supported features and capabilities of the wallet.","title":"Get wallet information"},{"location":"info/#syntax","text":"getInfo()","title":"Syntax"},{"location":"info/#parameters","text":"None","title":"Parameters"},{"location":"info/#returns","text":"Object version : Number | String Required methods : Array Optional supports : Array Optional","title":"Returns"},{"location":"info/#example","text":"window.webbtc.getInfo() { \"version\" : 1, \"supports\" : [ \"bip39\", \"bip32\" ], \"methods\": [ // schema for available methods \"enable\", \"getInfo\", \"getAddress\", \"signMessage\", \"verifyMessage\", \"makeInvoice\", \"sendPayment\" ] }","title":"Example"},{"location":"info/#additional-notes","text":"The above method might be extended to include helper methods which include. window.webbtc.getMethods() window.webbtc.getVersion() window.webbtc.getServices() NOTE: Method for obtaining existing supported permissions that the user could approve when enabling the wallet. Application specific implementation details can vary based on the security preference.","title":"Additional notes"},{"location":"info/#concerns-and-security-observations","text":"Possible finger printing of users if this method is accessible without enabling it first.","title":"Concerns and security observations"},{"location":"permissions/","text":"","title":"Permissions"},{"location":"references/","text":"References Spec Demo Onchain Wallet Documentation A WebLN playground WebLN Documentation WebLN Guide","title":"Resources"},{"location":"references/#references","text":"Spec Demo Onchain Wallet Documentation A WebLN playground WebLN Documentation WebLN Guide","title":"References"},{"location":"services/","text":"Services","title":"Services"},{"location":"services/#services","text":"","title":"Services"},{"location":"squatting/","text":"Extension namespace squatting Historically, providers have been made available as window.bitcoin or window.webln in web browsers, but this convention is not part of the specification.","title":"Namespace Squatting"},{"location":"squatting/#extension-namespace-squatting","text":"Historically, providers have been made available as window.bitcoin or window.webln in web browsers, but this convention is not part of the specification.","title":"Extension namespace squatting"},{"location":"addresses/getAddress/","text":"Get addresses from wallet The getAddresses method is called to obtain an onchain address from the wallet. NOTE: WebLN implementations might choose to implement this method when exposing access to the onchain wallet. Syntax getAddresses(index?, num?, change?) Parameters index: Number (default 0) - Which index to start from Optional num: Number (default 1) - Number of addresses to retrieve Optional change: Boolean (default false) - true for change addresses, false for external Optional Returns AddressObjectArray - An array of bitcoin address objects Required address: String - Bitcoin address Required derivationPath: String - Derivation path of the address e.g. \"84'/1'/0'/0/0\" Optional publicKey: String(Hex) - The public key for the derivation path Optional index: Number - Index of the address Optional Example await window.webbtc.getAddresses(0, 10, false) [{ address: \"tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2\", derivationPath: \"84'/1'/0'/0/0\", publicKey: { \u2026}, index: 0 } { address: \"tb1qca6k2ke5jdrwmdqcku4eex4k9hzzzhzshhsgpn\", derivationPath: \"84'/1'/0'/0/1\", publicKey: { \u2026}, index: 1 } { address: \"tb1q6e36gyc8vhv97k9m2uldndsl8xg80yd49mhqpx\", derivationPath: \"84'/1'/0'/0/2\", publicKey: { \u2026}, index: 2 } { address: \"tb1qvphc32p0qxl2fm89r04epmtxvdt7l7dl5a955c\", derivationPath: \"84'/1'/0'/0/3\", publicKey: { \u2026}, index: 3 } { address: \"tb1qxm90ahvjnut9d7mw8d0r22czldnu3kqyef55nn\", derivationPath: \"84'/1'/0'/0/4\", publicKey: { \u2026}, index: 4 } { address: \"tb1q8wjjk4gu3am2tjg833qulqt69ny8e24vt8ccj6\", derivationPath: \"84'/1'/0'/0/5\", publicKey: { \u2026}, index: 5 } { address: \"tb1q7jkkn80maps9z068u22jrpv65t9epjlrl4zpzj\", derivationPath: \"84'/1'/0'/0/6\", publicKey: { \u2026}, index: 6 } { address: \"tb1qrzpw5rrm9w8qf3v3y43av3npeqhgp9lng5xtyk\", derivationPath: \"84'/1'/0'/0/7\", publicKey: { \u2026}, index: 7 } { address: \"tb1q9vu3j2m6u48sv53g7e24lfx2c9mavv0ee6wr02\", derivationPath: \"84'/1'/0'/0/8\", publicKey: { \u2026}, index: 8 } { address: \"tb1q0m2f0vjc4njy5d0vzmlwre8jdtar9x9w7nz9jg\", derivationPath: \"84'/1'/0'/0/9\", publicKey: { \u2026}, index: 9 }] Notes Implemented for on-chain, might however not be supported by off-chain wallets","title":"getAddress"},{"location":"addresses/getAddress/#get-addresses-from-wallet","text":"The getAddresses method is called to obtain an onchain address from the wallet. NOTE: WebLN implementations might choose to implement this method when exposing access to the onchain wallet.","title":"Get addresses from wallet"},{"location":"addresses/getAddress/#syntax","text":"getAddresses(index?, num?, change?)","title":"Syntax"},{"location":"addresses/getAddress/#parameters","text":"index: Number (default 0) - Which index to start from Optional num: Number (default 1) - Number of addresses to retrieve Optional change: Boolean (default false) - true for change addresses, false for external Optional","title":"Parameters"},{"location":"addresses/getAddress/#returns","text":"AddressObjectArray - An array of bitcoin address objects Required address: String - Bitcoin address Required derivationPath: String - Derivation path of the address e.g. \"84'/1'/0'/0/0\" Optional publicKey: String(Hex) - The public key for the derivation path Optional index: Number - Index of the address Optional","title":"Returns"},{"location":"addresses/getAddress/#example","text":"await window.webbtc.getAddresses(0, 10, false) [{ address: \"tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2\", derivationPath: \"84'/1'/0'/0/0\", publicKey: { \u2026}, index: 0 } { address: \"tb1qca6k2ke5jdrwmdqcku4eex4k9hzzzhzshhsgpn\", derivationPath: \"84'/1'/0'/0/1\", publicKey: { \u2026}, index: 1 } { address: \"tb1q6e36gyc8vhv97k9m2uldndsl8xg80yd49mhqpx\", derivationPath: \"84'/1'/0'/0/2\", publicKey: { \u2026}, index: 2 } { address: \"tb1qvphc32p0qxl2fm89r04epmtxvdt7l7dl5a955c\", derivationPath: \"84'/1'/0'/0/3\", publicKey: { \u2026}, index: 3 } { address: \"tb1qxm90ahvjnut9d7mw8d0r22czldnu3kqyef55nn\", derivationPath: \"84'/1'/0'/0/4\", publicKey: { \u2026}, index: 4 } { address: \"tb1q8wjjk4gu3am2tjg833qulqt69ny8e24vt8ccj6\", derivationPath: \"84'/1'/0'/0/5\", publicKey: { \u2026}, index: 5 } { address: \"tb1q7jkkn80maps9z068u22jrpv65t9epjlrl4zpzj\", derivationPath: \"84'/1'/0'/0/6\", publicKey: { \u2026}, index: 6 } { address: \"tb1qrzpw5rrm9w8qf3v3y43av3npeqhgp9lng5xtyk\", derivationPath: \"84'/1'/0'/0/7\", publicKey: { \u2026}, index: 7 } { address: \"tb1q9vu3j2m6u48sv53g7e24lfx2c9mavv0ee6wr02\", derivationPath: \"84'/1'/0'/0/8\", publicKey: { \u2026}, index: 8 } { address: \"tb1q0m2f0vjc4njy5d0vzmlwre8jdtar9x9w7nz9jg\", derivationPath: \"84'/1'/0'/0/9\", publicKey: { \u2026}, index: 9 }]","title":"Example"},{"location":"addresses/getAddress/#notes","text":"Implemented for on-chain, might however not be supported by off-chain wallets","title":"Notes"},{"location":"extendability/extending/","text":"Extendability There is room for extending this API through a request method. This method might also be useful as a base from which all the other methods in the specification might have wrapper methods. Syntax window.webbtc.request(method, params) Parameters method: String Required params: Array Required Returns Promise | Object NOTE: This call might be asynchronous is would return a promise based on wether or not the payment has been broadcast Onchain and or processed successfully Example // Example of calling an existing method window.webbtc.request('getInfo',[]) { \"version\" : 1, \"supports\" : [ \"bip39\", \"bip32\" ], \"methods\": [ // schema for available methods \"enable\", \"getInfo\", \"getAddress\", \"signMessage\", \"verifyMessage\", \"makeInvoice\", \"sendPayment\" ] } // Example for calling an arbitrary message not covered in the specification // Custom method might be // hello(name) { // return \"Hello ${name}\" //} > await window.webbtc.request('hello',['Alice']) Hello Alice","title":"Extending"},{"location":"extendability/extending/#extendability","text":"There is room for extending this API through a request method. This method might also be useful as a base from which all the other methods in the specification might have wrapper methods.","title":"Extendability"},{"location":"extendability/extending/#syntax","text":"window.webbtc.request(method, params)","title":"Syntax"},{"location":"extendability/extending/#parameters","text":"method: String Required params: Array Required","title":"Parameters"},{"location":"extendability/extending/#returns","text":"Promise | Object NOTE: This call might be asynchronous is would return a promise based on wether or not the payment has been broadcast Onchain and or processed successfully","title":"Returns"},{"location":"extendability/extending/#example","text":"// Example of calling an existing method window.webbtc.request('getInfo',[]) { \"version\" : 1, \"supports\" : [ \"bip39\", \"bip32\" ], \"methods\": [ // schema for available methods \"enable\", \"getInfo\", \"getAddress\", \"signMessage\", \"verifyMessage\", \"makeInvoice\", \"sendPayment\" ] } // Example for calling an arbitrary message not covered in the specification // Custom method might be // hello(name) { // return \"Hello ${name}\" //} > await window.webbtc.request('hello',['Alice']) Hello Alice","title":"Example"},{"location":"invoices/makeInvoice/","text":"Create a new invoice The makeInvoice method is used to generate a new invoice. Syntax makeInvoice(Object) Parameters Object amount : string | number Optional defaultMemo : string Optional label : string Optional message : string Optional NOTE: Providing any of the above would result in a pre-populating a a prompt which requires the user to complete the rest of the information. e.g. Only providing the amount parameter might result in the following prompt. Returns Object paymentRequest: string; LN Invoice BIP21 address string; Onchain BIP 21 URI Example await window.webln.makeInvoice({}) { paymentRequest: 'lnbc10n1p3x9thxpp59xj4cmm26jnpnrfekgncyj42e9lxredz\u2026734s07kxt8hl2s6wuv20kh7kw7h5lurtmyscsrwgkgptn4z2j', rHash: '29a55c6f6ad4a6198d39b227824aaac97e61e5a2428db7dab7f8b097ae5d28ca' } window.bitcoin.makeInvoice({amount:1, label: 'Label', message: 'Message'}) bitcoin:address?amount=0&label=Label&message=Message Considerations These parameters might not be required in the spec as they are used by the website for convenience purposes in setting up the invoice dialog. defaultAmount?: string | number; minimumAmount?: string | number; maximumAmount?: string | number; Notes The amount parameter doesn't distinguish between bitcoin and satoshis Reference https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki bitcoinurn = \"bitcoin:\" bitcoinaddress [ \"?\" bitcoinparams ] bitcoinaddress = *base58 bitcoinparams = bitcoinparam [ \"&\" bitcoinparams ] bitcoinparam = [ amountparam / labelparam / messageparam / otherparam / reqparam ] amountparam = \"amount=\" *digit [ \".\" *digit ] labelparam = \"label=\" *qchar messageparam = \"message=\" *qchar otherparam = qchar *qchar [ \"=\" *qchar ] reqparam = \"req-\" qchar *qchar [ \"=\" *qchar ] Invoice address description Invoice Address Meno proposal Payment Requests Separate Meno into name and description Label = The who Message = The what","title":"makeInvoice"},{"location":"invoices/makeInvoice/#create-a-new-invoice","text":"The makeInvoice method is used to generate a new invoice.","title":"Create a new invoice"},{"location":"invoices/makeInvoice/#syntax","text":"makeInvoice(Object)","title":"Syntax"},{"location":"invoices/makeInvoice/#parameters","text":"Object amount : string | number Optional defaultMemo : string Optional label : string Optional message : string Optional NOTE: Providing any of the above would result in a pre-populating a a prompt which requires the user to complete the rest of the information. e.g. Only providing the amount parameter might result in the following prompt.","title":"Parameters"},{"location":"invoices/makeInvoice/#returns","text":"Object paymentRequest: string; LN Invoice BIP21 address string; Onchain BIP 21 URI","title":"Returns"},{"location":"invoices/makeInvoice/#example","text":"await window.webln.makeInvoice({}) { paymentRequest: 'lnbc10n1p3x9thxpp59xj4cmm26jnpnrfekgncyj42e9lxredz\u2026734s07kxt8hl2s6wuv20kh7kw7h5lurtmyscsrwgkgptn4z2j', rHash: '29a55c6f6ad4a6198d39b227824aaac97e61e5a2428db7dab7f8b097ae5d28ca' } window.bitcoin.makeInvoice({amount:1, label: 'Label', message: 'Message'}) bitcoin:address?amount=0&label=Label&message=Message","title":"Example"},{"location":"invoices/makeInvoice/#considerations","text":"These parameters might not be required in the spec as they are used by the website for convenience purposes in setting up the invoice dialog. defaultAmount?: string | number; minimumAmount?: string | number; maximumAmount?: string | number;","title":"Considerations"},{"location":"invoices/makeInvoice/#notes","text":"The amount parameter doesn't distinguish between bitcoin and satoshis","title":"Notes"},{"location":"invoices/makeInvoice/#reference","text":"https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki bitcoinurn = \"bitcoin:\" bitcoinaddress [ \"?\" bitcoinparams ] bitcoinaddress = *base58 bitcoinparams = bitcoinparam [ \"&\" bitcoinparams ] bitcoinparam = [ amountparam / labelparam / messageparam / otherparam / reqparam ] amountparam = \"amount=\" *digit [ \".\" *digit ] labelparam = \"label=\" *qchar messageparam = \"message=\" *qchar otherparam = qchar *qchar [ \"=\" *qchar ] reqparam = \"req-\" qchar *qchar [ \"=\" *qchar ]","title":"Reference"},{"location":"invoices/makeInvoice/#invoice-address-description","text":"Invoice Address Meno proposal Payment Requests Separate Meno into name and description Label = The who Message = The what","title":"Invoice address description"},{"location":"signatures/sign/","text":"Sign Message The signMessage method is used to sign arbitrary data and produce a signature which can be used to verify ownership of a key. Syntax signMessage(message, address?) Parameters Object message: String - The message to sign Required address: Object Option NOTE: The second parameter here is typically required for onchain wallets but can be omitted if the wallet contains internal support for automatic key selection. In the event of LND or C-Lightning, the wallet may use a root key whereas onchain wallets require to provide the address derived from the key required for signing the message. Returns Signature: String Required Example > await window.wallet.signMessage('Better with code than with words', 'tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2') \"2047ab7b010687146ef9d69648cbdc4610b7ebaf6f21d7255f2113fe87b24d4b4264eef980d21f29d3ba81b369e41bf532b1292021af16c6773187c34d090b7efb\" References WebLN examples https://api.lightning.community/#chainrpc-spendrequest BIPS https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki C-lightning https://lightning.readthedocs.io/lightning-signmessage.7.html","title":"Signing"},{"location":"signatures/sign/#sign-message","text":"The signMessage method is used to sign arbitrary data and produce a signature which can be used to verify ownership of a key.","title":"Sign Message"},{"location":"signatures/sign/#syntax","text":"signMessage(message, address?)","title":"Syntax"},{"location":"signatures/sign/#parameters","text":"Object message: String - The message to sign Required address: Object Option NOTE: The second parameter here is typically required for onchain wallets but can be omitted if the wallet contains internal support for automatic key selection. In the event of LND or C-Lightning, the wallet may use a root key whereas onchain wallets require to provide the address derived from the key required for signing the message.","title":"Parameters"},{"location":"signatures/sign/#returns","text":"Signature: String Required","title":"Returns"},{"location":"signatures/sign/#example","text":"> await window.wallet.signMessage('Better with code than with words', 'tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2') \"2047ab7b010687146ef9d69648cbdc4610b7ebaf6f21d7255f2113fe87b24d4b4264eef980d21f29d3ba81b369e41bf532b1292021af16c6773187c34d090b7efb\"","title":"Example"},{"location":"signatures/sign/#references","text":"","title":"References"},{"location":"signatures/sign/#webln-examples","text":"https://api.lightning.community/#chainrpc-spendrequest","title":"WebLN examples"},{"location":"signatures/sign/#bips","text":"https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki","title":"BIPS"},{"location":"signatures/sign/#c-lightning","text":"https://lightning.readthedocs.io/lightning-signmessage.7.html","title":"C-lightning"},{"location":"signatures/verify/","text":"Verify Message Signature The verifyMessage method is used to verify the signature of a arbitrary message. Syntax verifyMessage(signature, address?) Parameters Object signature: String (Hex) - The message to sign address: String - The used to sign the message NOTE: The second parameter here is typically required for onchain wallets but can be omitted if the wallet contains internal support for automatic key selection. In the event of LND or C-Lightning, the wallet may use a root key whereas onchain wallets require to provide the address derived from the key required for signing the message. Returns Boolean - Is valid signature Example > await window.webbtc.verifyMessage('2047ab7b010687146ef9d69648cbdc4610b7ebaf6f21d7255f2113fe87b24d4b4264eef980d21f29d3ba81b369e41bf532b1292021af16c6773187c34d090b7efb', 'tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2') true References VerifyMessage LND lightning-checkmessage C-lightning Bitcoin Core Signatures of Messages using Private Keys- BIP137 Generic Signed Message Format BIP322","title":"Verification"},{"location":"signatures/verify/#verify-message-signature","text":"The verifyMessage method is used to verify the signature of a arbitrary message.","title":"Verify Message Signature"},{"location":"signatures/verify/#syntax","text":"verifyMessage(signature, address?)","title":"Syntax"},{"location":"signatures/verify/#parameters","text":"Object signature: String (Hex) - The message to sign address: String - The used to sign the message NOTE: The second parameter here is typically required for onchain wallets but can be omitted if the wallet contains internal support for automatic key selection. In the event of LND or C-Lightning, the wallet may use a root key whereas onchain wallets require to provide the address derived from the key required for signing the message.","title":"Parameters"},{"location":"signatures/verify/#returns","text":"Boolean - Is valid signature","title":"Returns"},{"location":"signatures/verify/#example","text":"> await window.webbtc.verifyMessage('2047ab7b010687146ef9d69648cbdc4610b7ebaf6f21d7255f2113fe87b24d4b4264eef980d21f29d3ba81b369e41bf532b1292021af16c6773187c34d090b7efb', 'tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2') true","title":"Example"},{"location":"signatures/verify/#references","text":"VerifyMessage LND lightning-checkmessage C-lightning Bitcoin Core Signatures of Messages using Private Keys- BIP137 Generic Signed Message Format BIP322","title":"References"},{"location":"transactions/send/","text":"Send Payment The sendPayment method is called to pay an lightning invoice or BIP21 URI. Syntax sendPayment(String) Parameters bip21 url : string or paymentRequest: string Required Returns Promise NOTE: This call is asynchronous is would return a promise based on wether or not the payment has been broadcast Onchain and or processed successfully WebLN . Example // Example for processing a BIP21 URI Invoice > await window.webbtc.sendPayment('bitcoin:n1nk1j5DKmmWWuV2TvzhUb3AYBtnqAK1u1?amount=1') { \"txid\":\"ba8d75e01ab32932d9ac899418a6bec95f2869e1b1c161b871f661c5a8789a0e\" } // Example for processing a LN payment window.webbtc.sendPayment('lnbc10n1p3x9thxpp59xj4cmm26jnpnrfekgncyj42e9lxredz\u2026734s07kxt8hl2s6wuv20kh7kw7h5lurtmyscsrwgkgptn4z2j') { \"preimage\": \"6665333431626331363632653134386630643435626532626165383332323333\", \"paymentHash\": \"d221b791c7ef1996b25424ff7cfb4ddf8d4444076666ce6c4ba0f6a24d99117e\" } Notes The purpose of this method includes both signing as well as broadcasting the transaction. The implementation details of this could be done as separate concerns. There are more complex versions for onchain including PSBT, pay multiple addresses at the same time.","title":"sendPayment"},{"location":"transactions/send/#send-payment","text":"The sendPayment method is called to pay an lightning invoice or BIP21 URI.","title":"Send Payment"},{"location":"transactions/send/#syntax","text":"sendPayment(String)","title":"Syntax"},{"location":"transactions/send/#parameters","text":"bip21 url : string or paymentRequest: string Required","title":"Parameters"},{"location":"transactions/send/#returns","text":"Promise NOTE: This call is asynchronous is would return a promise based on wether or not the payment has been broadcast Onchain and or processed successfully WebLN .","title":"Returns"},{"location":"transactions/send/#example","text":"// Example for processing a BIP21 URI Invoice > await window.webbtc.sendPayment('bitcoin:n1nk1j5DKmmWWuV2TvzhUb3AYBtnqAK1u1?amount=1') { \"txid\":\"ba8d75e01ab32932d9ac899418a6bec95f2869e1b1c161b871f661c5a8789a0e\" } // Example for processing a LN payment window.webbtc.sendPayment('lnbc10n1p3x9thxpp59xj4cmm26jnpnrfekgncyj42e9lxredz\u2026734s07kxt8hl2s6wuv20kh7kw7h5lurtmyscsrwgkgptn4z2j') { \"preimage\": \"6665333431626331363632653134386630643435626532626165383332323333\", \"paymentHash\": \"d221b791c7ef1996b25424ff7cfb4ddf8d4444076666ce6c4ba0f6a24d99117e\" }","title":"Example"},{"location":"transactions/send/#notes","text":"The purpose of this method includes both signing as well as broadcasting the transaction. The implementation details of this could be done as separate concerns. There are more complex versions for onchain including PSBT, pay multiple addresses at the same time.","title":"Notes"},{"location":"transactions/sendTransaction/","text":"Send transaction The sendTransaction method is called to make an onchain payment. Syntax sendTransaction(String) Parameters address: String Required amount: String Required Returns txid: String Example window.bitcoin.sendTransaction('tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2', 10000) \"ba8d75e01ab32932d9ac899418a6bec95f2869e1b1c161b871f661c5a8789a0e\" } Notes The purpose of this method includes both signing as well as broadcasting the transaction. The implementation details of this could be done as separate concerns. There are more complex versions for onchain including PSBT, pay multiple addresses at the same time.","title":"sendTransaction"},{"location":"transactions/sendTransaction/#send-transaction","text":"The sendTransaction method is called to make an onchain payment.","title":"Send transaction"},{"location":"transactions/sendTransaction/#syntax","text":"sendTransaction(String)","title":"Syntax"},{"location":"transactions/sendTransaction/#parameters","text":"address: String Required amount: String Required","title":"Parameters"},{"location":"transactions/sendTransaction/#returns","text":"txid: String","title":"Returns"},{"location":"transactions/sendTransaction/#example","text":"window.bitcoin.sendTransaction('tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2', 10000) \"ba8d75e01ab32932d9ac899418a6bec95f2869e1b1c161b871f661c5a8789a0e\" }","title":"Example"},{"location":"transactions/sendTransaction/#notes","text":"The purpose of this method includes both signing as well as broadcasting the transaction. The implementation details of this could be done as separate concerns. There are more complex versions for onchain including PSBT, pay multiple addresses at the same time.","title":"Notes"}]} \ No newline at end of file diff --git a/favicon.ico b/favicon.ico index df36fcf..f24925d 100644 Binary files a/favicon.ico and b/favicon.ico differ diff --git a/index.html b/index.html index c314009..4c6fd47 100644 --- a/index.html +++ b/index.html @@ -1 +1,17 @@ -specwrapper
\ No newline at end of file + + + + Bitcoin And Lightning Layer Specifications + + + +

Bitcoin And Lightning Layer Specifications

+
+
WebBTC
+
+

A common convention in the Bitcoin web application ecosystem is for key management software (“wallets”) to expose their API via a JavaScript object in the web page. This object is called the common web wallet interface.

+

Read more

+
+
+ + diff --git a/js/app.20231a76.js b/js/app.20231a76.js deleted file mode 100644 index 3e7fcd4..0000000 --- a/js/app.20231a76.js +++ /dev/null @@ -1,2 +0,0 @@ -(function(e){function n(n){for(var t,o,i=n[0],c=n[1],d=n[2],p=0,u=[];p\n \n \n\n \n

\n Action\n

\n\n \n\n \n

\n Bitcoin\n

\n\n \n\n \n

\n WebLN\n

\n\n \n\n \n

\n Proposed\n

\n\n \n \n \n \n

{{item.name}}

\n

{{item.description}}

\n

Docs

\n \n\n \n

{{item.name}}

\n Request: {{item.bitcoin.signature}}\n
\n Response:\n 
{{item.bitcoin.response}}
\n
\n\n \n\n \n

{{item.name}}

\n\n
\n Request: {{item.webln.signature}}\n
\n Response:\n 
{{item.webln.response}}
\n
\n
\n \n\n \n

{{item.name}}

\n Request: {{item.wrapper.signature}}\n
\n 
{{item.wrapper.response}}
\n
\n \n \n \n\n\n\n","import mod from \"-!../../node_modules/cache-loader/dist/cjs.js??ref--13-0!../../node_modules/thread-loader/dist/cjs.js!../../node_modules/babel-loader/lib/index.js!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=script&lang=js&\"; export default mod; export * from \"-!../../node_modules/cache-loader/dist/cjs.js??ref--13-0!../../node_modules/thread-loader/dist/cjs.js!../../node_modules/babel-loader/lib/index.js!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=script&lang=js&\"","import { render, staticRenderFns } from \"./Index.vue?vue&type=template&id=79b867c0&scoped=true&\"\nimport script from \"./Index.vue?vue&type=script&lang=js&\"\nexport * from \"./Index.vue?vue&type=script&lang=js&\"\nimport style0 from \"./Index.vue?vue&type=style&index=0&id=79b867c0&scoped=true&lang=css&\"\n\n\n/* normalize component */\nimport normalizer from \"!../../node_modules/vue-loader/lib/runtime/componentNormalizer.js\"\nvar component = normalizer(\n script,\n render,\n staticRenderFns,\n false,\n null,\n \"79b867c0\",\n null\n \n)\n\nexport default component.exports\n\n/* vuetify-loader */\nimport installComponents from \"!../../node_modules/vuetify-loader/lib/runtime/installComponents.js\"\nimport { VBtn } from 'vuetify/lib/components/VBtn';\nimport { VCol } from 'vuetify/lib/components/VGrid';\nimport { VContainer } from 'vuetify/lib/components/VGrid';\nimport { VRow } from 'vuetify/lib/components/VGrid';\ninstallComponents(component, {VBtn,VCol,VContainer,VRow})\n","\n\n\n","import mod from \"-!../node_modules/cache-loader/dist/cjs.js??ref--13-0!../node_modules/thread-loader/dist/cjs.js!../node_modules/babel-loader/lib/index.js!../node_modules/cache-loader/dist/cjs.js??ref--1-0!../node_modules/vue-loader/lib/index.js??vue-loader-options!./App.vue?vue&type=script&lang=js&\"; export default mod; export * from \"-!../node_modules/cache-loader/dist/cjs.js??ref--13-0!../node_modules/thread-loader/dist/cjs.js!../node_modules/babel-loader/lib/index.js!../node_modules/cache-loader/dist/cjs.js??ref--1-0!../node_modules/vue-loader/lib/index.js??vue-loader-options!./App.vue?vue&type=script&lang=js&\"","import { render, staticRenderFns } from \"./App.vue?vue&type=template&id=4fa97e81&\"\nimport script from \"./App.vue?vue&type=script&lang=js&\"\nexport * from \"./App.vue?vue&type=script&lang=js&\"\n\n\n/* normalize component */\nimport normalizer from \"!../node_modules/vue-loader/lib/runtime/componentNormalizer.js\"\nvar component = normalizer(\n script,\n render,\n staticRenderFns,\n false,\n null,\n null,\n null\n \n)\n\nexport default component.exports\n\n/* vuetify-loader */\nimport installComponents from \"!../node_modules/vuetify-loader/lib/runtime/installComponents.js\"\nimport { VApp } from 'vuetify/lib/components/VApp';\nimport { VAppBar } from 'vuetify/lib/components/VAppBar';\nimport { VMain } from 'vuetify/lib/components/VMain';\nimport { VSpacer } from 'vuetify/lib/components/VGrid';\ninstallComponents(component, {VApp,VAppBar,VMain,VSpacer})\n","import Vue from 'vue';\nimport Vuetify from 'vuetify/lib/framework';\n\nVue.use(Vuetify);\n\nexport default new Vuetify({\n});\n","import Vue from 'vue'\nimport App from './App.vue'\nimport vuetify from './plugins/vuetify'\n\nVue.config.productionTip = false\n\nnew Vue({\n vuetify,\n render: h => h(App)\n}).$mount('#app')\n","export * from \"-!../../node_modules/mini-css-extract-plugin/dist/loader.js??ref--7-oneOf-1-0!../../node_modules/css-loader/dist/cjs.js??ref--7-oneOf-1-1!../../node_modules/vue-loader/lib/loaders/stylePostLoader.js!../../node_modules/postcss-loader/src/index.js??ref--7-oneOf-1-2!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=style&index=0&id=79b867c0&scoped=true&lang=css&\""],"sourceRoot":""} \ No newline at end of file diff --git a/docs/404.html b/webbtc/404.html similarity index 100% rename from docs/404.html rename to webbtc/404.html diff --git a/docs/addresses/getAddress/index.html b/webbtc/addresses/getAddress/index.html similarity index 100% rename from docs/addresses/getAddress/index.html rename to webbtc/addresses/getAddress/index.html diff --git a/docs/assets/enable.png b/webbtc/assets/enable.png similarity index 100% rename from docs/assets/enable.png rename to webbtc/assets/enable.png diff --git a/docs/assets/makeInvoice.png b/webbtc/assets/makeInvoice.png similarity index 100% rename from docs/assets/makeInvoice.png rename to webbtc/assets/makeInvoice.png diff --git a/docs/authentication/index.html b/webbtc/authentication/index.html similarity index 100% rename from docs/authentication/index.html rename to webbtc/authentication/index.html diff --git a/docs/css/custom.css b/webbtc/css/custom.css similarity index 100% rename from docs/css/custom.css rename to webbtc/css/custom.css diff --git a/docs/css/fonts/Roboto-Slab-Bold.woff b/webbtc/css/fonts/Roboto-Slab-Bold.woff similarity index 100% rename from docs/css/fonts/Roboto-Slab-Bold.woff rename to webbtc/css/fonts/Roboto-Slab-Bold.woff diff --git a/docs/css/fonts/Roboto-Slab-Bold.woff2 b/webbtc/css/fonts/Roboto-Slab-Bold.woff2 similarity index 100% rename from docs/css/fonts/Roboto-Slab-Bold.woff2 rename to webbtc/css/fonts/Roboto-Slab-Bold.woff2 diff --git a/docs/css/fonts/Roboto-Slab-Regular.woff b/webbtc/css/fonts/Roboto-Slab-Regular.woff similarity index 100% rename from docs/css/fonts/Roboto-Slab-Regular.woff rename to webbtc/css/fonts/Roboto-Slab-Regular.woff diff --git a/docs/css/fonts/Roboto-Slab-Regular.woff2 b/webbtc/css/fonts/Roboto-Slab-Regular.woff2 similarity index 100% rename from docs/css/fonts/Roboto-Slab-Regular.woff2 rename to webbtc/css/fonts/Roboto-Slab-Regular.woff2 diff --git a/docs/css/fonts/fontawesome-webfont.eot b/webbtc/css/fonts/fontawesome-webfont.eot similarity index 100% rename from docs/css/fonts/fontawesome-webfont.eot rename to webbtc/css/fonts/fontawesome-webfont.eot diff --git a/docs/css/fonts/fontawesome-webfont.svg b/webbtc/css/fonts/fontawesome-webfont.svg similarity index 100% rename from docs/css/fonts/fontawesome-webfont.svg rename to webbtc/css/fonts/fontawesome-webfont.svg diff --git a/docs/css/fonts/fontawesome-webfont.ttf b/webbtc/css/fonts/fontawesome-webfont.ttf similarity index 100% rename from docs/css/fonts/fontawesome-webfont.ttf rename to webbtc/css/fonts/fontawesome-webfont.ttf diff --git a/docs/css/fonts/fontawesome-webfont.woff b/webbtc/css/fonts/fontawesome-webfont.woff similarity index 100% rename from docs/css/fonts/fontawesome-webfont.woff rename to webbtc/css/fonts/fontawesome-webfont.woff diff --git a/docs/css/fonts/fontawesome-webfont.woff2 b/webbtc/css/fonts/fontawesome-webfont.woff2 similarity index 100% rename from docs/css/fonts/fontawesome-webfont.woff2 rename to webbtc/css/fonts/fontawesome-webfont.woff2 diff --git a/docs/css/fonts/lato-bold-italic.woff b/webbtc/css/fonts/lato-bold-italic.woff similarity index 100% rename from docs/css/fonts/lato-bold-italic.woff rename to webbtc/css/fonts/lato-bold-italic.woff diff --git a/docs/css/fonts/lato-bold-italic.woff2 b/webbtc/css/fonts/lato-bold-italic.woff2 similarity index 100% rename from docs/css/fonts/lato-bold-italic.woff2 rename to webbtc/css/fonts/lato-bold-italic.woff2 diff --git a/docs/css/fonts/lato-bold.woff b/webbtc/css/fonts/lato-bold.woff similarity index 100% rename from docs/css/fonts/lato-bold.woff rename to webbtc/css/fonts/lato-bold.woff diff --git a/docs/css/fonts/lato-bold.woff2 b/webbtc/css/fonts/lato-bold.woff2 similarity index 100% rename from docs/css/fonts/lato-bold.woff2 rename to webbtc/css/fonts/lato-bold.woff2 diff --git a/docs/css/fonts/lato-normal-italic.woff b/webbtc/css/fonts/lato-normal-italic.woff similarity index 100% rename from docs/css/fonts/lato-normal-italic.woff rename to webbtc/css/fonts/lato-normal-italic.woff diff --git a/docs/css/fonts/lato-normal-italic.woff2 b/webbtc/css/fonts/lato-normal-italic.woff2 similarity index 100% rename from docs/css/fonts/lato-normal-italic.woff2 rename to webbtc/css/fonts/lato-normal-italic.woff2 diff --git a/docs/css/fonts/lato-normal.woff b/webbtc/css/fonts/lato-normal.woff similarity index 100% rename from docs/css/fonts/lato-normal.woff rename to webbtc/css/fonts/lato-normal.woff diff --git a/docs/css/fonts/lato-normal.woff2 b/webbtc/css/fonts/lato-normal.woff2 similarity index 100% rename from docs/css/fonts/lato-normal.woff2 rename to webbtc/css/fonts/lato-normal.woff2 diff --git a/docs/css/theme.css b/webbtc/css/theme.css similarity index 100% rename from docs/css/theme.css rename to webbtc/css/theme.css diff --git a/docs/css/theme_extra.css b/webbtc/css/theme_extra.css similarity index 100% rename from docs/css/theme_extra.css rename to webbtc/css/theme_extra.css diff --git a/css/app.33e3e4f6.css b/webbtc/demo/css/app.33e3e4f6.css similarity index 100% rename from css/app.33e3e4f6.css rename to webbtc/demo/css/app.33e3e4f6.css diff --git a/css/app.4d16f0ed.css b/webbtc/demo/css/app.dec9e1f5.css similarity index 77% rename from css/app.4d16f0ed.css rename to webbtc/demo/css/app.dec9e1f5.css index 8e313ba..ca151ec 100644 --- a/css/app.4d16f0ed.css +++ b/webbtc/demo/css/app.dec9e1f5.css @@ -1 +1 @@ -pre[data-v-79b867c0]{background:#f4f4f4;border:1px solid #ddd;border-left:3px solid #f36d33;color:#666;page-break-inside:avoid;font-family:monospace;font-size:15px;line-height:1.6;margin-bottom:1.6em;max-width:100%;overflow:auto;padding:1em 1.5em;display:block;word-wrap:break-word} \ No newline at end of file +pre[data-v-8d2c3d76]{background:#f4f4f4;border:1px solid #ddd;border-left:3px solid #f36d33;color:#666;page-break-inside:avoid;font-family:monospace;font-size:15px;line-height:1.6;margin-bottom:1.6em;max-width:100%;overflow:auto;padding:1em 1.5em;display:block;word-wrap:break-word} \ No newline at end of file diff --git a/webbtc/demo/css/app.ece63869.css b/webbtc/demo/css/app.ece63869.css new file mode 100644 index 0000000..7059575 --- /dev/null +++ b/webbtc/demo/css/app.ece63869.css @@ -0,0 +1 @@ +pre[data-v-d84043f6]{background:#f4f4f4;border:1px solid #ddd;border-left:3px solid #f36d33;color:#666;page-break-inside:avoid;font-family:monospace;font-size:15px;line-height:1.6;margin-bottom:1.6em;max-width:100%;overflow:auto;padding:1em 1.5em;display:block;word-wrap:break-word} \ No newline at end of file diff --git a/css/chunk-vendors.d4e3e587.css b/webbtc/demo/css/chunk-vendors.d4e3e587.css similarity index 100% rename from css/chunk-vendors.d4e3e587.css rename to webbtc/demo/css/chunk-vendors.d4e3e587.css diff --git a/webbtc/demo/favicon.ico b/webbtc/demo/favicon.ico new file mode 100644 index 0000000..df36fcf Binary files /dev/null and b/webbtc/demo/favicon.ico differ diff --git a/webbtc/demo/index.html b/webbtc/demo/index.html new file mode 100644 index 0000000..39c15a4 --- /dev/null +++ b/webbtc/demo/index.html @@ -0,0 +1 @@ +specwrapper
\ No newline at end of file diff --git a/webbtc/demo/js/app.03034cc8.js b/webbtc/demo/js/app.03034cc8.js new file mode 100644 index 0000000..38c9045 --- /dev/null +++ b/webbtc/demo/js/app.03034cc8.js @@ -0,0 +1,2 @@ +(function(e){function n(n){for(var t,i,o=n[0],c=n[1],l=n[2],p=0,u=[];p\n \n \n\n \n

\n Action\n

\n\n \n\n \n

\n Bitcoin\n

\n\n \n\n \n

\n WebLN\n

\n\n \n\n \n

\n Proposed\n

\n\n \n \n \n \n

{{item.name}}

\n

{{item.description}}

\n

Docs

\n \n\n \n

{{item.name}}

\n Request: {{item.bitcoin.signature}}\n
\n Response:\n 
{{item.bitcoin.response}}
\n
\n\n \n\n \n

{{item.name}}

\n\n
\n Request: {{item.webln.signature}}\n
\n Response:\n 
{{item.webln.response}}
\n
\n
\n \n\n \n

{{item.name}}

\n Request: {{item.wrapper.signature}}\n
\n 
{{item.wrapper.response}}
\n
\n \n \n \n\n\n\n","import mod from \"-!../../node_modules/cache-loader/dist/cjs.js??ref--13-0!../../node_modules/thread-loader/dist/cjs.js!../../node_modules/babel-loader/lib/index.js!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=script&lang=js&\"; export default mod; export * from \"-!../../node_modules/cache-loader/dist/cjs.js??ref--13-0!../../node_modules/thread-loader/dist/cjs.js!../../node_modules/babel-loader/lib/index.js!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=script&lang=js&\"","import { render, staticRenderFns } from \"./Index.vue?vue&type=template&id=8d2c3d76&scoped=true&\"\nimport script from \"./Index.vue?vue&type=script&lang=js&\"\nexport * from \"./Index.vue?vue&type=script&lang=js&\"\nimport style0 from \"./Index.vue?vue&type=style&index=0&id=8d2c3d76&scoped=true&lang=css&\"\n\n\n/* normalize component */\nimport normalizer from \"!../../node_modules/vue-loader/lib/runtime/componentNormalizer.js\"\nvar component = normalizer(\n script,\n render,\n staticRenderFns,\n false,\n null,\n \"8d2c3d76\",\n null\n \n)\n\nexport default component.exports\n\n/* vuetify-loader */\nimport installComponents from \"!../../node_modules/vuetify-loader/lib/runtime/installComponents.js\"\nimport { VBtn } from 'vuetify/lib/components/VBtn';\nimport { VCol } from 'vuetify/lib/components/VGrid';\nimport { VContainer } from 'vuetify/lib/components/VGrid';\nimport { VRow } from 'vuetify/lib/components/VGrid';\ninstallComponents(component, {VBtn,VCol,VContainer,VRow})\n","\n\n\n","import mod from \"-!../node_modules/cache-loader/dist/cjs.js??ref--13-0!../node_modules/thread-loader/dist/cjs.js!../node_modules/babel-loader/lib/index.js!../node_modules/cache-loader/dist/cjs.js??ref--1-0!../node_modules/vue-loader/lib/index.js??vue-loader-options!./App.vue?vue&type=script&lang=js&\"; export default mod; export * from \"-!../node_modules/cache-loader/dist/cjs.js??ref--13-0!../node_modules/thread-loader/dist/cjs.js!../node_modules/babel-loader/lib/index.js!../node_modules/cache-loader/dist/cjs.js??ref--1-0!../node_modules/vue-loader/lib/index.js??vue-loader-options!./App.vue?vue&type=script&lang=js&\"","import { render, staticRenderFns } from \"./App.vue?vue&type=template&id=4fa97e81&\"\nimport script from \"./App.vue?vue&type=script&lang=js&\"\nexport * from \"./App.vue?vue&type=script&lang=js&\"\n\n\n/* normalize component */\nimport normalizer from \"!../node_modules/vue-loader/lib/runtime/componentNormalizer.js\"\nvar component = normalizer(\n script,\n render,\n staticRenderFns,\n false,\n null,\n null,\n null\n \n)\n\nexport default component.exports\n\n/* vuetify-loader */\nimport installComponents from \"!../node_modules/vuetify-loader/lib/runtime/installComponents.js\"\nimport { VApp } from 'vuetify/lib/components/VApp';\nimport { VAppBar } from 'vuetify/lib/components/VAppBar';\nimport { VMain } from 'vuetify/lib/components/VMain';\nimport { VSpacer } from 'vuetify/lib/components/VGrid';\ninstallComponents(component, {VApp,VAppBar,VMain,VSpacer})\n","import Vue from 'vue';\nimport Vuetify from 'vuetify/lib/framework';\n\nVue.use(Vuetify);\n\nexport default new Vuetify({\n});\n","import Vue from 'vue'\nimport App from './App.vue'\nimport vuetify from './plugins/vuetify'\n\nVue.config.productionTip = false\n\nnew Vue({\n vuetify,\n render: h => h(App)\n}).$mount('#app')\n"],"sourceRoot":""} \ No newline at end of file diff --git a/webbtc/demo/js/app.27405eeb.js b/webbtc/demo/js/app.27405eeb.js new file mode 100644 index 0000000..64e1c4a --- /dev/null +++ b/webbtc/demo/js/app.27405eeb.js @@ -0,0 +1,2 @@ +(function(e){function n(n){for(var s,i,o=n[0],c=n[1],l=n[2],p=0,u=[];p\n \n \n\n \n

\n Action\n

\n\n \n\n \n

\n Bitcoin\n

\n\n \n\n \n

\n WebLN\n

\n\n \n\n \n

\n Proposed\n

\n\n \n \n \n \n

{{item.name}}

\n

{{item.description}}

\n

Docs

\n \n\n \n

{{item.name}}

\n Request: {{item.bitcoin.signature}}\n
\n Response:\n 
{{item.bitcoin.response}}
\n
\n\n \n\n \n

{{item.name}}

\n\n
\n Request: {{item.webln.signature}}\n
\n Response:\n 
{{item.webln.response}}
\n
\n
\n \n\n \n

{{item.name}}

\n Request: {{item.wrapper.signature}}\n
\n 
{{item.wrapper.response}}
\n
\n \n \n \n\n\n\n","import mod from \"-!../../node_modules/cache-loader/dist/cjs.js??ref--13-0!../../node_modules/thread-loader/dist/cjs.js!../../node_modules/babel-loader/lib/index.js!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=script&lang=js&\"; export default mod; export * from \"-!../../node_modules/cache-loader/dist/cjs.js??ref--13-0!../../node_modules/thread-loader/dist/cjs.js!../../node_modules/babel-loader/lib/index.js!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=script&lang=js&\"","import { render, staticRenderFns } from \"./Index.vue?vue&type=template&id=d84043f6&scoped=true&\"\nimport script from \"./Index.vue?vue&type=script&lang=js&\"\nexport * from \"./Index.vue?vue&type=script&lang=js&\"\nimport style0 from \"./Index.vue?vue&type=style&index=0&id=d84043f6&scoped=true&lang=css&\"\n\n\n/* normalize component */\nimport normalizer from \"!../../node_modules/vue-loader/lib/runtime/componentNormalizer.js\"\nvar component = normalizer(\n script,\n render,\n staticRenderFns,\n false,\n null,\n \"d84043f6\",\n null\n \n)\n\nexport default component.exports\n\n/* vuetify-loader */\nimport installComponents from \"!../../node_modules/vuetify-loader/lib/runtime/installComponents.js\"\nimport { VBtn } from 'vuetify/lib/components/VBtn';\nimport { VCol } from 'vuetify/lib/components/VGrid';\nimport { VContainer } from 'vuetify/lib/components/VGrid';\nimport { VRow } from 'vuetify/lib/components/VGrid';\ninstallComponents(component, {VBtn,VCol,VContainer,VRow})\n","\n\n\n","import mod from \"-!../node_modules/cache-loader/dist/cjs.js??ref--13-0!../node_modules/thread-loader/dist/cjs.js!../node_modules/babel-loader/lib/index.js!../node_modules/cache-loader/dist/cjs.js??ref--1-0!../node_modules/vue-loader/lib/index.js??vue-loader-options!./App.vue?vue&type=script&lang=js&\"; export default mod; export * from \"-!../node_modules/cache-loader/dist/cjs.js??ref--13-0!../node_modules/thread-loader/dist/cjs.js!../node_modules/babel-loader/lib/index.js!../node_modules/cache-loader/dist/cjs.js??ref--1-0!../node_modules/vue-loader/lib/index.js??vue-loader-options!./App.vue?vue&type=script&lang=js&\"","import { render, staticRenderFns } from \"./App.vue?vue&type=template&id=4fa97e81&\"\nimport script from \"./App.vue?vue&type=script&lang=js&\"\nexport * from \"./App.vue?vue&type=script&lang=js&\"\n\n\n/* normalize component */\nimport normalizer from \"!../node_modules/vue-loader/lib/runtime/componentNormalizer.js\"\nvar component = normalizer(\n script,\n render,\n staticRenderFns,\n false,\n null,\n null,\n null\n \n)\n\nexport default component.exports\n\n/* vuetify-loader */\nimport installComponents from \"!../node_modules/vuetify-loader/lib/runtime/installComponents.js\"\nimport { VApp } from 'vuetify/lib/components/VApp';\nimport { VAppBar } from 'vuetify/lib/components/VAppBar';\nimport { VMain } from 'vuetify/lib/components/VMain';\nimport { VSpacer } from 'vuetify/lib/components/VGrid';\ninstallComponents(component, {VApp,VAppBar,VMain,VSpacer})\n","import Vue from 'vue';\nimport Vuetify from 'vuetify/lib/framework';\n\nVue.use(Vuetify);\n\nexport default new Vuetify({\n});\n","import Vue from 'vue'\nimport App from './App.vue'\nimport vuetify from './plugins/vuetify'\n\nVue.config.productionTip = false\n\nnew Vue({\n vuetify,\n render: h => h(App)\n}).$mount('#app')\n","export * from \"-!../../node_modules/mini-css-extract-plugin/dist/loader.js??ref--7-oneOf-1-0!../../node_modules/css-loader/dist/cjs.js??ref--7-oneOf-1-1!../../node_modules/vue-loader/lib/loaders/stylePostLoader.js!../../node_modules/postcss-loader/src/index.js??ref--7-oneOf-1-2!../../node_modules/cache-loader/dist/cjs.js??ref--1-0!../../node_modules/vue-loader/lib/index.js??vue-loader-options!./Index.vue?vue&type=style&index=0&id=d84043f6&scoped=true&lang=css&\""],"sourceRoot":""} \ No newline at end of file diff --git a/js/app.3a0da46d.js b/webbtc/demo/js/app.3a0da46d.js similarity index 100% rename from js/app.3a0da46d.js rename to webbtc/demo/js/app.3a0da46d.js diff --git a/js/app.3a0da46d.js.map b/webbtc/demo/js/app.3a0da46d.js.map similarity index 100% rename from js/app.3a0da46d.js.map rename to webbtc/demo/js/app.3a0da46d.js.map diff --git a/js/chunk-vendors.73627de4.js b/webbtc/demo/js/chunk-vendors.73627de4.js similarity index 100% rename from js/chunk-vendors.73627de4.js rename to webbtc/demo/js/chunk-vendors.73627de4.js diff --git a/js/chunk-vendors.73627de4.js.map b/webbtc/demo/js/chunk-vendors.73627de4.js.map similarity index 100% rename from js/chunk-vendors.73627de4.js.map rename to webbtc/demo/js/chunk-vendors.73627de4.js.map diff --git a/docs/enable/index.html b/webbtc/enable/index.html similarity index 100% rename from docs/enable/index.html rename to webbtc/enable/index.html diff --git a/docs/extendability/extending/index.html b/webbtc/extendability/extending/index.html similarity index 100% rename from docs/extendability/extending/index.html rename to webbtc/extendability/extending/index.html diff --git a/docs/getting_started/index.html b/webbtc/getting_started/index.html similarity index 100% rename from docs/getting_started/index.html rename to webbtc/getting_started/index.html diff --git a/docs/img/favicon.ico b/webbtc/img/favicon.ico similarity index 100% rename from docs/img/favicon.ico rename to webbtc/img/favicon.ico diff --git a/docs/index.html b/webbtc/index.html similarity index 96% rename from docs/index.html rename to webbtc/index.html index fec844e..3e43317 100644 --- a/docs/index.html +++ b/webbtc/index.html @@ -124,7 +124,7 @@

A common convention in the Bitcoin web application ecosystem is for key management software (“wallets”) to expose their API via a JavaScript object in the web page. This object is called the common web wallet interface.

Historically, Provider implementations have exhibited conflicting interfaces and behaviors between wallets. This working group formalizes an Bitcoin extension API to promote wallet interoperability. The API is designed to be minimal, event-driven, and agnostic of transport and RPC protocols. Its functionality is easily extended by defining new RPC methods and message event types.

Historically, providers have been made available as window.bitcoin or window.webln in web browsers, but this convention is not part of the specification.

-

A list of current work in progress can be tracked from the issues tab in the playground repository, which includes a functional spec demonstration. A hosted instance of the demo can be found here together with the accompanying specification documentation.

+

A list of current work in progress can be tracked from the issues tab in the playground repository, which includes a functional spec demonstration. A hosted instance of the demo can be found here together with the accompanying specification documentation.