mirror of
https://github.com/aljazceru/BitcoinAndLightningLayerSpecs.github.io.git
synced 2025-12-17 05:54:22 +01:00
Initial github pages site
This commit is contained in:
gr0kchain
1
css/app.4d16f0ed.css
Normal file
1
css/app.4d16f0ed.css
Normal file
@@ -0,0 +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}
|
||||
5
css/chunk-vendors.d4e3e587.css
Normal file
5
css/chunk-vendors.d4e3e587.css
Normal file
File diff suppressed because one or more lines are too long
157
docs/404.html
Normal file
157
docs/404.html
Normal file
@@ -0,0 +1,157 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" />
|
||||
<title>WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="/css/theme.css" />
|
||||
<link rel="stylesheet" href="/css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="/css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script src="/js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="/." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/.">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="/.">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="/." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
|
||||
<h1 id="404-page-not-found">404</h1>
|
||||
|
||||
<p><strong>Page not found</strong></p>
|
||||
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '/';</script>
|
||||
<script src="/js/theme_extra.js" defer></script>
|
||||
<script src="/js/theme.js" defer></script>
|
||||
<script src="/search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
272
docs/addresses/getAddress/index.html
Normal file
272
docs/addresses/getAddress/index.html
Normal file
@@ -0,0 +1,272 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>getAddress - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "getAddress";
|
||||
var mkdocs_page_input_path = "addresses/getAddress.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Addresses</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">getAddress</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Addresses »</li><li>getAddress</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="get-addresses-from-wallet">Get addresses from wallet</h1>
|
||||
<p>The <code>getAddresses</code> method is called to obtain an onchain address from the wallet. </p>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
WebLN implementations might choose to implement this method when exposing access to the onchain wallet. </p>
|
||||
</blockquote>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>getAddresses(index?, num?, change?)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>index: Number (default 0) - Which index to start from <span class="badge">Optional</span></li>
|
||||
<li>num: Number (default 1) - Number of addresses to retrieve <span class="badge">Optional</span></li>
|
||||
<li>change: Boolean (default false) - true for change addresses, false for external <span class="badge">Optional</span></li>
|
||||
</ul>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>AddressObjectArray - An array of bitcoin address objects <span class="badge">Required</span><ul>
|
||||
<li>address: String - Bitcoin address <span class="badge">Required</span></li>
|
||||
<li>derivationPath: String - Derivation path of the address e.g. "84'/1'/0'/0/0" <span class="badge">Optional</span></li>
|
||||
<li>publicKey: String(Hex) - The public key for the derivation path <span class="badge">Optional</span></li>
|
||||
<li>index: Number - Index of the address <span class="badge">Optional</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>await window.webbtc.getAddresses(0, 10, false)
|
||||
[{
|
||||
address: "tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2",
|
||||
derivationPath: "84'/1'/0'/0/0",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 0
|
||||
} {
|
||||
address: "tb1qca6k2ke5jdrwmdqcku4eex4k9hzzzhzshhsgpn",
|
||||
derivationPath: "84'/1'/0'/0/1",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 1
|
||||
} {
|
||||
address: "tb1q6e36gyc8vhv97k9m2uldndsl8xg80yd49mhqpx",
|
||||
derivationPath: "84'/1'/0'/0/2",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 2
|
||||
} {
|
||||
address: "tb1qvphc32p0qxl2fm89r04epmtxvdt7l7dl5a955c",
|
||||
derivationPath: "84'/1'/0'/0/3",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 3
|
||||
} {
|
||||
address: "tb1qxm90ahvjnut9d7mw8d0r22czldnu3kqyef55nn",
|
||||
derivationPath: "84'/1'/0'/0/4",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 4
|
||||
} {
|
||||
address: "tb1q8wjjk4gu3am2tjg833qulqt69ny8e24vt8ccj6",
|
||||
derivationPath: "84'/1'/0'/0/5",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 5
|
||||
} {
|
||||
address: "tb1q7jkkn80maps9z068u22jrpv65t9epjlrl4zpzj",
|
||||
derivationPath: "84'/1'/0'/0/6",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 6
|
||||
} {
|
||||
address: "tb1qrzpw5rrm9w8qf3v3y43av3npeqhgp9lng5xtyk",
|
||||
derivationPath: "84'/1'/0'/0/7",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 7
|
||||
} {
|
||||
address: "tb1q9vu3j2m6u48sv53g7e24lfx2c9mavv0ee6wr02",
|
||||
derivationPath: "84'/1'/0'/0/8",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 8
|
||||
} {
|
||||
address: "tb1q0m2f0vjc4njy5d0vzmlwre8jdtar9x9w7nz9jg",
|
||||
derivationPath: "84'/1'/0'/0/9",
|
||||
publicKey: {
|
||||
…},
|
||||
index: 9
|
||||
}]
|
||||
</code></pre>
|
||||
<h2 id="notes">Notes</h2>
|
||||
<p>Implemented for on-chain, might however not be supported by off-chain wallets</p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../../transactions/sendTransaction/" class="btn btn-neutral float-left" title="sendTransaction"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../../extendability/extending/" class="btn btn-neutral float-right" title="Extending">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../../transactions/sendTransaction/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../../extendability/extending/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
BIN
docs/assets/enable.png
Normal file
BIN
docs/assets/enable.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.7 KiB |
BIN
docs/assets/makeInvoice.png
Normal file
BIN
docs/assets/makeInvoice.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
160
docs/authentication/index.html
Normal file
160
docs/authentication/index.html
Normal file
@@ -0,0 +1,160 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Authentication - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Authentication";
|
||||
var mkdocs_page_input_path = "authentication.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>Authentication</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
7
docs/css/custom.css
Normal file
7
docs/css/custom.css
Normal file
@@ -0,0 +1,7 @@
|
||||
.badge {
|
||||
border: 1px solid #000;
|
||||
border-radius: 4rem;
|
||||
font-size: 0.6em;
|
||||
padding: 0.125rem 0.375rem;
|
||||
white-space: nowrap;
|
||||
}
|
||||
BIN
docs/css/fonts/Roboto-Slab-Bold.woff
Normal file
BIN
docs/css/fonts/Roboto-Slab-Bold.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/Roboto-Slab-Bold.woff2
Normal file
BIN
docs/css/fonts/Roboto-Slab-Bold.woff2
Normal file
Binary file not shown.
BIN
docs/css/fonts/Roboto-Slab-Regular.woff
Normal file
BIN
docs/css/fonts/Roboto-Slab-Regular.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/Roboto-Slab-Regular.woff2
Normal file
BIN
docs/css/fonts/Roboto-Slab-Regular.woff2
Normal file
Binary file not shown.
BIN
docs/css/fonts/fontawesome-webfont.eot
Normal file
BIN
docs/css/fonts/fontawesome-webfont.eot
Normal file
Binary file not shown.
2671
docs/css/fonts/fontawesome-webfont.svg
Normal file
2671
docs/css/fonts/fontawesome-webfont.svg
Normal file
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 434 KiB |
BIN
docs/css/fonts/fontawesome-webfont.ttf
Normal file
BIN
docs/css/fonts/fontawesome-webfont.ttf
Normal file
Binary file not shown.
BIN
docs/css/fonts/fontawesome-webfont.woff
Normal file
BIN
docs/css/fonts/fontawesome-webfont.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/fontawesome-webfont.woff2
Normal file
BIN
docs/css/fonts/fontawesome-webfont.woff2
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-bold-italic.woff
Normal file
BIN
docs/css/fonts/lato-bold-italic.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-bold-italic.woff2
Normal file
BIN
docs/css/fonts/lato-bold-italic.woff2
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-bold.woff
Normal file
BIN
docs/css/fonts/lato-bold.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-bold.woff2
Normal file
BIN
docs/css/fonts/lato-bold.woff2
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-normal-italic.woff
Normal file
BIN
docs/css/fonts/lato-normal-italic.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-normal-italic.woff2
Normal file
BIN
docs/css/fonts/lato-normal-italic.woff2
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-normal.woff
Normal file
BIN
docs/css/fonts/lato-normal.woff
Normal file
Binary file not shown.
BIN
docs/css/fonts/lato-normal.woff2
Normal file
BIN
docs/css/fonts/lato-normal.woff2
Normal file
Binary file not shown.
13
docs/css/theme.css
Normal file
13
docs/css/theme.css
Normal file
File diff suppressed because one or more lines are too long
191
docs/css/theme_extra.css
Normal file
191
docs/css/theme_extra.css
Normal file
@@ -0,0 +1,191 @@
|
||||
/*
|
||||
* Wrap inline code samples otherwise they shoot of the side and
|
||||
* can't be read at all.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/313
|
||||
* https://github.com/mkdocs/mkdocs/issues/233
|
||||
* https://github.com/mkdocs/mkdocs/issues/834
|
||||
*/
|
||||
.rst-content code {
|
||||
white-space: pre-wrap;
|
||||
word-wrap: break-word;
|
||||
padding: 2px 5px;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make code blocks display as blocks and give them the appropriate
|
||||
* font size and padding.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/855
|
||||
* https://github.com/mkdocs/mkdocs/issues/834
|
||||
* https://github.com/mkdocs/mkdocs/issues/233
|
||||
*/
|
||||
.rst-content pre code {
|
||||
white-space: pre;
|
||||
word-wrap: normal;
|
||||
display: block;
|
||||
padding: 12px;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fix code colors
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/2027
|
||||
*/
|
||||
.rst-content code {
|
||||
color: #E74C3C;
|
||||
}
|
||||
|
||||
.rst-content pre code {
|
||||
color: #000;
|
||||
background: #f8f8f8;
|
||||
}
|
||||
|
||||
/*
|
||||
* Fix link colors when the link text is inline code.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/718
|
||||
*/
|
||||
a code {
|
||||
color: #2980B9;
|
||||
}
|
||||
a:hover code {
|
||||
color: #3091d1;
|
||||
}
|
||||
a:visited code {
|
||||
color: #9B59B6;
|
||||
}
|
||||
|
||||
/*
|
||||
* The CSS classes from highlight.js seem to clash with the
|
||||
* ReadTheDocs theme causing some code to be incorrectly made
|
||||
* bold and italic.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/411
|
||||
*/
|
||||
pre .cs, pre .c {
|
||||
font-weight: inherit;
|
||||
font-style: inherit;
|
||||
}
|
||||
|
||||
/*
|
||||
* Fix some issues with the theme and non-highlighted code
|
||||
* samples. Without and highlighting styles attached the
|
||||
* formatting is broken.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/319
|
||||
*/
|
||||
.rst-content .no-highlight {
|
||||
display: block;
|
||||
padding: 0.5em;
|
||||
color: #333;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Additions specific to the search functionality provided by MkDocs
|
||||
*/
|
||||
|
||||
.search-results {
|
||||
margin-top: 23px;
|
||||
}
|
||||
|
||||
.search-results article {
|
||||
border-top: 1px solid #E1E4E5;
|
||||
padding-top: 24px;
|
||||
}
|
||||
|
||||
.search-results article:first-child {
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
form .search-query {
|
||||
width: 100%;
|
||||
border-radius: 50px;
|
||||
padding: 6px 12px; /* csslint allow: box-model */
|
||||
border-color: #D1D4D5;
|
||||
}
|
||||
|
||||
/*
|
||||
* Improve inline code blocks within admonitions.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/656
|
||||
*/
|
||||
.rst-content .admonition code {
|
||||
color: #404040;
|
||||
border: 1px solid #c7c9cb;
|
||||
border: 1px solid rgba(0, 0, 0, 0.2);
|
||||
background: #f8fbfd;
|
||||
background: rgba(255, 255, 255, 0.7);
|
||||
}
|
||||
|
||||
/*
|
||||
* Account for wide tables which go off the side.
|
||||
* Override borders to avoid weirdness on narrow tables.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/834
|
||||
* https://github.com/mkdocs/mkdocs/pull/1034
|
||||
*/
|
||||
.rst-content .section .docutils {
|
||||
width: 100%;
|
||||
overflow: auto;
|
||||
display: block;
|
||||
border: none;
|
||||
}
|
||||
|
||||
td, th {
|
||||
border: 1px solid #e1e4e5 !important; /* csslint allow: important */
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/*
|
||||
* Without the following amendments, the navigation in the theme will be
|
||||
* slightly cut off. This is due to the fact that the .wy-nav-side has a
|
||||
* padding-bottom of 2em, which must not necessarily align with the font-size of
|
||||
* 90 % on the .rst-current-version container, combined with the padding of 12px
|
||||
* above and below. These amendments fix this in two steps: First, make sure the
|
||||
* .rst-current-version container has a fixed height of 40px, achieved using
|
||||
* line-height, and then applying a padding-bottom of 40px to this container. In
|
||||
* a second step, the items within that container are re-aligned using flexbox.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/2012
|
||||
*/
|
||||
.wy-nav-side {
|
||||
padding-bottom: 40px;
|
||||
}
|
||||
|
||||
/*
|
||||
* The second step of above amendment: Here we make sure the items are aligned
|
||||
* correctly within the .rst-current-version container. Using flexbox, we
|
||||
* achieve it in such a way that it will look like the following:
|
||||
*
|
||||
* [No repo_name]
|
||||
* Next >> // On the first page
|
||||
* << Previous Next >> // On all subsequent pages
|
||||
*
|
||||
* [With repo_name]
|
||||
* <repo_name> Next >> // On the first page
|
||||
* <repo_name> << Previous Next >> // On all subsequent pages
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/2012
|
||||
*/
|
||||
.rst-versions .rst-current-version {
|
||||
padding: 0 12px;
|
||||
display: flex;
|
||||
font-size: initial;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
line-height: 40px;
|
||||
}
|
||||
|
||||
/*
|
||||
* Please note that this amendment also involves removing certain inline-styles
|
||||
* from the file ./mkdocs/themes/readthedocs/versions.html.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/2012
|
||||
*/
|
||||
.rst-current-version span {
|
||||
flex: 1;
|
||||
text-align: center;
|
||||
}
|
||||
229
docs/enable/index.html
Normal file
229
docs/enable/index.html
Normal file
@@ -0,0 +1,229 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Enabling - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Enabling";
|
||||
var mkdocs_page_input_path = "enable.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Enable</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">Enabling</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Enable »</li><li>Enabling</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="enable-wallet">Enable Wallet</h1>
|
||||
<p>The <code>enable</code> method is called to allow access to further API methods from the wallet.</p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>enable()
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<p>None</p>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Object<ul>
|
||||
<li>enabled : Boolean <span class="badge">Required</span></li>
|
||||
<li>addresses : AddressObjArray <span class="badge">Optional</span><ul>
|
||||
<li>address: String</li>
|
||||
<li>derivationPath: String</li>
|
||||
<li>publicKey: String</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
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. </p>
|
||||
</blockquote>
|
||||
<p><img alt="ENABLED ON WEBSITE" src="/assets/enable.png" /></p>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>// Enable wallet
|
||||
window.webbtc.enable()
|
||||
|
||||
{
|
||||
address: {
|
||||
address: "bc1q9zw3q496dcx2qu5pvhvg0zwfsxgj79nhh5rqct"
|
||||
derivationPath: "84'/0'/0'/0/0"
|
||||
publicKey: "031ecb71f390fcffc8727bedc5fb563e7bf90cd9725b1519e1ef74a16ca7a30fe3"
|
||||
},
|
||||
success: true
|
||||
}
|
||||
</code></pre>
|
||||
<pre><code>// Check if the wallet is enabled
|
||||
window.webbtc.enabled
|
||||
|
||||
true
|
||||
</code></pre>
|
||||
<pre><code>// Check if wallet is enabled, invoke enable when false
|
||||
if (!window.webbtc.enabled) window.webbtc.enable()
|
||||
</code></pre>
|
||||
<h2 id="notes">Notes</h2>
|
||||
<p>Application specific on wether or not to trust once or always. On invoking the <code>enable</code> call the application developer provides an interface which may or may not prompt the user to accept the request.</p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href=".." class="btn btn-neutral float-left" title="Overview"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../info/" class="btn btn-neutral float-right" title="info">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href=".." style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../info/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
227
docs/extendability/extending/index.html
Normal file
227
docs/extendability/extending/index.html
Normal file
@@ -0,0 +1,227 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>Extending - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Extending";
|
||||
var mkdocs_page_input_path = "extendability/extending.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Extending</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li><li>Extending</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="extendability">Extendability</h1>
|
||||
<p>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. </p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>window.webbtc.request(method, params)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>method: String <span class="badge">Required</span></li>
|
||||
<li>params: Array <span class="badge">Required</span></li>
|
||||
</ul>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Promise | Object</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
This call might be asynchronous is would return a promise based on wether or not the payment has been broadcast <span class="badge">Onchain</span> and or processed successfully </p>
|
||||
</blockquote>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>// 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"
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<pre><code>// 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
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../../addresses/getAddress/" class="btn btn-neutral float-left" title="getAddress"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../../squatting/" class="btn btn-neutral float-right" title="Namespace Squatting">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../../addresses/getAddress/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../../squatting/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
160
docs/getting_started/index.html
Normal file
160
docs/getting_started/index.html
Normal file
@@ -0,0 +1,160 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Getting Started - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Getting Started";
|
||||
var mkdocs_page_input_path = "getting_started.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>Getting Started</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="getting-started">Getting Started</h1>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
BIN
docs/img/favicon.ico
Normal file
BIN
docs/img/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
176
docs/index.html
Normal file
176
docs/index.html
Normal file
@@ -0,0 +1,176 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="None" />
|
||||
<link rel="shortcut icon" href="img/favicon.ico" />
|
||||
<title>WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="css/theme.css" />
|
||||
<link rel="stylesheet" href="css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Overview";
|
||||
var mkdocs_page_input_path = "index.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href=".">Overview</a>
|
||||
<ul class="current">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href=".">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="." class="icon icon-home" alt="Docs"></a> »</li><li>Overview</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="webbtc">WebBTC</h1>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<p>Historically, providers have been made available as <code>window.bitcoin</code> or <code>window.webln</code> in web browsers, but this convention is not part of the specification.</p>
|
||||
<p>A list of current work in progress can be tracked from the <a href="https://github.com/BitcoinAndLightningLayerSpecs/WebBTC/issues">issues</a> tab in the <a href="https://github.com/BitcoinAndLightningLayerSpecs/WebBTC/issues">playground repository</a>, which includes a functional spec demonstration. A hosted instance of the demo can be found <a href="https://specdemo.synonym.to/">here</a> together with the accompanying <a href="https://specdemo.synonym.to/docs">specification documentation</a>.</p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="enable/" class="btn btn-neutral float-right" title="Enabling">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
<span><a href="enable/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '.';</script>
|
||||
<script src="js/theme_extra.js" defer></script>
|
||||
<script src="js/theme.js" defer></script>
|
||||
<script src="search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
<!--
|
||||
MkDocs version : 1.3.0
|
||||
Build Date UTC : 2022-06-17 09:27:11.990079+00:00
|
||||
-->
|
||||
232
docs/info/index.html
Normal file
232
docs/info/index.html
Normal file
@@ -0,0 +1,232 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>info - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "info";
|
||||
var mkdocs_page_input_path = "info.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Information</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">info</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#additional-notes">Additional notes</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#concerns-and-security-observations">Concerns and security observations</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Information »</li><li>info</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="get-wallet-information">Get wallet information</h1>
|
||||
<p>The <code>getInfo</code> method is called to obtain supported features and capabilities of the wallet. </p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>getInfo()
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<p>None</p>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Object<ul>
|
||||
<li>version : Number | String <span class="badge">Required</span></li>
|
||||
<li>methods : Array <span class="badge">Optional</span></li>
|
||||
<li>supports : Array <span class="badge">Optional</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>window.webbtc.getInfo()
|
||||
|
||||
{
|
||||
"version" : 1,
|
||||
"supports" : [
|
||||
"bip39",
|
||||
"bip32"
|
||||
],
|
||||
"methods": [ // schema for available methods
|
||||
"enable",
|
||||
"getInfo",
|
||||
"getAddress",
|
||||
"signMessage",
|
||||
"verifyMessage",
|
||||
"makeInvoice",
|
||||
"sendPayment"
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="additional-notes">Additional notes</h2>
|
||||
<p>The above method might be extended to include helper methods which include. </p>
|
||||
<ul>
|
||||
<li><code>window.webbtc.getMethods()</code></li>
|
||||
<li><code>window.webbtc.getVersion()</code></li>
|
||||
<li><code>window.webbtc.getServices()</code></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong>
|
||||
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. </p>
|
||||
</blockquote>
|
||||
<h2 id="concerns-and-security-observations">Concerns and security observations</h2>
|
||||
<p>Possible finger printing of users if this method is accessible without enabling it first.</p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../enable/" class="btn btn-neutral float-left" title="Enabling"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../signatures/sign/" class="btn btn-neutral float-right" title="Signing">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../enable/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../signatures/sign/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
252
docs/invoices/makeInvoice/index.html
Normal file
252
docs/invoices/makeInvoice/index.html
Normal file
@@ -0,0 +1,252 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>makeInvoice - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "makeInvoice";
|
||||
var mkdocs_page_input_path = "invoices/makeInvoice.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Invoices</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">makeInvoice</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#considerations">Considerations</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#reference">Reference</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#invoice-address-description">Invoice address description</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Invoices »</li><li>makeInvoice</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="create-a-new-invoice">Create a new invoice</h1>
|
||||
<p>The <code>makeInvoice</code> method is used to generate a new invoice.</p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>makeInvoice(Object)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>Object<ul>
|
||||
<li>amount : string | number <span class="badge">Optional</span></li>
|
||||
<li>defaultMemo : string <span class="badge">Optional</span></li>
|
||||
<li>label : string <span class="badge">Optional</span></li>
|
||||
<li>message : string <span class="badge">Optional</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
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.</p>
|
||||
</blockquote>
|
||||
<p><img src="/assets/makeinvoice.png" style="width:200px;"/></p>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Object<ul>
|
||||
<li>paymentRequest: string; <span class="badge">LN Invoice</span></li>
|
||||
<li>BIP21 address string; <span class="badge">Onchain BIP 21 URI</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>await window.webln.makeInvoice({})
|
||||
{
|
||||
paymentRequest: 'lnbc10n1p3x9thxpp59xj4cmm26jnpnrfekgncyj42e9lxredz…734s07kxt8hl2s6wuv20kh7kw7h5lurtmyscsrwgkgptn4z2j', rHash: '29a55c6f6ad4a6198d39b227824aaac97e61e5a2428db7dab7f8b097ae5d28ca'
|
||||
}
|
||||
</code></pre>
|
||||
<pre><code>window.bitcoin.makeInvoice({amount:1, label: 'Label', message: 'Message'})
|
||||
|
||||
bitcoin:address?amount=0&label=Label&message=Message
|
||||
</code></pre>
|
||||
<h2 id="considerations">Considerations</h2>
|
||||
<p>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.</p>
|
||||
<p>defaultAmount?: string | number;
|
||||
minimumAmount?: string | number;
|
||||
maximumAmount?: string | number;</p>
|
||||
<h2 id="notes">Notes</h2>
|
||||
<p>The amount parameter doesn't distinguish between bitcoin and satoshis</p>
|
||||
<h2 id="reference">Reference</h2>
|
||||
<p>https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki</p>
|
||||
<pre><code>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 ]
|
||||
</code></pre>
|
||||
<h2 id="invoice-address-description">Invoice address description</h2>
|
||||
<p><a href="https://en.bitcoin.it/wiki/Invoice_address">Invoice Address</a>
|
||||
<a href="https://github.com/lightning/blips/pull/11/files?short_path=1efcc79#diff-1efcc7957e02dad2d5a9deea7032635c9f19100d5a7ee08be166cb1dc9b4d690">Meno proposal</a>
|
||||
<a href="https://doc.clickup.com/18307877/d/h/hept5-1721/f06e5c5e4eba551/hept5-421">Payment Requests</a></p>
|
||||
<p>Separate Meno into name and description</p>
|
||||
<p>Label = The who
|
||||
Message = The what</p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../../signatures/verify/" class="btn btn-neutral float-left" title="Verification"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../../transactions/send/" class="btn btn-neutral float-right" title="sendPayment">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../../signatures/verify/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../../transactions/send/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
4
docs/js/html5shiv.min.js
vendored
Normal file
4
docs/js/html5shiv.min.js
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
||||
2
docs/js/jquery-3.6.0.min.js
vendored
Normal file
2
docs/js/jquery-3.6.0.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
2
docs/js/theme.js
Normal file
2
docs/js/theme.js
Normal file
File diff suppressed because one or more lines are too long
8
docs/js/theme_extra.js
Normal file
8
docs/js/theme_extra.js
Normal file
@@ -0,0 +1,8 @@
|
||||
/*
|
||||
* Assign 'docutils' class to tables so styling and
|
||||
* JavaScript behavior is applied.
|
||||
*
|
||||
* https://github.com/mkdocs/mkdocs/issues/2028
|
||||
*/
|
||||
|
||||
$('div.rst-content table').addClass('docutils');
|
||||
160
docs/permissions/index.html
Normal file
160
docs/permissions/index.html
Normal file
@@ -0,0 +1,160 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Permissions - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Permissions";
|
||||
var mkdocs_page_input_path = "permissions.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>Permissions</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
174
docs/references/index.html
Normal file
174
docs/references/index.html
Normal file
@@ -0,0 +1,174 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Resources - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Resources";
|
||||
var mkdocs_page_input_path = "references.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Resources</a>
|
||||
<ul class="current">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>Resources</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="references">References</h1>
|
||||
<ul>
|
||||
<li><a href="https://specdemo.synonym.to">Spec Demo</a></li>
|
||||
<li><a href="https://wallet.synonym.to">Onchain Wallet Documentation</a></li>
|
||||
<li><a href="https://webln.twentyuno.net/">A WebLN playground</a></li>
|
||||
<li><a href="https://webln.dev/">WebLN Documentation</a></li>
|
||||
<li><a href="https://www.webln.guide/introduction/welcome">WebLN Guide</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../squatting/" class="btn btn-neutral float-left" title="Namespace Squatting"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../squatting/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
164
docs/search.html
Normal file
164
docs/search.html
Normal file
@@ -0,0 +1,164 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="./img/favicon.ico" />
|
||||
<title>WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="./css/theme.css" />
|
||||
<link rel="stylesheet" href="./css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="./css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script src="./js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="./js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="./." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="./.">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="./addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="./extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="./squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="./references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="./.">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="./." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
|
||||
<h1 id="search">Search Results</h1>
|
||||
|
||||
<form id="content_search" action="search.html">
|
||||
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
|
||||
<input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off" autofocus title="Type search term here">
|
||||
</form>
|
||||
|
||||
<div id="mkdocs-search-results" class="search-results" data-no-results-text="No results found">
|
||||
Searching...
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '.';</script>
|
||||
<script src="./js/theme_extra.js" defer></script>
|
||||
<script src="./js/theme.js" defer></script>
|
||||
<script src="./search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
3475
docs/search/lunr.js
Normal file
3475
docs/search/lunr.js
Normal file
File diff suppressed because it is too large
Load Diff
109
docs/search/main.js
Normal file
109
docs/search/main.js
Normal file
@@ -0,0 +1,109 @@
|
||||
function getSearchTermFromLocation() {
|
||||
var sPageURL = window.location.search.substring(1);
|
||||
var sURLVariables = sPageURL.split('&');
|
||||
for (var i = 0; i < sURLVariables.length; i++) {
|
||||
var sParameterName = sURLVariables[i].split('=');
|
||||
if (sParameterName[0] == 'q') {
|
||||
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function joinUrl (base, path) {
|
||||
if (path.substring(0, 1) === "/") {
|
||||
// path starts with `/`. Thus it is absolute.
|
||||
return path;
|
||||
}
|
||||
if (base.substring(base.length-1) === "/") {
|
||||
// base ends with `/`
|
||||
return base + path;
|
||||
}
|
||||
return base + "/" + path;
|
||||
}
|
||||
|
||||
function escapeHtml (value) {
|
||||
return value.replace(/&/g, '&')
|
||||
.replace(/"/g, '"')
|
||||
.replace(/</g, '<')
|
||||
.replace(/>/g, '>');
|
||||
}
|
||||
|
||||
function formatResult (location, title, summary) {
|
||||
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
|
||||
}
|
||||
|
||||
function displayResults (results) {
|
||||
var search_results = document.getElementById("mkdocs-search-results");
|
||||
while (search_results.firstChild) {
|
||||
search_results.removeChild(search_results.firstChild);
|
||||
}
|
||||
if (results.length > 0){
|
||||
for (var i=0; i < results.length; i++){
|
||||
var result = results[i];
|
||||
var html = formatResult(result.location, result.title, result.summary);
|
||||
search_results.insertAdjacentHTML('beforeend', html);
|
||||
}
|
||||
} else {
|
||||
var noResultsText = search_results.getAttribute('data-no-results-text');
|
||||
if (!noResultsText) {
|
||||
noResultsText = "No results found";
|
||||
}
|
||||
search_results.insertAdjacentHTML('beforeend', '<p>' + noResultsText + '</p>');
|
||||
}
|
||||
}
|
||||
|
||||
function doSearch () {
|
||||
var query = document.getElementById('mkdocs-search-query').value;
|
||||
if (query.length > min_search_length) {
|
||||
if (!window.Worker) {
|
||||
displayResults(search(query));
|
||||
} else {
|
||||
searchWorker.postMessage({query: query});
|
||||
}
|
||||
} else {
|
||||
// Clear results for short queries
|
||||
displayResults([]);
|
||||
}
|
||||
}
|
||||
|
||||
function initSearch () {
|
||||
var search_input = document.getElementById('mkdocs-search-query');
|
||||
if (search_input) {
|
||||
search_input.addEventListener("keyup", doSearch);
|
||||
}
|
||||
var term = getSearchTermFromLocation();
|
||||
if (term) {
|
||||
search_input.value = term;
|
||||
doSearch();
|
||||
}
|
||||
}
|
||||
|
||||
function onWorkerMessage (e) {
|
||||
if (e.data.allowSearch) {
|
||||
initSearch();
|
||||
} else if (e.data.results) {
|
||||
var results = e.data.results;
|
||||
displayResults(results);
|
||||
} else if (e.data.config) {
|
||||
min_search_length = e.data.config.min_search_length-1;
|
||||
}
|
||||
}
|
||||
|
||||
if (!window.Worker) {
|
||||
console.log('Web Worker API not supported');
|
||||
// load index in main thread
|
||||
$.getScript(joinUrl(base_url, "search/worker.js")).done(function () {
|
||||
console.log('Loaded worker');
|
||||
init();
|
||||
window.postMessage = function (msg) {
|
||||
onWorkerMessage({data: msg});
|
||||
};
|
||||
}).fail(function (jqxhr, settings, exception) {
|
||||
console.error('Could not load worker.js');
|
||||
});
|
||||
} else {
|
||||
// Wrap search in a web worker
|
||||
var searchWorker = new Worker(joinUrl(base_url, "search/worker.js"));
|
||||
searchWorker.postMessage({init: true});
|
||||
searchWorker.onmessage = onWorkerMessage;
|
||||
}
|
||||
1
docs/search/search_index.json
Normal file
1
docs/search/search_index.json
Normal file
File diff suppressed because one or more lines are too long
133
docs/search/worker.js
Normal file
133
docs/search/worker.js
Normal file
@@ -0,0 +1,133 @@
|
||||
var base_path = 'function' === typeof importScripts ? '.' : '/search/';
|
||||
var allowSearch = false;
|
||||
var index;
|
||||
var documents = {};
|
||||
var lang = ['en'];
|
||||
var data;
|
||||
|
||||
function getScript(script, callback) {
|
||||
console.log('Loading script: ' + script);
|
||||
$.getScript(base_path + script).done(function () {
|
||||
callback();
|
||||
}).fail(function (jqxhr, settings, exception) {
|
||||
console.log('Error: ' + exception);
|
||||
});
|
||||
}
|
||||
|
||||
function getScriptsInOrder(scripts, callback) {
|
||||
if (scripts.length === 0) {
|
||||
callback();
|
||||
return;
|
||||
}
|
||||
getScript(scripts[0], function() {
|
||||
getScriptsInOrder(scripts.slice(1), callback);
|
||||
});
|
||||
}
|
||||
|
||||
function loadScripts(urls, callback) {
|
||||
if( 'function' === typeof importScripts ) {
|
||||
importScripts.apply(null, urls);
|
||||
callback();
|
||||
} else {
|
||||
getScriptsInOrder(urls, callback);
|
||||
}
|
||||
}
|
||||
|
||||
function onJSONLoaded () {
|
||||
data = JSON.parse(this.responseText);
|
||||
var scriptsToLoad = ['lunr.js'];
|
||||
if (data.config && data.config.lang && data.config.lang.length) {
|
||||
lang = data.config.lang;
|
||||
}
|
||||
if (lang.length > 1 || lang[0] !== "en") {
|
||||
scriptsToLoad.push('lunr.stemmer.support.js');
|
||||
if (lang.length > 1) {
|
||||
scriptsToLoad.push('lunr.multi.js');
|
||||
}
|
||||
if (lang.includes("ja") || lang.includes("jp")) {
|
||||
scriptsToLoad.push('tinyseg.js');
|
||||
}
|
||||
for (var i=0; i < lang.length; i++) {
|
||||
if (lang[i] != 'en') {
|
||||
scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
|
||||
}
|
||||
}
|
||||
}
|
||||
loadScripts(scriptsToLoad, onScriptsLoaded);
|
||||
}
|
||||
|
||||
function onScriptsLoaded () {
|
||||
console.log('All search scripts loaded, building Lunr index...');
|
||||
if (data.config && data.config.separator && data.config.separator.length) {
|
||||
lunr.tokenizer.separator = new RegExp(data.config.separator);
|
||||
}
|
||||
|
||||
if (data.index) {
|
||||
index = lunr.Index.load(data.index);
|
||||
data.docs.forEach(function (doc) {
|
||||
documents[doc.location] = doc;
|
||||
});
|
||||
console.log('Lunr pre-built index loaded, search ready');
|
||||
} else {
|
||||
index = lunr(function () {
|
||||
if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) {
|
||||
this.use(lunr[lang[0]]);
|
||||
} else if (lang.length > 1) {
|
||||
this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
|
||||
}
|
||||
this.field('title');
|
||||
this.field('text');
|
||||
this.ref('location');
|
||||
|
||||
for (var i=0; i < data.docs.length; i++) {
|
||||
var doc = data.docs[i];
|
||||
this.add(doc);
|
||||
documents[doc.location] = doc;
|
||||
}
|
||||
});
|
||||
console.log('Lunr index built, search ready');
|
||||
}
|
||||
allowSearch = true;
|
||||
postMessage({config: data.config});
|
||||
postMessage({allowSearch: allowSearch});
|
||||
}
|
||||
|
||||
function init () {
|
||||
var oReq = new XMLHttpRequest();
|
||||
oReq.addEventListener("load", onJSONLoaded);
|
||||
var index_path = base_path + '/search_index.json';
|
||||
if( 'function' === typeof importScripts ){
|
||||
index_path = 'search_index.json';
|
||||
}
|
||||
oReq.open("GET", index_path);
|
||||
oReq.send();
|
||||
}
|
||||
|
||||
function search (query) {
|
||||
if (!allowSearch) {
|
||||
console.error('Assets for search still loading');
|
||||
return;
|
||||
}
|
||||
|
||||
var resultDocuments = [];
|
||||
var results = index.search(query);
|
||||
for (var i=0; i < results.length; i++){
|
||||
var result = results[i];
|
||||
doc = documents[result.ref];
|
||||
doc.summary = doc.text.substring(0, 200);
|
||||
resultDocuments.push(doc);
|
||||
}
|
||||
return resultDocuments;
|
||||
}
|
||||
|
||||
if( 'function' === typeof importScripts ) {
|
||||
onmessage = function (e) {
|
||||
if (e.data.init) {
|
||||
init();
|
||||
} else if (e.data.query) {
|
||||
postMessage({ results: search(e.data.query) });
|
||||
} else {
|
||||
console.error("Worker - Unrecognized message: " + e);
|
||||
}
|
||||
};
|
||||
}
|
||||
160
docs/services/index.html
Normal file
160
docs/services/index.html
Normal file
@@ -0,0 +1,160 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Services - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Services";
|
||||
var mkdocs_page_input_path = "services.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>Services</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="services">Services</h1>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
223
docs/signatures/sign/index.html
Normal file
223
docs/signatures/sign/index.html
Normal file
@@ -0,0 +1,223 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>Signing - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Signing";
|
||||
var mkdocs_page_input_path = "signatures/sign.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Signatures</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">Signing</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#references">References</a>
|
||||
<ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#webln-examples">WebLN examples</a>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#bips">BIPS</a>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#c-lightning">C-lightning</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Signatures »</li><li>Signing</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="sign-message">Sign Message</h1>
|
||||
<p>The <code>signMessage</code> method is used to sign arbitrary data and produce a signature which can be used to verify ownership of a key.</p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>signMessage(message, address?)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>Object<ul>
|
||||
<li>message: String - The message to sign <span class="badge">Required</span></li>
|
||||
<li>address: Object <span class="badge">Option</span></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
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.</p>
|
||||
</blockquote>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Signature: String <span class="badge">Required</span></li>
|
||||
</ul>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>> await window.wallet.signMessage('Better with code than with words', 'tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2')
|
||||
|
||||
"2047ab7b010687146ef9d69648cbdc4610b7ebaf6f21d7255f2113fe87b24d4b4264eef980d21f29d3ba81b369e41bf532b1292021af16c6773187c34d090b7efb"
|
||||
</code></pre>
|
||||
<h2 id="references">References</h2>
|
||||
<h3 id="webln-examples">WebLN examples</h3>
|
||||
<p><a href="https://api.lightning.community/#chainrpc-spendrequest">https://api.lightning.community/#chainrpc-spendrequest</a></p>
|
||||
<h3 id="bips">BIPS</h3>
|
||||
<p><a href="https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki">https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki</a>
|
||||
<a href="https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki">https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki</a></p>
|
||||
<h3 id="c-lightning">C-lightning</h3>
|
||||
<p><a href="https://lightning.readthedocs.io/lightning-signmessage.7.html">https://lightning.readthedocs.io/lightning-signmessage.7.html</a></p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../../info/" class="btn btn-neutral float-left" title="info"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../verify/" class="btn btn-neutral float-right" title="Verification">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../../info/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../verify/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
215
docs/signatures/verify/index.html
Normal file
215
docs/signatures/verify/index.html
Normal file
@@ -0,0 +1,215 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>Verification - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Verification";
|
||||
var mkdocs_page_input_path = "signatures/verify.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Signatures</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">Verification</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#references">References</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Signatures »</li><li>Verification</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="verify-message-signature">Verify Message Signature</h1>
|
||||
<p>The <code>verifyMessage</code> method is used to verify the signature of a arbitrary message.</p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>verifyMessage(signature, address?)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>Object<ul>
|
||||
<li>signature: String (Hex) - The message to sign</li>
|
||||
<li>address: String - The used to sign the message</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
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.</p>
|
||||
</blockquote>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Boolean - Is valid signature</li>
|
||||
</ul>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>> await window.webbtc.verifyMessage('2047ab7b010687146ef9d69648cbdc4610b7ebaf6f21d7255f2113fe87b24d4b4264eef980d21f29d3ba81b369e41bf532b1292021af16c6773187c34d090b7efb', 'tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2')
|
||||
|
||||
true
|
||||
</code></pre>
|
||||
<h2 id="references">References</h2>
|
||||
<p><a href="https://api.lightning.community/#verifymessage">VerifyMessage LND</a></p>
|
||||
<p><a href="https://lightning.readthedocs.io/lightning-checkmessage.7.html">lightning-checkmessage C-lightning</a></p>
|
||||
<p>Bitcoin Core</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/bitcoin/bips/blob/master/bip-0137.mediawiki">Signatures of Messages using Private Keys- BIP137</a></li>
|
||||
<li><a href="https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki">Generic Signed Message Format BIP322</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../sign/" class="btn btn-neutral float-left" title="Signing"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../../invoices/makeInvoice/" class="btn btn-neutral float-right" title="makeInvoice">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../sign/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../../invoices/makeInvoice/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
83
docs/sitemap.xml
Normal file
83
docs/sitemap.xml
Normal file
@@ -0,0 +1,83 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2022-06-17</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
</urlset>
|
||||
BIN
docs/sitemap.xml.gz
Normal file
BIN
docs/sitemap.xml.gz
Normal file
Binary file not shown.
171
docs/squatting/index.html
Normal file
171
docs/squatting/index.html
Normal file
@@ -0,0 +1,171 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../img/favicon.ico" />
|
||||
<title>Namespace Squatting - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../css/theme.css" />
|
||||
<link rel="stylesheet" href="../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "Namespace Squatting";
|
||||
var mkdocs_page_input_path = "squatting.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href=".." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Invoices</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../transactions/sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="./">Namespace Squatting</a>
|
||||
<ul class="current">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li><li>Namespace Squatting</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="extension-namespace-squatting">Extension namespace squatting</h1>
|
||||
<p>Historically, providers have been made available as <code>window.bitcoin</code> or <code>window.webln</code> in web browsers, but this convention is not part of the specification. </p>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../extendability/extending/" class="btn btn-neutral float-left" title="Extending"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../references/" class="btn btn-neutral float-right" title="Resources">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../extendability/extending/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../references/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '..';</script>
|
||||
<script src="../js/theme_extra.js" defer></script>
|
||||
<script src="../js/theme.js" defer></script>
|
||||
<script src="../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
218
docs/transactions/send/index.html
Normal file
218
docs/transactions/send/index.html
Normal file
@@ -0,0 +1,218 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>sendPayment - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "sendPayment";
|
||||
var mkdocs_page_input_path = "transactions/send.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Invoices</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">sendPayment</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../sendTransaction/">sendTransaction</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Invoices »</li><li>sendPayment</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="send-payment">Send Payment</h1>
|
||||
<p>The <code>sendPayment</code> method is called to pay an lightning invoice or BIP21 URI.</p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>sendPayment(String)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>bip21 url : string or paymentRequest: string <span class="badge">Required</span></li>
|
||||
</ul>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>Promise</li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<p><strong><em>NOTE:</em></strong><br />
|
||||
This call is asynchronous is would return a promise based on wether or not the payment has been broadcast <span class="badge">Onchain</span> and or processed successfully <span class="badge">WebLN</span>.</p>
|
||||
</blockquote>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>// Example for processing a BIP21 URI Invoice
|
||||
> await window.webbtc.sendPayment('bitcoin:n1nk1j5DKmmWWuV2TvzhUb3AYBtnqAK1u1?amount=1')
|
||||
{
|
||||
"txid":"ba8d75e01ab32932d9ac899418a6bec95f2869e1b1c161b871f661c5a8789a0e"
|
||||
}
|
||||
</code></pre>
|
||||
<pre><code>// Example for processing a LN payment
|
||||
window.webbtc.sendPayment('lnbc10n1p3x9thxpp59xj4cmm26jnpnrfekgncyj42e9lxredz…734s07kxt8hl2s6wuv20kh7kw7h5lurtmyscsrwgkgptn4z2j')
|
||||
|
||||
{
|
||||
"preimage": "6665333431626331363632653134386630643435626532626165383332323333",
|
||||
"paymentHash": "d221b791c7ef1996b25424ff7cfb4ddf8d4444076666ce6c4ba0f6a24d99117e"
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="notes">Notes</h2>
|
||||
<ul>
|
||||
<li>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. </li>
|
||||
<li>There are more complex versions for onchain including PSBT, pay multiple addresses at the same time.</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../../invoices/makeInvoice/" class="btn btn-neutral float-left" title="makeInvoice"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../sendTransaction/" class="btn btn-neutral float-right" title="sendTransaction">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../../invoices/makeInvoice/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../sendTransaction/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
206
docs/transactions/sendTransaction/index.html
Normal file
206
docs/transactions/sendTransaction/index.html
Normal file
@@ -0,0 +1,206 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<link rel="shortcut icon" href="../../img/favicon.ico" />
|
||||
<title>sendTransaction - WebBTC Specification</title>
|
||||
<link rel="stylesheet" href="../../css/theme.css" />
|
||||
<link rel="stylesheet" href="../../css/theme_extra.css" />
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
||||
<link href="../../css/custom.css" rel="stylesheet" />
|
||||
|
||||
<script>
|
||||
// Current page data
|
||||
var mkdocs_page_name = "sendTransaction";
|
||||
var mkdocs_page_input_path = "transactions/sendTransaction.md";
|
||||
var mkdocs_page_url = null;
|
||||
</script>
|
||||
|
||||
<script src="../../js/jquery-3.6.0.min.js" defer></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/languages/javascript.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad();</script>
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
<a href="../.." class="icon icon-home"> WebBTC Specification
|
||||
</a><div role="search">
|
||||
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../..">Overview</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">API Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Enable</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../enable/">Enabling</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Information</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../info/">info</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Signatures</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/sign/">Signing</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../signatures/verify/">Verification</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="reference internal current" href="#">Invoices</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../invoices/makeInvoice/">makeInvoice</a>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../send/">sendPayment</a>
|
||||
</li>
|
||||
<li class="toctree-l2 current"><a class="reference internal current" href="./">sendTransaction</a>
|
||||
<ul class="current">
|
||||
<li class="toctree-l3"><a class="reference internal" href="#syntax">Syntax</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#returns">Returns</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#">Addresses</a>
|
||||
<ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../addresses/getAddress/">getAddress</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../extendability/extending/">Extending</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../squatting/">Namespace Squatting</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../references/">Resources</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../..">WebBTC Specification</a>
|
||||
|
||||
</nav>
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../.." class="icon icon-home" alt="Docs"></a> »</li>
|
||||
<li>API Reference »</li>
|
||||
<li>Invoices »</li><li>sendTransaction</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div class="section" itemprop="articleBody">
|
||||
|
||||
<h1 id="send-transaction">Send transaction</h1>
|
||||
<p>The <code>sendTransaction</code> method is called to make an onchain payment. </p>
|
||||
<h2 id="syntax">Syntax</h2>
|
||||
<pre><code>sendTransaction(String)
|
||||
</code></pre>
|
||||
<h2 id="parameters">Parameters</h2>
|
||||
<ul>
|
||||
<li>address: String <span class="badge">Required</span></li>
|
||||
<li>amount: String <span class="badge">Required</span></li>
|
||||
</ul>
|
||||
<h2 id="returns">Returns</h2>
|
||||
<ul>
|
||||
<li>txid: String </li>
|
||||
</ul>
|
||||
<h2 id="example">Example</h2>
|
||||
<pre><code>window.bitcoin.sendTransaction('tb1qqwn2dp8mundc6mf3xt4c8puqakk0vrcgzdayq2', 10000)
|
||||
|
||||
"ba8d75e01ab32932d9ac899418a6bec95f2869e1b1c161b871f661c5a8789a0e"
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="notes">Notes</h2>
|
||||
<ul>
|
||||
<li>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. </li>
|
||||
<li>There are more complex versions for onchain including PSBT, pay multiple addresses at the same time.</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div><footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
||||
<a href="../send/" class="btn btn-neutral float-left" title="sendPayment"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
||||
<a href="../../addresses/getAddress/" class="btn btn-neutral float-right" title="getAddress">Next <span class="icon icon-circle-arrow-right"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<!-- Copyright etc -->
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="rst-versions" role="note" aria-label="Versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
|
||||
|
||||
<span><a href="../send/" style="color: #fcfcfc">« Previous</a></span>
|
||||
|
||||
|
||||
<span><a href="../../addresses/getAddress/" style="color: #fcfcfc">Next »</a></span>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
<script>var base_url = '../..';</script>
|
||||
<script src="../../js/theme_extra.js" defer></script>
|
||||
<script src="../../js/theme.js" defer></script>
|
||||
<script src="../../search/main.js" defer></script>
|
||||
<script defer>
|
||||
window.onload = function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
};
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
BIN
favicon.ico
Normal file
BIN
favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
1
index.html
Normal file
1
index.html
Normal file
@@ -0,0 +1 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/favicon.ico"><title>specwrapper</title><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css"><link href="/css/app.4d16f0ed.css" rel="preload" as="style"><link href="/css/chunk-vendors.d4e3e587.css" rel="preload" as="style"><link href="/js/app.20231a76.js" rel="preload" as="script"><link href="/js/chunk-vendors.73627de4.js" rel="preload" as="script"><link href="/css/chunk-vendors.d4e3e587.css" rel="stylesheet"><link href="/css/app.4d16f0ed.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but specwrapper doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/js/chunk-vendors.73627de4.js"></script><script src="/js/app.20231a76.js"></script></body></html>
|
||||
2
js/app.20231a76.js
Normal file
2
js/app.20231a76.js
Normal file
File diff suppressed because one or more lines are too long
1
js/app.20231a76.js.map
Normal file
1
js/app.20231a76.js.map
Normal file
File diff suppressed because one or more lines are too long
8
js/chunk-vendors.73627de4.js
Normal file
8
js/chunk-vendors.73627de4.js
Normal file
File diff suppressed because one or more lines are too long
1
js/chunk-vendors.73627de4.js.map
Normal file
1
js/chunk-vendors.73627de4.js.map
Normal file
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user