38 lines
36 KiB
HTML
38 lines
36 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StakeProgram | @project-serum/anchor - v0.25.0</title><meta name="description" content="Documentation for @project-serum/anchor - v0.25.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">@project-serum/anchor - v0.25.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">@project-serum/anchor - v0.25.0</a></li><li><a href="../modules/web3.html">web3</a></li><li><a href="web3.StakeProgram.html">StakeProgram</a></li></ul><h1>Class StakeProgram</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">
|
|
<p>Factory class for transactions to interact with the Stake program</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">StakeProgram</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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.html#createAccountWithSeed" class="tsd-kind-icon">create<wbr/>Account<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#deactivate" class="tsd-kind-icon">deactivate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#delegate" class="tsd-kind-icon">delegate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#initialize" class="tsd-kind-icon">initialize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#merge" class="tsd-kind-icon">merge</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#split" class="tsd-kind-icon">split</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#splitWithSeed" class="tsd-kind-icon">split<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.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/>Stake<wbr/>Program<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.StakeProgram.html" class="tsd-signature-type" data-tsd-kind="Class">StakeProgram</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="web3.StakeProgram.html" class="tsd-signature-type" data-tsd-kind="Class">StakeProgram</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:2416</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Public key that identifies the Stake program</p>
|
|
</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:2424</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Max space of a Stake account</p>
|
|
</div><div><p>This is generated from the solana-stake-program StakeState struct as
|
|
<code>std::mem::size_of::<StakeState>()</code>:
|
|
<a href="https://docs.rs/solana-stake-program/1.4.4/solana_stake_program/stake_state/enum.StakeState.html">https://docs.rs/solana-stake-program/1.4.4/solana_stake_program/stake_state/enum.StakeState.html</a></p>
|
|
</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#AuthorizeStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeStakeParams</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:2450</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that authorizes a new PublicKey as Staker
|
|
or Withdrawer on the Stake account.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#AuthorizeStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeStakeParams</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#AuthorizeWithSeedStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeWithSeedStakeParams</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:2455</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that authorizes a new PublicKey as Staker
|
|
or Withdrawer on the Stake account.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#AuthorizeWithSeedStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeWithSeedStakeParams</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#CreateStakeAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateStakeAccountParams</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:2439</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that creates a new Stake account</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#CreateStakeAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateStakeAccountParams</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="createAccountWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> create<wbr/>Account<wbr/>With<wbr/>Seed<a href="#createAccountWithSeed" 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<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#CreateStakeAccountWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateStakeAccountWithSeedParams</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:2433</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that creates a new Stake account at
|
|
an address generated with <code>from</code>, a seed, and the Stake programId</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#CreateStakeAccountWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateStakeAccountWithSeedParams</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="deactivate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> deactivate<a href="#deactivate" 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">deactivate<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#DeactivateStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">DeactivateStakeParams</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:2476</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that deactivates Stake tokens.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#DeactivateStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">DeactivateStakeParams</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="delegate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> delegate<a href="#delegate" 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">delegate<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#DelegateStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">DelegateStakeParams</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:2445</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that delegates Stake tokens to a validator
|
|
Vote PublicKey. This transaction can also be used to redelegate Stake
|
|
to a new validator Vote PublicKey.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#DelegateStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">DelegateStakeParams</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="initialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> initialize<a href="#initialize" 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<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#InitializeStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">InitializeStakeParams</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:2428</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate an Initialize instruction to add to a Stake Create transaction</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#InitializeStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">InitializeStakeParams</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="merge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> merge<a href="#merge" 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">merge<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#MergeStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">MergeStakeParams</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:2468</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that merges Stake accounts.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#MergeStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">MergeStakeParams</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="split" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> split<a href="#split" 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">split<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#SplitStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">SplitStakeParams</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:2459</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that splits Stake tokens into another stake account</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#SplitStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">SplitStakeParams</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="splitWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> split<wbr/>With<wbr/>Seed<a href="#splitWithSeed" 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">split<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#SplitStakeWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">SplitStakeWithSeedParams</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:2464</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that splits Stake tokens into another account
|
|
derived from a base public key and seed</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#SplitStakeWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">SplitStakeWithSeedParams</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="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#WithdrawStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawStakeParams</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:2472</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Generate a Transaction that withdraws deactivated Stake tokens.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="../modules/web3.html#WithdrawStakeParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawStakeParams</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.StakeProgram.html" class="tsd-kind-icon">Stake<wbr/>Program</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="web3.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.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.StakeProgram.html#createAccountWithSeed" class="tsd-kind-icon">create<wbr/>Account<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#deactivate" class="tsd-kind-icon">deactivate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#delegate" class="tsd-kind-icon">delegate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#initialize" class="tsd-kind-icon">initialize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#merge" class="tsd-kind-icon">merge</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#split" class="tsd-kind-icon">split</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.html#splitWithSeed" class="tsd-kind-icon">split<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.StakeProgram.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-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><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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-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> |