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>allowShrinking</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-android</span>
  31             </a>
  32     </div>
  33     <div>
  34 0.10.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-android::org.bitcoindevkit/BumpFeeTxBuilder/allowShrinking/#kotlin.String/PointingToDeclaration//769193423">
  46   <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><a href="index.html">BumpFeeTxBuilder</a><span class="delimiter">/</span><a href="allow-shrinking.html">allowShrinking</a></div>
  47   <div class="cover ">
  48     <h1 class="cover"><span>allow</span><wbr></wbr><span><span>Shrinking</span></span></h1>
  49   </div>
  50   <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="allow-shrinking.html"><span class="token function">allowShrinking</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">address<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="token operator">: </span><a href="index.html">BumpFeeTxBuilder</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><p class="paragraph">Explicitly tells the wallet that it is allowed to reduce the amount of the output matching this scriptPubKey in order to bump the transaction fee. Without specifying this the wallet will attempt to find a change output to shrink instead. Note that the output may shrink to below the dust limit and therefore be removed. If it is preserved then it is currently not guaranteed to be in the same position as it was originally. Returns an error if scriptPubkey can’t be found among the recipients of the transaction we are bumping.</p></div></div>
  51 </div>
  52       <div class="footer">
  53         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
  54                 class="pull-right"><span>Generated by </span><a
  55                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
  56       </div>
  57     </div>
  58 </div>
  59 </body>
  60 </html>