Files
BitcoinAndLightningLayerSpe…/docs/index.html
2022-06-17 11:45:33 +02:00

177 lines
7.8 KiB
HTML

<!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> &raquo;</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://bitcoinandlightninglayerspecs.github.io/">here</a> together with the accompanying <a href="https://bitcoinandlightninglayerspecs.github.io/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 &raquo;</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:43:48.072202+00:00
-->