Untitled Git - bitcoindevkit.org/blob

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4     <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
   5     <title>PartiallySignedBitcoinTransaction</title>
   6     <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
   7     <script>var pathToRoot = "../../../";</script>
   8     <script>const storage = localStorage.getItem("dokka-dark-mode")
   9 const savedDarkMode = storage ? JSON.parse(storage) : false
  10 if(savedDarkMode === true){
  11     document.getElementsByTagName("html")[0].classList.add("theme-dark")
  12 }</script>
  13 <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
  14 <link href="../../../styles/style.css" rel="Stylesheet">
  15 <link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
  16 <link href="../../../styles/main.css" rel="Stylesheet">
  17 <link href="../../../styles/prism.css" rel="Stylesheet">
  18 <link href="../../../styles/logo-styles.css" rel="Stylesheet">
  19 <script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
  20 <script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
  21 <script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
  22 <script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
  23 <script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
  24 </head>
  25 <body>
  26 <div class="navigation-wrapper" id="navigation-wrapper">
  27     <div id="leftToggler"><span class="icon-toggler"></span></div>
  28     <div class="library-name">
  29             <a href="../../../index.html">
  30                     <span>bdk-jvm</span>
  31             </a>
  32     </div>
  33     <div>
  34 0.26.0    </div>
  35     <div class="pull-right d-flex">
  36         <button id="theme-toggle-button"><span id="theme-toggle"></span></button>
  37         <div id="searchBar"></div>
  38     </div>
  39 </div>
  40 <div id="container">
  41     <div id="leftColumn">
  42         <div id="sideMenu"></div>
  43     </div>
  44     <div id="main">
  45 <div class="main-content" id="content" pageIds="bdk-jvm::org.bitcoindevkit/PartiallySignedBitcoinTransaction///PointingToDeclaration//769193423">
  46   <div class="breadcrumbs"><a href="../../../index.html">bdk-jvm</a><span class="delimiter">/</span><a href="../index.html">org.bitcoindevkit</a><span class="delimiter">/</span><a href="index.html">PartiallySignedBitcoinTransaction</a></div>
  47   <div class="cover ">
  48     <h1 class="cover"><span>Partially</span><wbr></wbr><span>Signed</span><wbr></wbr><span>Bitcoin</span><wbr></wbr><span><span>Transaction</span></span></h1>
  49     <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">PartiallySignedBitcoinTransaction</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">psbtBase64<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">A partially signed bitcoin transaction.</p></div></div>
  50   </div>
  51   <div class="tabbedcontent">
  52     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Parameters">Parameters</button></div>
  53     <div class="tabs-section-body">
  54       <h2 class="">Parameters</h2>
  55       <div data-togglable="Parameters">
  56         <div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span>psbt</span><wbr></wbr><span><span>Base64</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The PSBT in base64 format.</p></div></div></div></div></div></div></div></div></div>
  57       </div>
  58       <h2 class="tabbedcontent">Constructors</h2>
  59       <div class="table" data-togglable="Constructors"><a data-name="535544274%2FConstructors%2F769193423" anchor-label="PartiallySignedBitcoinTransaction" id="535544274%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
  60         <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
  61           <div class="main-subrow keyValue TabbedContent">
  62             <div class=""><span class="inline-flex">
  63                 <div><a href="-partially-signed-bitcoin-transaction.html"><span>Partially</span><wbr></wbr><span>Signed</span><wbr></wbr><span>Bitcoin</span><wbr></wbr><span><span>Transaction</span></span></a></div>
  64 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="535544274%2FConstructors%2F769193423"></span>
  65                   <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  66                 </span></span></div>
  67             <div>
  68               <div class="title">
  69                 <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-partially-signed-bitcoin-transaction.html"><span class="token function">PartiallySignedBitcoinTransaction</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">psbtBase64<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Build a new Partially Signed Bitcoin Transaction.</p></div></div></div>
  70               </div>
  71             </div>
  72           </div>
  73         </div>
  74       </div>
  75       <h2 class="">Functions</h2>
  76       <div class="table" data-togglable="Functions"><a data-name="477516820%2FFunctions%2F769193423" anchor-label="combine" id="477516820%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
  77         <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
  78           <div class="main-subrow keyValue ">
  79             <div class=""><span class="inline-flex">
  80                 <div><a href="combine.html"><span><span>combine</span></span></a></div>
  81 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="477516820%2FFunctions%2F769193423"></span>
  82                   <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  83                 </span></span></div>
  84             <div>
  85               <div class="title">
  86                 <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="combine.html"><span class="token function">combine</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><a href="index.html">PartiallySignedBitcoinTransaction</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">PartiallySignedBitcoinTransaction</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Combines this PartiallySignedTransaction with another PSBT as described by BIP 174. In accordance with BIP 174 this function is commutative i.e., <code class="lang-kotlin">A.combine(B) == B.combine(A)</code></p></div></div></div>
  87               </div>
  88             </div>
  89           </div>
  90         </div>
  91 <a data-name="-831485225%2FFunctions%2F769193423" anchor-label="extractTx" id="-831485225%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
  92         <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
  93           <div class="main-subrow keyValue ">
  94             <div class=""><span class="inline-flex">
  95                 <div><a href="extract-tx.html"><span>extract</span><wbr></wbr><span><span>Tx</span></span></a></div>
  96 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-831485225%2FFunctions%2F769193423"></span>
  97                   <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  98                 </span></span></div>
  99             <div>
 100               <div class="title">
 101                 <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="extract-tx.html"><span class="token function">extractTx</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html">UByte</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Return the transaction as bytes.</p></div></div></div>
 102               </div>
 103             </div>
 104           </div>
 105         </div>
 106 <a data-name="2085998396%2FFunctions%2F769193423" anchor-label="serialize" id="2085998396%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
 107         <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
 108           <div class="main-subrow keyValue ">
 109             <div class=""><span class="inline-flex">
 110                 <div><a href="serialize.html"><span><span>serialize</span></span></a></div>
 111 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2085998396%2FFunctions%2F769193423"></span>
 112                   <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 113                 </span></span></div>
 114             <div>
 115               <div class="title">
 116                 <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="serialize.html"><span class="token function">serialize</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Return the PSBT in string format, using a base64 encoding.</p></div></div></div>
 117               </div>
 118             </div>
 119           </div>
 120         </div>
 121 <a data-name="1876436031%2FFunctions%2F769193423" anchor-label="txid" id="1876436031%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
 122         <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
 123           <div class="main-subrow keyValue ">
 124             <div class=""><span class="inline-flex">
 125                 <div><a href="txid.html"><span><span>txid</span></span></a></div>
 126 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1876436031%2FFunctions%2F769193423"></span>
 127                   <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 128                 </span></span></div>
 129             <div>
 130               <div class="title">
 131                 <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="txid.html"><span class="token function">txid</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Get the txid of the PSBT.</p></div></div></div>
 132               </div>
 133             </div>
 134           </div>
 135         </div>
 136       </div>
 137     </div>
 138   </div>
 139 </div>
 140       <div class="footer">
 141         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
 142                 class="pull-right"><span>Generated by </span><a
 143                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
 144       </div>
 145     </div>
 146 </div>
 147 </body>
 148 </html>