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>PartiallySignedTransaction</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     if (storage == null) {
  10         const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
  11         if (osDarkSchemePreferred === true) {
  12             document.getElementsByTagName("html")[0].classList.add("theme-dark")
  13         }
  14     } else {
  15         const savedDarkMode = JSON.parse(storage)
  16         if(savedDarkMode === true) {
  17             document.getElementsByTagName("html")[0].classList.add("theme-dark")
  18         }
  19     }
  20     </script>
  21 <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
  22 <link href="../../../styles/style.css" rel="Stylesheet">
  23 <link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
  24 <link href="../../../styles/main.css" rel="Stylesheet">
  25 <link href="../../../styles/prism.css" rel="Stylesheet">
  26 <link href="../../../styles/logo-styles.css" rel="Stylesheet">
  27 <script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
  28 <script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
  29 <script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
  30 <script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
  31 <script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
  32 <script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
  33 </head>
  34 <body>
  35 <div class="navigation-wrapper" id="navigation-wrapper">
  36     <div id="leftToggler"><span class="icon-toggler"></span></div>
  37     <div class="library-name">
  38             <a href="../../../index.html">
  39                     <span>bdk-android</span>
  40             </a>
  41     </div>
  42     <div>
  43 0.29.0    </div>
  44     <div class="pull-right d-flex">
  45         <div class="filter-section" id="filter-section">
  46                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
  47         </div>
  48         <button id="theme-toggle-button"><span id="theme-toggle"></span></button>
  49         <div id="searchBar"></div>
  50     </div>
  51 </div>
  52 <div id="container">
  53     <div id="leftColumn">
  54         <div id="sideMenu"></div>
  55     </div>
  56     <div id="main">
  57 <div class="main-content" data-page-type="classlike" id="content" pageIds="bdk-android::org.bitcoindevkit/PartiallySignedTransaction///PointingToDeclaration//769193423">
  58   <div class="breadcrumbs"><a href="../../../index.html">bdk-android</a><span class="delimiter">/</span><a href="../index.html">org.bitcoindevkit</a><span class="delimiter">/</span><span class="current">PartiallySignedTransaction</span></div>
  59   <div class="cover ">
  60     <h1 class="cover"><span>Partially</span><wbr></wbr><span>Signed</span><wbr></wbr><span><span>Transaction</span></span></h1>
  61     <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">PartiallySignedTransaction</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></div><p class="paragraph">A partially signed bitcoin transaction.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>psbt</span><wbr></wbr><span><span>Base64</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The PSBT in base64 format.</p></div></div></div></div></div></div></div>
  62   </div>
  63   <div class="tabbedcontent">
  64     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
  65     <div class="tabs-section-body">
  66       <div data-togglable="CONSTRUCTOR">
  67         <h2 class="">Constructors</h2>
  68         <div class="table"><a data-name="598211772%2FConstructors%2F769193423" anchor-label="PartiallySignedTransaction" id="598211772%2FConstructors%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
  69           <div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
  70             <div class="main-subrow keyValue ">
  71               <div class=""><span class="inline-flex">
  72                   <div><a href="-partially-signed-transaction.html"><span>Partially</span><wbr></wbr><span>Signed</span><wbr></wbr><span><span>Transaction</span></span></a></div>
  73 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="598211772%2FConstructors%2F769193423"></span>
  74                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  75                   </span></span></div>
  76               <div>
  77                 <div class="title">
  78                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><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></div><div class="brief "><p class="paragraph">Build a new Partially Signed Bitcoin Transaction.</p></div></div></div>
  79                 </div>
  80               </div>
  81             </div>
  82           </div>
  83         </div>
  84       </div>
  85       <div data-togglable="FUNCTION">
  86         <h2 class="">Functions</h2>
  87         <div class="table"><a data-name="-1761845486%2FFunctions%2F769193423" anchor-label="combine" id="-1761845486%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
  88           <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
  89             <div class="main-subrow keyValue ">
  90               <div class=""><span class="inline-flex">
  91                   <div><a href="combine.html"><span><span>combine</span></span></a></div>
  92 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1761845486%2FFunctions%2F769193423"></span>
  93                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
  94                   </span></span></div>
  95               <div>
  96                 <div class="title">
  97                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-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">PartiallySignedTransaction</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">PartiallySignedTransaction</a></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>
  98                 </div>
  99               </div>
 100             </div>
 101           </div>
 102 <a data-name="1297815161%2FFunctions%2F769193423" anchor-label="extractTx" id="1297815161%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
 103           <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
 104             <div class="main-subrow keyValue ">
 105               <div class=""><span class="inline-flex">
 106                   <div><a href="extract-tx.html"><span>extract</span><wbr></wbr><span><span>Tx</span></span></a></div>
 107 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1297815161%2FFunctions%2F769193423"></span>
 108                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 109                   </span></span></div>
 110               <div>
 111                 <div class="title">
 112                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-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="../-transaction/index.html">Transaction</a></div><div class="brief "><p class="paragraph">Extract the transaction.</p></div></div></div>
 113                 </div>
 114               </div>
 115             </div>
 116           </div>
 117 <a data-name="1113170278%2FFunctions%2F769193423" anchor-label="jsonSerialize" id="1113170278%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
 118           <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
 119             <div class="main-subrow keyValue ">
 120               <div class=""><span class="inline-flex">
 121                   <div><a href="json-serialize.html"><span>json</span><wbr></wbr><span><span>Serialize</span></span></a></div>
 122 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1113170278%2FFunctions%2F769193423"></span>
 123                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 124                   </span></span></div>
 125               <div>
 126                 <div class="title">
 127                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="json-serialize.html"><span class="token function">jsonSerialize</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></div><div class="brief "><p class="paragraph">Serialize the PSBT data structure as a String of JSON.</p></div></div></div>
 128                 </div>
 129               </div>
 130             </div>
 131           </div>
 132 <a data-name="-79668514%2FFunctions%2F769193423" anchor-label="serialize" id="-79668514%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
 133           <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
 134             <div class="main-subrow keyValue ">
 135               <div class=""><span class="inline-flex">
 136                   <div><a href="serialize.html"><span><span>serialize</span></span></a></div>
 137 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-79668514%2FFunctions%2F769193423"></span>
 138                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 139                   </span></span></div>
 140               <div>
 141                 <div class="title">
 142                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-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></div><div class="brief "><p class="paragraph">Return the PSBT in string format, using a base64 encoding.</p></div></div></div>
 143                 </div>
 144               </div>
 145             </div>
 146           </div>
 147 <a data-name="-1119265955%2FFunctions%2F769193423" anchor-label="txid" id="-1119265955%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
 148           <div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
 149             <div class="main-subrow keyValue ">
 150               <div class=""><span class="inline-flex">
 151                   <div><a href="txid.html"><span><span>txid</span></span></a></div>
 152 <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1119265955%2FFunctions%2F769193423"></span>
 153                     <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
 154                   </span></span></div>
 155               <div>
 156                 <div class="title">
 157                   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-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></div><div class="brief "><p class="paragraph">Get the txid of the PSBT.</p></div></div></div>
 158                 </div>
 159               </div>
 160             </div>
 161           </div>
 162         </div>
 163       </div>
 164     </div>
 165   </div>
 166 </div>
 167       <div class="footer">
 168         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
 169                 class="pull-right"><span>Generated by </span><a
 170                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
 171       </div>
 172     </div>
 173 </div>
 174 </body>
 175 </html>