mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-15 12:20:06 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/docs/next/core/sign/index.html

119 lines
19 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on 920199cf9e80921623eae9750375736159496c39
2020-03-31 19:39:41 +00:00
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Sign API · bitcoin-s</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="### The [`Sign` API](org/bitcoins/core/crypto/Sign.scala)"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Sign API · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="### The [`Sign` API](org/bitcoins/core/crypto/Sign.scala)"/><meta property="og:image" content="https://bitcoin-s.org/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://bitcoin-s.org/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="https://fonts.googleapis.com/css?family=Montserrat:500"></script><script type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=UA-61958686-2"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/favicon.ico" alt="bitcoin-s"/><h2 class="headerTitleWithLogo">bitcoin-s</h2></a><a href="/versions"><h3>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/next/core/core-intro" target="_self">Docs</a></li><li class=""><a href="/api/org/bitcoins" target="_self">API</a></li><li class=""><a href="/help" target="_self">Help</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Core Module</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/getting-started">Intro and Getting Started</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Setup</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/getting-setup">Getting Bitcoin-S installed on your machine</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Applications</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/applications/cli">CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/next/applications/server">Application Server</a></li><li class="navListItem"><a class="navItem" href="/docs/next/applications/gui">GUI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Chain</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/next/chain/chain">
Deploy website Deploy website version based on f280103e478207d88a77edd36d1cd640d937b224
2019-12-20 19:11:14 +00:00
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
Deploy website Deploy website version based on 69783f9ed836f8e70a2aa4c4ead0d9584b9edd47
2020-03-13 15:02:35 +00:00
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/core/sign.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Sign API</h1></header><article><div><span><h3><a class="anchor" aria-hidden="true" id="the-sign-apiorgbitcoinscorecryptosignscala"></a><a href="#the-sign-apiorgbitcoinscorecryptosignscala" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>The <a href="org/bitcoins/core/crypto/Sign.scala"><code>Sign</code> API</a></h3>
Deploy website Deploy website version based on f280103e478207d88a77edd36d1cd640d937b224
2019-12-20 19:11:14 +00:00
<p>This is the API we define to sign things with. It takes in an arbitrary byte vector and returns a <code>Future[ECDigitalSignature]</code>. The reason we incorporate <code>Future</code>s here is for extensibility of this API. We would like to provide implementations of this API for hardware devices, which need to be asynchrnous since they may require user input.</p>
<p>From <a href="../../core/src/main/scala/org/bitcoins/core/crypto/Sign.scala">Sign.scala</a>:</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> scodec.bits._
<span class="hljs-keyword">import</span> org.bitcoins.core.crypto._
<span class="hljs-keyword">import</span> scala.concurrent._
<span class="hljs-keyword">import</span> scala.concurrent.duration._
<span class="hljs-class"><span class="hljs-keyword">trait</span> <span class="hljs-title">Sign</span> </span>{
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">signFunction</span></span>: <span class="hljs-type">ByteVector</span> =&gt; <span class="hljs-type">Future</span>[<span class="hljs-type">ECDigitalSignature</span>]
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">signFuture</span></span>(bytes: <span class="hljs-type">ByteVector</span>): <span class="hljs-type">Future</span>[<span class="hljs-type">ECDigitalSignature</span>] =
signFunction(bytes)
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">sign</span></span>(bytes: <span class="hljs-type">ByteVector</span>): <span class="hljs-type">ECDigitalSignature</span> = {
<span class="hljs-type">Await</span>.result(signFuture(bytes), <span class="hljs-number">30.</span>seconds)
}
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">publicKey</span></span>: <span class="hljs-type">ECPublicKey</span>
}
</code></pre>
<p>The <code>ByteVector</code> that is input to the <code>signFunction</code> should be the hash that is output from <a href="/api/org/bitcoins/core/crypto/TransactionSignatureSerializer"><code>TransactionSignatureSerializer</code></a>'s <code>hashForSignature</code> method. Our in-memory <a href="/api/org/bitcoins/core/crypto/ECKey"><code>ECKey</code></a> types implement the <code>Sign</code> API.</p>
<p>If you wanted to implement a new <code>Sign</code> api for a hardware wallet, you can easily pass it into the <code>TxBuilder</code>/<code>Signer</code> classes to allow for you to use those devices to sign with Bitcoin-S.</p>
<p>This API is currently used to sign ordinary transactions with our <a href="/api/org/bitcoins/core/wallet/signer/Signer"><code>Signer</code></a>s. The <code>Signer</code> subtypes (i.e. <code>P2PKHSigner</code>) implement the specific functionality needed to produce a valid digital signature for their corresponding script type.</p>
<h3><a class="anchor" aria-hidden="true" id="the-extsigncoresrcmainscalaorgbitcoinscorecryptosignscala-api"></a><a href="#the-extsigncoresrcmainscalaorgbitcoinscorecryptosignscala-api" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>The <a href="../../core/src/main/scala/org/bitcoins/core/crypto/Sign.scala"><code>ExtSign</code></a> API.</h3>
<p>An <a href="org/bitcoins/core/crypto/ExtKey.scala">ExtKey</a> is a data structure that can be used to generate more keys from a parent key. For more information look at <a href="/docs/next/core/hd-keys">/docs/next/core/hd-keys</a></p>
<p>You can sign with <code>ExtPrivateKey</code> the same way you could with a normal <code>ECPrivateKey</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> org.bitcoins.core.hd._
<span class="hljs-keyword">import</span> org.bitcoins.core.crypto._
<span class="hljs-keyword">val</span> extPrivKey = <span class="hljs-type">ExtPrivateKey</span>(<span class="hljs-type">ExtKeyVersion</span>.<span class="hljs-type">SegWitMainNetPriv</span>)
Deploy website Deploy website version based on 82ef36e2a612175817638e4b0d0194c5301b990b
2020-01-07 18:42:42 +00:00
<span class="hljs-comment">// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)</span>
Deploy website Deploy website version based on f280103e478207d88a77edd36d1cd640d937b224
2019-12-20 19:11:14 +00:00
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes)
Deploy website Deploy website version based on 80882bf649e1cc42d0890851acc43bb1ae3fcb57
2020-04-02 12:10:31 +00:00
<span class="hljs-comment">// res0: ECDigitalSignature = ECDigitalSignature(304402204385da315a572f48ef389ee56a900d52523a31e3f5bb310293216a7534280acc022078cd3fb58eaf06a3534d1a7ba127a8d7b7bc188afa552542ced2eefa6ec6f0bc)</span>
Deploy website Deploy website version based on f280103e478207d88a77edd36d1cd640d937b224
2019-12-20 19:11:14 +00:00
<span class="hljs-keyword">val</span> path = <span class="hljs-type">BIP32Path</span>(<span class="hljs-type">Vector</span>(<span class="hljs-type">BIP32Node</span>(<span class="hljs-number">0</span>,<span class="hljs-literal">false</span>)))
<span class="hljs-comment">// path: BIP32Path = m/0</span>
extPrivKey.sign(<span class="hljs-type">DoubleSha256Digest</span>.empty.bytes,path)
Deploy website Deploy website version based on 80882bf649e1cc42d0890851acc43bb1ae3fcb57
2020-04-02 12:10:31 +00:00
<span class="hljs-comment">// res1: ECDigitalSignature = ECDigitalSignature(3045022100de27ac4c6132452a0f09df68e099b560b7e51c9ac3b4f40dc314624e02ee4eae022077fb6c6d705b2c431aaeb7d87001296cab5bffdec5899e6fc3b4af936de54aa7)</span>
Deploy website Deploy website version based on f280103e478207d88a77edd36d1cd640d937b224
2019-12-20 19:11:14 +00:00
</code></pre>
<p>With <code>ExtSign</code>, you can use <code>ExtPrivateKey</code> to sign transactions inside of <code>TxBuilder</code> since <code>UTXOSpendingInfo</code> takes in <code>Sign</code> as a parameter.</p>
<p>You can also provide a <code>path</code> to use to derive a child <code>ExtPrivateKey</code>, and then sign with that child private key</p>
Deploy website Deploy website version based on 3bfabe7bd5074c880654763ba030c752b9fe52da
2020-03-10 20:11:23 +00:00
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/next/core/spending-info"><span class="arrow-prev">← </span><span>Signing Transactions</span></a><a class="docs-next button" href="/docs/next/core/psbts"><span>Partially Signed Bitcoin Transactions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/enQtNDEyMjY3MTg1MTg3LTYyYjkwOGUzMDQ4NDAwZjE1M2I3MmQyNWNlZjNlYjg4OGRjYTRjNWUwNjRjNjg4Y2NjZjAxYjU1N2JjMTU1YWM" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 Suredbits &amp; the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
Deploy website Deploy website version based on f280103e478207d88a77edd36d1cd640d937b224
2019-12-20 19:11:14 +00:00
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '0a510688bf8448e19aeb380377d328d3',
indexName: 'bitcoin-s',
inputSelector: '#search_input_react'
});
</script></body></html>
Reference in a new issue Copy permalink