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>DescriptorSecretKey</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/DescriptorSecretKey/DescriptorSecretKey/#org.bitcoindevkit.Network#org.bitcoindevkit.Mnemonic#kotlin.String?/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">DescriptorSecretKey</a><span class="delimiter">/</span><a href="-descriptor-secret-key.html">DescriptorSecretKey</a></div>
  47   <div class="cover ">
  48     <h1 class="cover"><span>Descriptor</span><wbr></wbr><span>Secret</span><wbr></wbr><span><span>Key</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="-descriptor-secret-key.html"><span class="token function">DescriptorSecretKey</span></a><span class="token punctuation">(</span><span class="parameters wrapped"><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;network<span class="token operator">: </span><a href="../-network/index.html">Network</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;mnemonic<span class="token operator">: </span><a href="../-mnemonic/index.html">Mnemonic</a><span class="token punctuation">, </span></span><span class="parameter indented">&nbsp;&nbsp;&nbsp;&nbsp;password<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span></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><h2 class="">Parameters</h2><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><span>network</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The network this DescriptorSecretKey is to be used on.</p></div></div></div></div></div><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><span>mnemonic</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The mnemonic.</p></div></div></div></div></div><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><span>password</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The optional passphrase that can be provided as per BIP-39.</p></div></div></div></div></div></div></div></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>© 2023 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>