web3.VoteProgram.html 25 KB

123456789101112131415161718192021222324252627
  1. <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VoteProgram | @coral-xyz/anchor - v0.29.0</title><meta name="description" content="Documentation for @coral-xyz/anchor - v0.29.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coral-xyz/anchor - v0.29.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coral-xyz/anchor - v0.29.0</a></li><li><a href="../modules/web3.html">web3</a></li><li><a href="web3.VoteProgram.html">VoteProgram</a></li></ul><h1>Class VoteProgram </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
  2. <p>Factory class for transactions to interact with the Vote program</p>
  3. </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">VoteProgram</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-external"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="web3.VoteProgram.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#programId" class="tsd-kind-icon">program<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#space" class="tsd-kind-icon">space</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#authorize" class="tsd-kind-icon">authorize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#authorizeWithSeed" class="tsd-kind-icon">authorize<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#createAccount" class="tsd-kind-icon">create<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#initializeAccount" class="tsd-kind-icon">initialize<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#safeWithdraw" class="tsd-kind-icon">safe<wbr/>Withdraw</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#withdraw" class="tsd-kind-icon">withdraw</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">new <wbr/>Vote<wbr/>Program<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.VoteProgram.html" class="tsd-signature-type" data-tsd-kind="Class">VoteProgram</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="web3.VoteProgram.html" class="tsd-signature-type" data-tsd-kind="Class">VoteProgram</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="programId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> program<wbr/>Id<a href="#programId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">program<wbr/>Id<span class="tsd-signature-symbol">:</span> <a href="web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1508</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  4. <p>Public key that identifies the Vote program</p>
  5. </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="space" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> space<a href="#space" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">space<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1516</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  6. <p>Max space of a Vote account</p>
  7. </div><div><p>This is generated from the solana-vote-program VoteState struct as
  8. <code>VoteState::size_of()</code>:
  9. <a href="https://docs.rs/solana-vote-program/1.9.5/solana_vote_program/vote_state/struct.VoteState.html#method.size_of">https://docs.rs/solana-vote-program/1.9.5/solana_vote_program/vote_state/struct.VoteState.html#method.size_of</a></p>
  10. </div></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="authorize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> authorize<a href="#authorize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">authorize<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AuthorizeVoteParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeVoteParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1530</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  11. <p>Generate a transaction that authorizes a new Voter or Withdrawer on the Vote account.</p>
  12. </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#AuthorizeVoteParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeVoteParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="authorizeWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> authorize<wbr/>With<wbr/>Seed<a href="#authorizeWithSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">authorize<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AuthorizeVoteWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeVoteWithSeedParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1535</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  13. <p>Generate a transaction that authorizes a new Voter or Withdrawer on the Vote account
  14. where the current Voter or Withdrawer authority is a derived key.</p>
  15. </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#AuthorizeVoteWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeVoteWithSeedParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="createAccount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> create<wbr/>Account<a href="#createAccount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">create<wbr/>Account<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#CreateVoteAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateVoteAccountParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1526</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  16. <p>Generate a transaction that creates a new Vote account.</p>
  17. </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#CreateVoteAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateVoteAccountParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="initializeAccount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> initialize<wbr/>Account<a href="#initializeAccount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">initialize<wbr/>Account<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#InitializeAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">InitializeAccountParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1520</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  18. <p>Generate an Initialize instruction.</p>
  19. </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#InitializeAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">InitializeAccountParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="safeWithdraw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> safe<wbr/>Withdraw<a href="#safeWithdraw" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">safe<wbr/>Withdraw<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#WithdrawFromVoteAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawFromVoteAccountParams</a>, currentVoteAccountBalance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rentExemptMinimum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1548</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  20. <p>Generate a transaction to withdraw safely from a Vote account.</p>
  21. </div><div><p>This function was created as a safeguard for vote accounts running validators, <code>safeWithdraw</code>
  22. checks that the withdraw amount will not exceed the specified balance while leaving enough left
  23. to cover rent. If you wish to close the vote account by withdrawing the full amount, call the
  24. <code>withdraw</code> method directly.</p>
  25. </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#WithdrawFromVoteAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawFromVoteAccountParams</a></h5></li><li><h5>currentVoteAccountBalance: <span class="tsd-signature-type">number</span></h5></li><li><h5>rentExemptMinimum: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="withdraw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> withdraw<a href="#withdraw" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">withdraw<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#WithdrawFromVoteAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawFromVoteAccountParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1539</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
  26. <p>Generate a transaction to withdraw from a Vote account.</p>
  27. </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#WithdrawFromVoteAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawFromVoteAccountParams</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class="label tsd-is-external"><span>Internals</span></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class="label tsd-is-external"><span>Externals</span></li><li class=" tsd-kind-namespace tsd-is-external"><a href="../modules/BN.html">BN</a></li><li class="current tsd-kind-namespace tsd-is-external"><a href="../modules/web3.html">web3</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="web3.VoteProgram.html" class="tsd-kind-icon">Vote<wbr/>Program</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="web3.VoteProgram.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#programId" class="tsd-kind-icon">program<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#space" class="tsd-kind-icon">space</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#authorize" class="tsd-kind-icon">authorize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#authorizeWithSeed" class="tsd-kind-icon">authorize<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#createAccount" class="tsd-kind-icon">create<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#initializeAccount" class="tsd-kind-icon">initialize<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#safeWithdraw" class="tsd-kind-icon">safe<wbr/>Withdraw</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.VoteProgram.html#withdraw" class="tsd-kind-icon">withdraw</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>