2022-02-28 08:37:44 -08:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>web3 | @project-serum/anchor - v0.22.1</title><meta name="description" content="Documentation for @project-serum/anchor - v0.22.1"/><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.22.1</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.22.1</a></li><li><a href="web3.html">web3</a></li></ul><h1>Namespace web3</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Account.html" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Authorized.html" class="tsd-kind-icon">Authorized</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.BpfLoader.html" class="tsd-kind-icon">Bpf<wbr/>Loader</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Connection.html" class="tsd-kind-icon">Connection</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Enum.html" class="tsd-kind-icon">Enum</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Keypair.html" class="tsd-kind-icon">Keypair</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Loader.html" class="tsd-kind-icon">Loader</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Lockup.html" class="tsd-kind-icon">Lockup</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Message.html" class="tsd-kind-icon">Message</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.NonceAccount.html" class="tsd-kind-icon">Nonce<wbr/>Account</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.PublicKey.html" class="tsd-kind-icon">Public
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Pair of an account address and its balance</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>address<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AccountChangeCallback" class="tsd-anchor"></a><h3>Account<wbr/>Change<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>Change<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>accountInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1146</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>accountInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for account change notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>accountInfo: <a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>context: <a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"><a id="AccountInfo" class="tsd-anchor"></a><h3>Account<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>Info<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">; </span>executable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1126</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Information describing an account</p>
|
|
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional data assigned to the account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>executable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p><code>true</code> if this account's data contains a loaded program</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Number of lamports assigned to the account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>owner<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Identifier of the program that owns the account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AccountMeta" class="tsd-anchor"></a><h3>Account<wbr/>Meta</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>Meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>isSigner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>isWritable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:289</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account metadata used to define instructions</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>is<wbr/>Signer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>True if an instruction requires a transaction signature matching <code>pubkey</code></p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>is<wbr/>Writable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>True if the <code>pubkey</code> can be loaded as a read-write account.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An account's public key</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AdvanceNonceParams" class="tsd-anchor"></a><h3>Advance<wbr/>Nonce<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Advance<wbr/>Nonce<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>noncePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2289</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Advance nonce account system instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the nonce authority</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Nonce account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AllocateParams" class="tsd-anchor"></a><h3>Allocate<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Allocate<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2322</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Allocate account system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account to allocate</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of space in bytes to allocate</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AllocateWithSeedParams" class="tsd-anchor"></a><h3>Allocate<wbr/>With<wbr/>Seed<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Allocate<wbr/>With<wbr/>Seed<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>basePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2331</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Allocate account with seed system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account to allocate</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>base<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Base public key to use to derive the address of the allocated account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the program to assign as the owner of the allocated account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Seed to use to derive the address of the allocated account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of space in bytes to allocate</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AssignParams" class="tsd-anchor"></a><h3>Assign<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Assign<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2222</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Assign system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the account which will be assigned a new owner</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the program to assign as the owner</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AssignWithSeedParams" class="tsd-anchor"></a><h3>Assign<wbr/>With<wbr/>Seed<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Assign<wbr/>With<wbr/>Seed<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>basePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2346</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Assign account with seed system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the account which will be assigned a new owner</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>base<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Base public key to use to derive the address of the assigned account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the program to assign as the owner</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Seed to use to derive the address of the assigned account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AuthorizeNonceParams" class="tsd-anchor"></a><h3>Authorize<wbr/>Nonce<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Authorize<wbr/>Nonce<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>newAuthorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>noncePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2311</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Authorize nonce account system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the current nonce authority</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>new<wbr/>Authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key to set as the new nonce authority</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Nonce account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AuthorizeStakeParams" class="tsd-anchor"></a><h3>Authorize<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Authorize<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>custodianPubkey<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>newAuthorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>stakeAuthorizationType<span class="tsd-signature-symbol">: </span><a href="web3.html#StakeAuthorizationType" class="tsd-signature-type" data-tsd-kind="Type alias">StakeAuthorizationType</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2007</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Authorize stake instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> custodian<wbr/>Pubkey<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>new<wbr/>Authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Authorization<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="web3.html#StakeAuthorizationType" class="tsd-signature-type" data-tsd-kind="Type alias">StakeAuthorizationType</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="AuthorizeWithSeedStakeParams" class="tsd-anchor"></a><h3>Authorize<wbr/>With<wbr/>Seed<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Authorize<wbr/>With<wbr/>Seed<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorityBase<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>authorityOwner<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>authoritySeed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>custodianPubkey<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>newAuthorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>stakeAuthorizationType<span class="tsd-signature-symbol">: </span><a href="web3.html#StakeAuthorizationType" class="tsd-signature-type" data-tsd-kind="Type alias">StakeAuthorizationType</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2017</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Authorize stake instruction params using a derived key</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authority<wbr/>Base<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>authority<wbr/>Owner<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>authority<wbr/>Seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> custodian<wbr/>Pubkey<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>new<wbr/>Authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Authorization<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="web3.html#StakeAuthorizationType" class="tsd-signature-type" data-tsd-kind="Type alias">StakeAuthorizationType</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="BlockResponse" class="tsd-anchor"></a><h3>Block<wbr/>Response</h3><div class="tsd-signature tsd-kind-icon">Block<wbr/>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>parentSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>previousBlockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>rewards<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>postBalance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rewardType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </spa
|
|
|
|
|
<p>A processed block fetched from the RPC API</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>block<wbr/>Time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the block was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash of this block</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>parent<wbr/>Slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Slot index of this block's parent</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>previous<wbr/>Blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash of this block's parent</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> rewards<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>postBalance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rewardType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Vector of block rewards</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a><span class="tsd-signature-symbol">; </span>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Vector of transactions with status meta and original message</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Blockhash" class="tsd-anchor"></a><h3>Blockhash</h3><div class="tsd-signature tsd-kind-icon">Blockhash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:120</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash as Base58 string.</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Cluster" class="tsd-anchor"></a><h3>Cluster</h3><div class="tsd-signature tsd-kind-icon">Cluster<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"devnet"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"testnet"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"mainnet-beta"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2714</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Commitment" class="tsd-anchor"></a><h3>Commitment</h3><div class="tsd-signature tsd-kind-icon">Commitment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"processed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"confirmed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"finalized"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"recent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"single"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"singleGossip"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"root"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"max"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:535</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The level of commitment desired when querying state</p>
|
|
|
|
|
<pre>
|
|
|
|
|
'processed': Query the most recent block which has reached 1 confirmation by the connected node
|
|
|
|
|
'confirmed': Query the most recent block which has reached 1 confirmation by the cluster
|
|
|
|
|
'finalized': Query the most recent block which has been finalized by the cluster
|
|
|
|
|
</pre></div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CompiledInnerInstruction" class="tsd-anchor"></a><h3>Compiled<wbr/>Inner<wbr/>Instruction</h3><div class="tsd-signature tsd-kind-icon">Compiled<wbr/>Inner<wbr/>Instruction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>instructions<span class="tsd-signature-symbol">: </span><a href="web3.html#CompiledInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">CompiledInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:719</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>instructions<span class="tsd-signature-symbol">: </span><a href="web3.html#CompiledInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">CompiledInstruction</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CompiledInstruction" class="tsd-anchor"></a><h3>Compiled<wbr/>Instruction</h3><div class="tsd-signature tsd-kind-icon">Compiled<wbr/>Instruction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accounts<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>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>programIdIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:236</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An instruction to execute by a program</p>
|
|
|
|
|
</div><dl class="tsd-comment-tags"><dt>property</dt><dd><p>{number} programIdIndex</p>
|
|
|
|
|
</dd><dt>property</dt><dd><p>{number[]} accounts</p>
|
|
|
|
|
</dd><dt>property</dt><dd><p>{string} data</p>
|
|
|
|
|
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Ordered indices into the transaction keys array indicating which accounts to pass to the program</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The program input data encoded as base 58</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Index into the transaction keys array indicating the program account that executes this instruction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmOptions" class="tsd-anchor"></a><h3>Confirm<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Confirm<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>preflightCommitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>skipPreflight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:496</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Options for confirming transactions</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>desired commitment level</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> preflight<wbr/>Commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>preflight commitment level</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip<wbr/>Preflight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>disable transaction verification step</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmedBlock" class="tsd-anchor"></a><h3>Confirmed<wbr/>Block</h3><div class="tsd-signature tsd-kind-icon">Confirmed<wbr/>Block<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>parentSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>previousBlockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>rewards<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>postBalance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rewardType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:880</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A ConfirmedBlock on the ledger</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>block<wbr/>Time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the block was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash of this block</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>parent<wbr/>Slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Slot index of this block's parent</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>previous<wbr/>Blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash of this block's parent</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> rewards<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>postBalance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rewardType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Vector of block rewards</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Vector of transactions and status metas</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmedBlockSignatures" class="tsd-anchor"></a><h3>Confirmed<wbr/>Block<wbr/>Signatures</h3><div class="tsd-signature tsd-kind-icon">Confirmed<wbr/>Block<wbr/>Signatures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>parentSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>previousBlockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:905</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A ConfirmedBlock on the ledger with signatures only</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>block<wbr/>Time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the block was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash of this block</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>parent<wbr/>Slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Slot index of this block's parent</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>previous<wbr/>Blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Blockhash of this block's parent</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Vector of signatures</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmedSignatureInfo" class="tsd-anchor"></a><h3>Confirmed<wbr/>Signature<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Confirmed<wbr/>Signature<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1257</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A confirmed signature with its status</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr/>Time<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>error, if any</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>memo associated with the transaction, if any</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>the transaction signature</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>when the transaction was processed</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmedSignaturesForAddress2Options" class="tsd-anchor"></a><h3>Confirmed<wbr/>Signatures<wbr/>For<wbr/>Address2<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Confirmed<wbr/>Signatures<wbr/>For<wbr/>Address2<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>before<span class="tsd-signature-symbol">?: </span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>until<span class="tsd-signature-symbol">?: </span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:507</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Options for getConfirmedSignaturesForAddress2</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> before<span class="tsd-signature-symbol">?: </span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Start searching backwards from this transaction signature.</p>
|
|
|
|
|
</div><dl class="tsd-comment-tags"><dt>remark</dt><dd><p>If not provided the search starts from the highest max confirmed block.</p>
|
|
|
|
|
</dd></dl></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Maximum transaction signatures to return (between 1 and 1,000, default: 1,000).</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> until<span class="tsd-signature-symbol">?: </span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Search until this transaction signature is reached, if found before <code>limit</code>.</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmedTransaction" class="tsd-anchor"></a><h3>Confirmed<wbr/>Transaction</h3><div class="tsd-signature tsd-kind-icon">Confirmed<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:765</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A confirmed transaction on the ledger</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr/>Time<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Metadata produced from the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The slot during which the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>transaction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The details of the transaction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConfirmedTransactionMeta" class="tsd-anchor"></a><h3>Confirmed<wbr/>Transaction<wbr/>Meta</h3><div class="tsd-signature tsd-kind-icon">Confirmed<wbr/>Transaction<wbr/>Meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>innerInstructions<span class="tsd-signature-symbol">?: </span><a href="web3.html#CompiledInnerInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">CompiledInnerInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>logMessages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>postBalances<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>postTokenBalances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>preBalances<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>preTokenBalances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:726</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Metadata for a confirmed transaction on the ledger</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The error result of transaction processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The fee charged for processing the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> inner<wbr/>Instructions<span class="tsd-signature-symbol">?: </span><a href="web3.html#CompiledInnerInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">CompiledInnerInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An array of cross program invoked instructions</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr/>Messages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An array of program log messages emitted during a transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>post<wbr/>Balances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The balances of the transaction accounts after processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr/>Token<wbr/>Balances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The token balances of the transaction accounts after processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>pre<wbr/>Balances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The balances of the transaction accounts before processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> pre<wbr/>Token<wbr/>Balances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The token balances of the transaction accounts before processing</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ConnectionConfig" class="tsd-anchor"></a><h3>Connection<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Connection<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>disableRetryOnRateLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fetchMiddleware<span class="tsd-signature-symbol">?: </span><a href="web3.html#FetchMiddleware" class="tsd-signature-type" data-tsd-kind="Type alias">FetchMiddleware</a><span class="tsd-signature-symbol">; </span>httpHeaders<span class="tsd-signature-symbol">?: </span><a href="web3.html#HttpHeaders" class="tsd-signature-type" data-tsd-kind="Type alias">HttpHeaders</a><span class="tsd-signature-symbol">; </span>wsEndpoint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1286</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Configuration for instantiating a Connection</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional commitment level</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> disable<wbr/>Retry<wbr/>On<wbr/>Rate<wbr/>Limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional Disable retring calls when server responds with HTTP 429 (Too Many Requests)</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> fetch<wbr/>Middleware<span class="tsd-signature-symbol">?: </span><a href="web3.html#FetchMiddleware" class="tsd-signature-type" data-tsd-kind="Type alias">FetchMiddleware</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional fetch middleware callback</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> http<wbr/>Headers<span class="tsd-signature-symbol">?: </span><a href="web3.html#HttpHeaders" class="tsd-signature-type" data-tsd-kind="Type alias">HttpHeaders</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional HTTP headers object</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ws<wbr/>Endpoint<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional endpoint URL to the fullnode JSON RPC PubSub WebSocket Endpoint</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ContactInfo" class="tsd-anchor"></a><h3>Contact<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Contact<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>gossip<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>tpu<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:579</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Information describing a cluster node</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>gossip<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Gossip network address for the node</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Identity public key of the node</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>rpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>JSON RPC network address for the node (null if not available)</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>tpu<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>TPU network address for the node (null if not available)</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Software version of the node (null if not available)</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Context" class="tsd-anchor"></a><h3>Context</h3><div class="tsd-signature tsd-kind-icon">Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:481</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Extra contextual information for RPC responses</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateAccountParams" class="tsd-anchor"></a><h3>Create<wbr/>Account<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Account<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>newAccountPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2196</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Create account system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The account that will transfer lamports to the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to transfer to the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>new<wbr/>Account<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the program to assign as the owner of the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of space in bytes to allocate to the created account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateAccountWithSeedParams" class="tsd-anchor"></a><h3>Create<wbr/>Account<wbr/>With<wbr/>Seed<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Account<wbr/>With<wbr/>Seed<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>basePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>newAccountPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2231</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Create account with seed system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>base<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Base public key to use to derive the address of the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The account that will transfer lamports to the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to transfer to the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>new<wbr/>Account<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the program to assign as the owner of the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Seed to use to derive the address of the created account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of space in bytes to allocate to the created account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateNonceAccountParams" class="tsd-anchor"></a><h3>Create<wbr/>Nonce<wbr/>Account<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Nonce<wbr/>Account<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>noncePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2250</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Create nonce account system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key to set as authority of the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The account that will transfer lamports to the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to transfer to the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the created nonce account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateNonceAccountWithSeedParams" class="tsd-anchor"></a><h3>Create<wbr/>Nonce<wbr/>Account<wbr/>With<wbr/>Seed<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Nonce<wbr/>Account<wbr/>With<wbr/>Seed<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>basePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>noncePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2263</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Create nonce account with seed system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key to set as authority of the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>base<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Base public key to use to derive the address of the nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The account that will transfer lamports to the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to transfer to the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the created nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Seed to use to derive the address of the nonce account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateSecp256k1InstructionWithEthAddressParams" class="tsd-anchor"></a><h3>Create<wbr/>Secp256k1<wbr/>Instruction<wbr/>With<wbr/>Eth<wbr/>Address<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Secp256k1<wbr/>Instruction<wbr/>With<wbr/>Eth<wbr/>Address<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ethAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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>recoveryId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2542</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Params for creating an secp256k1 instruction using an Ethereum address</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>eth<wbr/>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>recovery<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateSecp256k1InstructionWithPrivateKeyParams" class="tsd-anchor"></a><h3>Create<wbr/>Secp256k1<wbr/>Instruction<wbr/>With<wbr/>Private<wbr/>Key<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Secp256k1<wbr/>Instruction<wbr/>With<wbr/>Private<wbr/>Key<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2551</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Params for creating an secp256k1 instruction using a private key</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>private<wbr/>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateSecp256k1InstructionWithPublicKeyParams" class="tsd-anchor"></a><h3>Create<wbr/>Secp256k1<wbr/>Instruction<wbr/>With<wbr/>Public<wbr/>Key<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Secp256k1<wbr/>Instruction<wbr/>With<wbr/>Public<wbr/>Key<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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>recoveryId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2533</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Params for creating an secp256k1 instruction using a public key</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>public<wbr/>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>recovery<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateStakeAccountParams" class="tsd-anchor"></a><h3>Create<wbr/>Stake<wbr/>Account<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Stake<wbr/>Account<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorized<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Authorized.html" class="tsd-signature-type" data-tsd-kind="Class">Authorized</a><span class="tsd-signature-symbol">; </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>lockup<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.Lockup.html" class="tsd-signature-type" data-tsd-kind="Class">Lockup</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1964</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Create stake account transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Authorized.html" class="tsd-signature-type" data-tsd-kind="Class">Authorized</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Authorities of the new stake account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Address of the account which will fund creation</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Funding amount</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> lockup<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.Lockup.html" class="tsd-signature-type" data-tsd-kind="Class">Lockup</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Lockup of the new stake account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Address of the new stake account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="CreateStakeAccountWithSeedParams" class="tsd-anchor"></a><h3>Create<wbr/>Stake<wbr/>Account<wbr/>With<wbr/>Seed<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Create<wbr/>Stake<wbr/>Account<wbr/>With<wbr/>Seed<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorized<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Authorized.html" class="tsd-signature-type" data-tsd-kind="Class">Authorized</a><span class="tsd-signature-symbol">; </span>basePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>lockup<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.Lockup.html" class="tsd-signature-type" data-tsd-kind="Class">Lockup</a><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1979</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Create stake account with seed transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Authorized.html" class="tsd-signature-type" data-tsd-kind="Class">Authorized</a></h5></li><li class="tsd-parameter"><h5>base<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> lockup<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.Lockup.html" class="tsd-signature-type" data-tsd-kind="Class">Lockup</a></h5></li><li class="tsd-parameter"><h5>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="DataSizeFilter" class="tsd-anchor"></a><h3>Data<wbr/>Size<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">Data<wbr/>Size<wbr/>Filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>dataSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1093</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Data size comparison filter for getProgramAccounts</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>data<wbr/>Size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Size of data for program account data length comparison</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="DataSlice" class="tsd-anchor"></a><h3>Data<wbr/>Slice</h3><div class="tsd-signature tsd-kind-icon">Data<wbr/>Slice<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1073</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Data slice argument for getProgramAccounts</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>length of data slice</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>offset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>offset of data slice</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="DeactivateStakeParams" class="tsd-anchor"></a><h3>Deactivate<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Deactivate<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2048</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Deactivate stake instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="DelegateStakeParams" class="tsd-anchor"></a><h3>Delegate<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Delegate<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>votePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1999</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Delegate stake instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>vote<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="EpochCredits" class="tsd-anchor"></a><h3>Epoch<wbr/>Credits</h3><div class="tsd-signature tsd-kind-icon">Epoch<wbr/>Credits<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>credits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>prevCredits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2643</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>History of how many credits earned by the end of each epoch</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>credits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>prev<wbr/>Credits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="EpochInfo" class="tsd-anchor"></a><h3>Epoch<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Epoch<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>absoluteSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>blockHeight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slotIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slotsInEpoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>transactionCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:646</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Information about the current epoch</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>absolute<wbr/>Slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr/>Height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>slot<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>slots<wbr/>In<wbr/>Epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> transaction<wbr/>Count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="EpochSchedule" class="tsd-anchor"></a><h3>Epoch<wbr/>Schedule</h3><div class="tsd-signature tsd-kind-icon">Epoch<wbr/>Schedule<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>firstNormalEpoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firstNormalSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>leaderScheduleSlotOffset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slotsPerEpoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>warmup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:658</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Epoch schedule
|
|
|
|
|
(see <a href="https://docs.solana.com/terminology#epoch">https://docs.solana.com/terminology#epoch</a>)</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>first<wbr/>Normal<wbr/>Epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The first epoch with <code>slotsPerEpoch</code> slots</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>first<wbr/>Normal<wbr/>Slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The first slot of <code>firstNormalEpoch</code></p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>leader<wbr/>Schedule<wbr/>Slot<wbr/>Offset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The number of slots before beginning of an epoch to calculate a leader schedule for that epoch</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slots<wbr/>Per<wbr/>Epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The maximum number of slots in each epoch</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>warmup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Indicates whether epochs start short and grow</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="FetchMiddleware" class="tsd-anchor"></a><h3>Fetch<wbr/>Middleware</h3><div class="tsd-signature tsd-kind-icon">Fetch<wbr/>Middleware<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fetch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1278</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fetch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A callback used to augment the outgoing HTTP request</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li><li><h5>options: <span class="tsd-signature-type">any</span></h5></li><li><h5>fetch: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Finality" class="tsd-anchor"></a><h3>Finality</h3><div class="tsd-signature tsd-kind-icon">Finality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"confirmed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"finalized"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:551</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A subset of Commitment levels, which are at least optimistically confirmed</p>
|
|
|
|
|
<pre>
|
|
|
|
|
'confirmed': Query the most recent block which has reached 1 confirmation by the cluster
|
|
|
|
|
'finalized': Query the most recent block which has been finalized by the cluster
|
|
|
|
|
</pre></div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="GetLargestAccountsConfig" class="tsd-anchor"></a><h3>Get<wbr/>Largest<wbr/>Accounts<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Get<wbr/>Largest<wbr/>Accounts<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>filter<span class="tsd-signature-symbol">?: </span><a href="web3.html#LargestAccountsFilter" class="tsd-signature-type" data-tsd-kind="Type alias">LargestAccountsFilter</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:563</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Configuration object for changing <code>getLargestAccounts</code> query behavior</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The level of commitment desired</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> filter<span class="tsd-signature-symbol">?: </span><a href="web3.html#LargestAccountsFilter" class="tsd-signature-type" data-tsd-kind="Type alias">LargestAccountsFilter</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Filter largest accounts by whether they are part of the circulating supply</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="GetParsedProgramAccountsConfig" class="tsd-anchor"></a><h3>Get<wbr/>Parsed<wbr/>Program<wbr/>Accounts<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Get<wbr/>Parsed<wbr/>Program<wbr/>Accounts<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>filters<span class="tsd-signature-symbol">?: </span><a href="web3.html#GetProgramAccountsFilter" class="tsd-signature-type" data-tsd-kind="Type alias">GetProgramAccountsFilter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1117</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Configuration object for getParsedProgramAccounts</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional commitment level</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> filters<span class="tsd-signature-symbol">?: </span><a href="web3.html#GetProgramAccountsFilter" class="tsd-signature-type" data-tsd-kind="Type alias">GetProgramAccountsFilter</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional array of filters to apply to accounts</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="GetProgramAccountsConfig" class="tsd-anchor"></a><h3>Get<wbr/>Program<wbr/>Accounts<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Get<wbr/>Program<wbr/>Accounts<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>dataSlice<span class="tsd-signature-symbol">?: </span><a href="web3.html#DataSlice" class="tsd-signature-type" data-tsd-kind="Type alias">DataSlice</a><span class="tsd-signature-symbol">; </span>encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"base64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"jsonParsed"</span><span class="tsd-signature-symbol">; </span>filters<span class="tsd-signature-symbol">?: </span><a href="web3.html#GetProgramAccountsFilter" class="tsd-signature-type" data-tsd-kind="Type alias">GetProgramAccountsFilter</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1104</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Configuration object for getProgramAccounts requests</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional commitment level</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> data<wbr/>Slice<span class="tsd-signature-symbol">?: </span><a href="web3.html#DataSlice" class="tsd-signature-type" data-tsd-kind="Type alias">DataSlice</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional data slice to limit the returned account data</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"base64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"jsonParsed"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional encoding for account data (default base64)</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> filters<span class="tsd-signature-symbol">?: </span><a href="web3.html#GetProgramAccountsFilter" class="tsd-signature-type" data-tsd-kind="Type alias">GetProgramAccountsFilter</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional array of filters to apply to accounts</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="GetProgramAccountsFilter" class="tsd-anchor"></a><h3>Get<wbr/>Program<wbr/>Accounts<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">Get<wbr/>Program<wbr/>Accounts<wbr/>Filter<span class="tsd-signature-symbol">:</span> <a href="web3.html#MemcmpFilter" class="tsd-signature-type" data-tsd-kind="Type alias">MemcmpFilter</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#DataSizeFilter" class="tsd-signature-type" data-tsd-kind="Type alias">DataSizeFilter</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1100</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A filter object for getProgramAccounts</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="HttpHeaders" class="tsd-anchor"></a><h3>Http<wbr/>Headers</h3><div class="tsd-signature tsd-kind-icon">Http<wbr/>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1272</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An object defining headers to be passed to the RPC server</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>header: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="InflationGovernor" class="tsd-anchor"></a><h3>Inflation<wbr/>Governor</h3><div class="tsd-signature tsd-kind-icon">Inflation<wbr/>Governor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>foundation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>foundationTerm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initial<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>taper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>terminal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:623</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Network Inflation
|
|
|
|
|
(see <a href="https://docs.solana.com/implemented-proposals/ed_overview">https://docs.solana.com/implemented-proposals/ed_overview</a>)</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>foundation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>foundation<wbr/>Term<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>initial<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>taper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>terminal<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="InflationReward" class="tsd-anchor"></a><h3>Inflation<wbr/>Reward</h3><div class="tsd-signature tsd-kind-icon">Inflation<wbr/>Reward<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>effectiveSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>postBalance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:633</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The inflation reward for an epoch</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>reward amount in lamports</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>effective<wbr/>Slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>the slot in which the rewards are effective</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>epoch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>epoch for which the reward occurs</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>post<wbr/>Balance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>post balance of the account in lamports</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Info" class="tsd-anchor"></a><h3>Info</h3><div class="tsd-signature tsd-kind-icon">Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>details<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keybaseUsername<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>website<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2594</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Info used to identity validators.</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> details<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>optional, extra information the validator chose to share</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> keybase<wbr/>Username<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>optional, used to identify validators on keybase.io</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>validator name</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> website<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>optional, validator website</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="InitializeNonceParams" class="tsd-anchor"></a><h3>Initialize<wbr/>Nonce<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Initialize<wbr/>Nonce<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>noncePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2280</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Initialize nonce account system instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key to set as authority of the initialized nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Nonce account which will be initialized</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="InitializeStakeParams" class="tsd-anchor"></a><h3>Initialize<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Initialize<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorized<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Authorized.html" class="tsd-signature-type" data-tsd-kind="Class">Authorized</a><span class="tsd-signature-symbol">; </span>lockup<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.Lockup.html" class="tsd-signature-type" data-tsd-kind="Class">Lockup</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1991</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Initialize stake instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Authorized.html" class="tsd-signature-type" data-tsd-kind="Class">Authorized</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> lockup<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.Lockup.html" class="tsd-signature-type" data-tsd-kind="Class">Lockup</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="KeyedAccountInfo" class="tsd-anchor"></a><h3>Keyed<wbr/>Account<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Keyed<wbr/>Account<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>accountInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1139</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account information identified by pubkey</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>account<wbr/>Info<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="LargestAccountsFilter" class="tsd-anchor"></a><h3>Largest<wbr/>Accounts<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">Largest<wbr/>Accounts<wbr/>Filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"circulating"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"nonCirculating"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:559</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Filter for largest accounts query</p>
|
|
|
|
|
<pre>
|
|
|
|
|
'circulating': Return the largest accounts that are part of the circulating supply
|
|
|
|
|
'nonCirculating': Return the largest accounts that are not part of the circulating supply
|
|
|
|
|
</pre></div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="LeaderSchedule" class="tsd-anchor"></a><h3>Leader<wbr/>Schedule</h3><div class="tsd-signature tsd-kind-icon">Leader<wbr/>Schedule<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:674</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Leader schedule
|
|
|
|
|
(see <a href="https://docs.solana.com/terminology#leader-schedule">https://docs.solana.com/terminology#leader-schedule</a>)</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Lockout" class="tsd-anchor"></a><h3>Lockout</h3><div class="tsd-signature tsd-kind-icon">Lockout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>confirmationCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2636</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>confirmation<wbr/>Count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Logs" class="tsd-anchor"></a><h3>Logs</h3><div class="tsd-signature tsd-kind-icon">Logs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>logs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1206</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Logs result.</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li><li class="tsd-parameter"><h5>logs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="LogsCallback" class="tsd-anchor"></a><h3>Logs<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Logs<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="web3.html#Logs" class="tsd-signature-type" data-tsd-kind="Type alias">Logs</a>, ctx<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1218</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>logs<span class="tsd-signature-symbol">: </span><a href="web3.html#Logs" class="tsd-signature-type" data-tsd-kind="Type alias">Logs</a>, ctx<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for log notifications.</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>logs: <a href="web3.html#Logs" class="tsd-signature-type" data-tsd-kind="Type alias">Logs</a></h5></li><li><h5>ctx: <a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="LogsFilter" class="tsd-anchor"></a><h3>Logs<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">Logs<wbr/>Filter<span class="tsd-signature-symbol">:</span> <a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"allWithVotes"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1214</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Filter for log subscriptions.</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="MemcmpFilter" class="tsd-anchor"></a><h3>Memcmp<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">Memcmp<wbr/>Filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>memcmp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>offset<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></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1082</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Memory comparison filter for getProgramAccounts</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>memcmp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>offset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>data to match, as base-58 encoded string and limited to less than 129 bytes</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>offset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>offset into program account data to start comparison</p>
|
|
|
|
|
</div></div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="MessageArgs" class="tsd-anchor"></a><h3>Message<wbr/>Args</h3><div class="tsd-signature tsd-kind-icon">Message<wbr/>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountKeys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>header<span class="tsd-signature-symbol">: </span><a href="web3.html#MessageHeader" class="tsd-signature-type" data-tsd-kind="Type alias">MessageHeader</a><span class="tsd-signature-symbol">; </span>instructions<span class="tsd-signature-symbol">: </span><a href="web3.html#CompiledInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">CompiledInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>recentBlockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:247</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Message constructor arguments</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>All the account keys used by this transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>header<span class="tsd-signature-symbol">: </span><a href="web3.html#MessageHeader" class="tsd-signature-type" data-tsd-kind="Type alias">MessageHeader</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The message header, identifying signed and read-only <code>accountKeys</code></p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>instructions<span class="tsd-signature-symbol">: </span><a href="web3.html#CompiledInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">CompiledInstruction</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Instructions that will be executed in sequence and committed in one atomic transaction if all succeed.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>recent<wbr/>Blockhash<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The hash of a recent ledger block</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="MessageHeader" class="tsd-anchor"></a><h3>Message<wbr/>Header</h3><div class="tsd-signature tsd-kind-icon">Message<wbr/>Header<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>numReadonlySignedAccounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>numReadonlyUnsignedAccounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>numRequiredSignatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:218</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The message header, identifying signed and read-only account</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>num<wbr/>Readonly<wbr/>Signed<wbr/>Accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The last <code>numReadonlySignedAccounts</code> of the signed keys are read-only accounts</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>num<wbr/>Readonly<wbr/>Unsigned<wbr/>Accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The last <code>numReadonlySignedAccounts</code> of the unsigned keys are read-only accounts</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>num<wbr/>Required<wbr/>Signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The number of signatures required for this message to be considered valid. The
|
|
|
|
|
signatures must match the first <code>numRequiredSignatures</code> of <code>accountKeys</code>.</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="NonceInformation" class="tsd-anchor"></a><h3>Nonce<wbr/>Information</h3><div class="tsd-signature tsd-kind-icon">Nonce<wbr/>Information<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>nonce<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol">; </span>nonceInstruction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:357</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Nonce information to be used to build an offline Transaction.</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>nonce<span class="tsd-signature-symbol">: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The current blockhash stored in the nonce</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Instruction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>AdvanceNonceAccount Instruction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedAccountData" class="tsd-anchor"></a><h3>Parsed<wbr/>Account<wbr/>Data</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Account<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>parsed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>program<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1051</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Parsed account data</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>parsed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Parsed account data</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Name of the program that owns this account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>space<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Space used by account data</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedConfirmedTransaction" class="tsd-anchor"></a><h3>Parsed<wbr/>Confirmed<wbr/>Transaction</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Confirmed<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedTransaction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedTransaction</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:831</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A parsed and confirmed transaction on the ledger</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr/>Time<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Metadata produced from the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The slot during which the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>transaction<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedTransaction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedTransaction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The details of the transaction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedConfirmedTransactionMeta" class="tsd-anchor"></a><h3>Parsed<wbr/>Confirmed<wbr/>Transaction<wbr/>Meta</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Confirmed<wbr/>Transaction<wbr/>Meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>innerInstructions<span class="tsd-signature-symbol">?: </span><a href="web3.html#ParsedInnerInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedInnerInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>logMessages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>postBalances<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>postTokenBalances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>preBalances<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>preTokenBalances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:701</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Metadata for a parsed confirmed transaction on the ledger</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The error result of transaction processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The fee charged for processing the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> inner<wbr/>Instructions<span class="tsd-signature-symbol">?: </span><a href="web3.html#ParsedInnerInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedInnerInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An array of cross program invoked parsed instructions</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> log<wbr/>Messages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An array of program log messages emitted during a transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>post<wbr/>Balances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The balances of the transaction accounts after processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr/>Token<wbr/>Balances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The token balances of the transaction accounts after processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>pre<wbr/>Balances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The balances of the transaction accounts before processing</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> pre<wbr/>Token<wbr/>Balances<span class="tsd-signature-symbol">?: </span><a href="web3.html#TokenBalance" class="tsd-signature-type" data-tsd-kind="Type alias">TokenBalance</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The token balances of the transaction accounts before processing</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedInnerInstruction" class="tsd-anchor"></a><h3>Parsed<wbr/>Inner<wbr/>Instruction</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Inner<wbr/>Instruction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>instructions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="web3.html#ParsedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedInstruction</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#PartiallyDecodedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">PartiallyDecodedInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:689</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>instructions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="web3.html#ParsedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedInstruction</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#PartiallyDecodedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">PartiallyDecodedInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedInstruction" class="tsd-anchor"></a><h3>Parsed<wbr/>Instruction</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Instruction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>parsed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>program<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:800</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A parsed transaction instruction</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>parsed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Parsed instruction info</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Name of the program for this instruction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>ID of the program for this instruction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedMessage" class="tsd-anchor"></a><h3>Parsed<wbr/>Message</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountKeys<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedMessageAccount" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedMessageAccount</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>instructions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="web3.html#ParsedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedInstruction</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#PartiallyDecodedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">PartiallyDecodedInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>recentBlockhash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:811</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A parsed transaction message</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Keys<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedMessageAccount" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedMessageAccount</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Accounts used in the instructions</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>instructions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="web3.html#ParsedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedInstruction</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#PartiallyDecodedInstruction" class="tsd-signature-type" data-tsd-kind="Type alias">PartiallyDecodedInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The atomically executed instructions for the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>recent<wbr/>Blockhash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Recent blockhash</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedMessageAccount" class="tsd-anchor"></a><h3>Parsed<wbr/>Message<wbr/>Account</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Message<wbr/>Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>signer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>writable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:789</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A parsed transaction message account</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>signer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Indicates if the account signed the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>writable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Indicates if the account is writable for this transaction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ParsedTransaction" class="tsd-anchor"></a><h3>Parsed<wbr/>Transaction</h3><div class="tsd-signature tsd-kind-icon">Parsed<wbr/>Transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedMessage" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedMessage</a><span class="tsd-signature-symbol">; </span>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:822</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A parsed transaction</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><a href="web3.html#ParsedMessage" class="tsd-signature-type" data-tsd-kind="Type alias">ParsedMessage</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Message of the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Signatures for the transaction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="PartiallyDecodedInstruction" class="tsd-anchor"></a><h3>Partially<wbr/>Decoded<wbr/>Instruction</h3><div class="tsd-signature tsd-kind-icon">Partially<wbr/>Decoded<wbr/>Instruction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:778</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A partially decoded transaction instruction</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>accounts<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public keys of accounts passed to this instruction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Raw base-58 instruction data</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Program id called by this instruction</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="PerfSample" class="tsd-anchor"></a><h3>Perf<wbr/>Sample</h3><div class="tsd-signature tsd-kind-icon">Perf<wbr/>Sample<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>numSlots<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>numTransactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>samplePeriodSecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:920</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A performance sample</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>num<wbr/>Slots<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Number of slots in a sample window</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>num<wbr/>Transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Number of transactions in a sample window</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>sample<wbr/>Period<wbr/>Secs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Sample window in seconds</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Slot number of sample</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="ProgramAccountChangeCallback" class="tsd-anchor"></a><h3>Program<wbr/>Account<wbr/>Change<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Program<wbr/>Account<wbr/>Change<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>keyedAccountInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#KeyedAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">KeyedAccountInfo</a>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1153</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>keyedAccountInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#KeyedAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">KeyedAccountInfo</a>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for program account change notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>keyedAccountInfo: <a href="web3.html#KeyedAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">KeyedAccountInfo</a></h5></li><li><h5>context: <a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="PublicKeyData" class="tsd-anchor"></a><h3>Public<wbr/>Key<wbr/>Data</h3><div class="tsd-signature tsd-kind-icon">Public<wbr/>Key<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:26</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="PublicKeyInitData" class="tsd-anchor"></a><h3>Public<wbr/>Key<wbr/>Init<wbr/>Data</h3><div class="tsd-signature tsd-kind-icon">Public<wbr/>Key<wbr/>Init<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><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.html#PublicKeyData" class="tsd-signature-type" data-tsd-kind="Type alias">PublicKeyData</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:19</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="RootChangeCallback" class="tsd-anchor"></a><h3>Root<wbr/>Change<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Root<wbr/>Change<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>root<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><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1202</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>root<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for root change notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>root: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-has-type-parameter tsd-is-external"><a id="RpcResponseAndContext" class="tsd-anchor"></a><h3>Rpc<wbr/>Response<wbr/>And<wbr/>Context</h3><div class="tsd-signature tsd-kind-icon">Rpc<wbr/>Response<wbr/>And<wbr/>Context<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:521</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>RPC Response with extra contextual information</p>
|
|
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>response context</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>response value</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SendOptions" class="tsd-anchor"></a><h3>Send<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Send<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>preflightCommitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>skipPreflight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:487</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Options for sending transactions</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> preflight<wbr/>Commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>preflight commitment level</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip<wbr/>Preflight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>disable transaction verification step</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SerializeConfig" class="tsd-anchor"></a><h3>Serialize<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Serialize<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>requireAllSignatures<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>verifySignatures<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:308</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Configuration object for Transaction.serialize()</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> require<wbr/>All<wbr/>Signatures<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Require all transaction signatures be present (default: true)</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> verify<wbr/>Signatures<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Verify provided signatures (default: true)</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignaturePubkeyPair" class="tsd-anchor"></a><h3>Signature<wbr/>Pubkey<wbr/>Pair</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Pubkey<wbr/>Pair<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>publicKey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:336</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Pair of signature and corresponding public key</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>public<wbr/>Key<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureReceivedNotification" class="tsd-anchor"></a><h3>Signature<wbr/>Received<wbr/>Notification</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Received<wbr/>Notification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"received"</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1182</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Signature received notification</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"received"</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureResult" class="tsd-anchor"></a><h3>Signature<wbr/>Result</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1222</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Signature result</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureResultCallback" class="tsd-anchor"></a><h3>Signature<wbr/>Result<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Result<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>signatureResult<span class="tsd-signature-symbol">: </span><a href="web3.html#SignatureResult" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureResult</a>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1168</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>signatureResult<span class="tsd-signature-symbol">: </span><a href="web3.html#SignatureResult" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureResult</a>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for signature status notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>signatureResult: <a href="web3.html#SignatureResult" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureResult</a></h5></li><li><h5>context: <a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureStatus" class="tsd-anchor"></a><h3>Signature<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>confirmationStatus<span class="tsd-signature-symbol">?: </span><a href="web3.html#TransactionConfirmationStatus" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionConfirmationStatus</a><span class="tsd-signature-symbol">; </span>confirmations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1244</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Signature status</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> confirmation<wbr/>Status<span class="tsd-signature-symbol">?: </span><a href="web3.html#TransactionConfirmationStatus" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionConfirmationStatus</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>cluster confirmation status, if data available. Possible responses: <code>processed</code>, <code>confirmed</code>, <code>finalized</code></p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>confirmations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>the number of blocks that have been confirmed and voted on in the fork containing <code>slot</code></p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>transaction error, if any</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>when the transaction was processed</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureStatusConfig" class="tsd-anchor"></a><h3>Signature<wbr/>Status<wbr/>Config</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Status<wbr/>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>searchTransactionHistory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:572</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Configuration object for changing query behavior</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>search<wbr/>Transaction<wbr/>History<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>enable searching status history, not needed for recent transactions</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureStatusNotification" class="tsd-anchor"></a><h3>Signature<wbr/>Status<wbr/>Notification</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Status<wbr/>Notification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>result<span class="tsd-signature-symbol">: </span><a href="web3.html#SignatureResult" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureResult</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"status"</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1175</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Signature status notification with transaction result</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>result<span class="tsd-signature-symbol">: </span><a href="web3.html#SignatureResult" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureResult</a></h5></li><li class="tsd-parameter"><h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"status"</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureSubscriptionCallback" class="tsd-anchor"></a><h3>Signature<wbr/>Subscription<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Subscription<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="web3.html#SignatureStatusNotification" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureStatusNotification</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#SignatureReceivedNotification" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureReceivedNotification</a>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1188</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="web3.html#SignatureStatusNotification" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureStatusNotification</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#SignatureReceivedNotification" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureReceivedNotification</a>, context<span class="tsd-signature-symbol">: </span><a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for signature notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>notification: <a href="web3.html#SignatureStatusNotification" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureStatusNotification</a><span class="tsd-signature-symbol"> | </span><a href="web3.html#SignatureReceivedNotification" class="tsd-signature-type" data-tsd-kind="Type alias">SignatureReceivedNotification</a></h5></li><li><h5>context: <a href="web3.html" class="tsd-signature-type" data-tsd-kind="Namespace">web3</a><span class="tsd-signature-symbol">.</span><a href="web3.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SignatureSubscriptionOptions" class="tsd-anchor"></a><h3>Signature<wbr/>Subscription<wbr/>Options</h3><div class="tsd-signature tsd-kind-icon">Signature<wbr/>Subscription<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">; </span>enableReceivedNotification<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1195</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Signature subscription options</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Received<wbr/>Notification<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SimulatedTransactionResponse" class="tsd-anchor"></a><h3>Simulated<wbr/>Transaction<wbr/>Response</h3><div class="tsd-signature tsd-kind-icon">Simulated<wbr/>Transaction<wbr/>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>logs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:685</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>err<span class="tsd-signature-symbol">: </span><a href="web3.html#TransactionError" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li><li class="tsd-parameter"><h5>logs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SlotChangeCallback" class="tsd-anchor"></a><h3>Slot<wbr/>Change<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Slot<wbr/>Change<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>slotInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#SlotInfo" class="tsd-signature-type" data-tsd-kind="Type alias">SlotInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1160</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>slotInfo<span class="tsd-signature-symbol">: </span><a href="web3.html#SlotInfo" class="tsd-signature-type" data-tsd-kind="Type alias">SlotInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for slot change notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>slotInfo: <a href="web3.html#SlotInfo" class="tsd-signature-type" data-tsd-kind="Type alias">SlotInfo</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SlotInfo" class="tsd-anchor"></a><h3>Slot<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Slot<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1040</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Information about the latest slot being processed by a node</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Parent of the current slot</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The root block of the current slot's fork</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Currently processing slot</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SlotUpdate" class="tsd-anchor"></a><h3>Slot<wbr/>Update</h3><div class="tsd-signature tsd-kind-icon">Slot<wbr/>Update<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"firstShredReceived"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"completed"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"createdBank"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>stats<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>maxTransactionsPerEntry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>numFailedTransactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>numSuccessfulTransactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>numTransactionEntries<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>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"frozen"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"dead"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number
|
|
|
|
|
<p>Slot updates which can be used for tracking the live progress of a cluster.</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><code>"firstShredReceived"</code>: connected node received the first shred of a block.
|
|
|
|
|
Indicates that a new block that is being produced.</li>
|
|
|
|
|
<li><code>"completed"</code>: connected node has received all shreds of a block. Indicates
|
|
|
|
|
a block was recently produced.</li>
|
|
|
|
|
<li><code>"optimisticConfirmation"</code>: block was optimistically confirmed by the
|
|
|
|
|
cluster. It is not guaranteed that an optimistic confirmation notification
|
|
|
|
|
will be sent for every finalized blocks.</li>
|
|
|
|
|
<li><code>"root"</code>: the connected node rooted this block.</li>
|
|
|
|
|
<li><code>"createdBank"</code>: the connected node has started validating this block.</li>
|
|
|
|
|
<li><code>"frozen"</code>: the connected node has validated this block.</li>
|
|
|
|
|
<li><code>"dead"</code>: the connected node failed to validate this block.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SlotUpdateCallback" class="tsd-anchor"></a><h3>Slot<wbr/>Update<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Slot<wbr/>Update<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>slotUpdate<span class="tsd-signature-symbol">: </span><a href="web3.html#SlotUpdate" class="tsd-signature-type" data-tsd-kind="Type alias">SlotUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1164</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>slotUpdate<span class="tsd-signature-symbol">: </span><a href="web3.html#SlotUpdate" class="tsd-signature-type" data-tsd-kind="Type alias">SlotUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Callback function for slot update notifications</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>slotUpdate: <a href="web3.html#SlotUpdate" class="tsd-signature-type" data-tsd-kind="Type alias">SlotUpdate</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SplitStakeParams" class="tsd-anchor"></a><h3>Split<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Split<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>splitStakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2029</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Split stake instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>split<wbr/>Stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="StakeActivationData" class="tsd-anchor"></a><h3>Stake<wbr/>Activation<wbr/>Data</h3><div class="tsd-signature tsd-kind-icon">Stake<wbr/>Activation<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>inactive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"active"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inactive"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"activating"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deactivating"</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1062</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Stake Activation data</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>stake active during the epoch</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>inactive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>stake inactive during the epoch</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"active"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inactive"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"activating"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deactivating"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>the stake account's activation state</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="StakeAuthorizationType" class="tsd-anchor"></a><h3>Stake<wbr/>Authorization<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Stake<wbr/>Authorization<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2117</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Stake authorization type</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The Stake Authorization index (from solana-stake-program)</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="StakeInstructionType" class="tsd-anchor"></a><h3>Stake<wbr/>Instruction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Stake<wbr/>Instruction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"AuthorizeWithSeed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Authorize"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Deactivate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Delegate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Initialize"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Split"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Withdraw"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2106</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An enumeration of valid StakeInstructionType's</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Supply" class="tsd-anchor"></a><h3>Supply</h3><div class="tsd-signature tsd-kind-icon">Supply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>circulating<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>nonCirculating<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>nonCirculatingAccounts<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>total<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:933</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Supply</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>circulating<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Circulating supply in lamports</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>non<wbr/>Circulating<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Non-circulating supply in lamports</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>non<wbr/>Circulating<wbr/>Accounts<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>List of non-circulating account addresses</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>total<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Total supply in lamports</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="SystemInstructionType" class="tsd-anchor"></a><h3>System<wbr/>Instruction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">System<wbr/>Instruction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"AdvanceNonceAccount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Allocate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"AllocateWithSeed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Assign"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"AssignWithSeed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"AuthorizeNonceAccount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Create"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"CreateWithSeed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"InitializeNonceAccount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Transfer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"TransferWithSeed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"WithdrawNonceAccount"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2453</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>An enumeration of valid SystemInstructionType's</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TokenAccountBalancePair" class="tsd-anchor"></a><h3>Token<wbr/>Account<wbr/>Balance<wbr/>Pair</h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Account<wbr/>Balance<wbr/>Pair<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>uiAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>uiAmountString<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:960</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Token address and balance.</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>address<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Address of the token account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Raw amount of tokens as string ignoring decimals</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Number of decimals configured for token's mint</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>ui<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Token amount as float, accounts for decimals</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ui<wbr/>Amount<wbr/>String<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Token amount as string, accounts for decimals</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TokenAccountsFilter" class="tsd-anchor"></a><h3>Token<wbr/>Accounts<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Accounts<wbr/>Filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>mint<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:471</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TokenAmount" class="tsd-anchor"></a><h3>Token<wbr/>Amount</h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>uiAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>uiAmountString<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:947</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Token amount object which returns a token amount in different formats
|
|
|
|
|
for various client use cases.</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Raw amount of tokens as string ignoring decimals</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>decimals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Number of decimals configured for token's mint</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>ui<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Token amount as float, accounts for decimals</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> ui<wbr/>Amount<wbr/>String<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Token amount as string, accounts for decimals</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TokenBalance" class="tsd-anchor"></a><h3>Token<wbr/>Balance</h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accountIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>uiTokenAmount<span class="tsd-signature-symbol">: </span><a href="web3.html#TokenAmount" class="tsd-signature-type" data-tsd-kind="Type alias">TokenAmount</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:693</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>ui<wbr/>Token<wbr/>Amount<span class="tsd-signature-symbol">: </span><a href="web3.html#TokenAmount" class="tsd-signature-type" data-tsd-kind="Type alias">TokenAmount</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransactionConfirmationStatus" class="tsd-anchor"></a><h3>Transaction<wbr/>Confirmation<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Confirmation<wbr/>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"processed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"confirmed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"finalized"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1237</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Transaction confirmation status</p>
|
|
|
|
|
<pre>
|
|
|
|
|
'processed': Transaction landed in a block which has reached 1 confirmation by the connected node
|
|
|
|
|
'confirmed': Transaction landed in a block which has reached 1 confirmation by the cluster
|
|
|
|
|
'finalized': Transaction landed in a block which has been finalized by the cluster
|
|
|
|
|
</pre></div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransactionCtorFields" class="tsd-anchor"></a><h3>Transaction<wbr/>Ctor<wbr/>Fields</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Ctor<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feePayer<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>nonceInfo<span class="tsd-signature-symbol">?: </span><a href="web3.html#NonceInformation" class="tsd-signature-type" data-tsd-kind="Type alias">NonceInformation</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>recentBlockhash<span class="tsd-signature-symbol">?: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>signatures<span class="tsd-signature-symbol">?: </span><a href="web3.html#SignaturePubkeyPair" class="tsd-signature-type" data-tsd-kind="Type alias">SignaturePubkeyPair</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:344</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>List of Transaction object fields that may be initialized at construction</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> fee<wbr/>Payer<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The transaction fee payer</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> nonce<wbr/>Info<span class="tsd-signature-symbol">?: </span><a href="web3.html#NonceInformation" class="tsd-signature-type" data-tsd-kind="Type alias">NonceInformation</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Optional nonce information used for offline nonce'd transactions</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> recent<wbr/>Blockhash<span class="tsd-signature-symbol">?: </span><a href="web3.html#Blockhash" class="tsd-signature-type" data-tsd-kind="Type alias">Blockhash</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A recent blockhash</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> signatures<span class="tsd-signature-symbol">?: </span><a href="web3.html#SignaturePubkeyPair" class="tsd-signature-type" data-tsd-kind="Type alias">SignaturePubkeyPair</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>One or more signatures</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransactionError" class="tsd-anchor"></a><h3>Transaction<wbr/>Error</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:1228</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Transaction error</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransactionInstructionCtorFields" class="tsd-anchor"></a><h3>Transaction<wbr/>Instruction<wbr/>Ctor<wbr/>Fields</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Instruction<wbr/>Ctor<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>keys<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountMeta" class="tsd-signature-type" data-tsd-kind="Type alias">AccountMeta</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:300</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>List of TransactionInstruction object fields that may be initialized at construction</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Buffer</span></h5></li><li class="tsd-parameter"><h5>keys<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountMeta" class="tsd-signature-type" data-tsd-kind="Type alias">AccountMeta</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransactionResponse" class="tsd-anchor"></a><h3>Transaction<wbr/>Response</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>blockTime<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a><span class="tsd-signature-symbol">; </span>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:747</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A processed transaction from the RPC API</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> block<wbr/>Time<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The unix timestamp of when the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>meta<span class="tsd-signature-symbol">: </span><a href="web3.html#ConfirmedTransactionMeta" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmedTransactionMeta</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Metadata produced from the transaction</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The slot during which the transaction was processed</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a><span class="tsd-signature-symbol">; </span>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The transaction</p>
|
|
|
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The transaction message</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The transaction signatures</p>
|
|
|
|
|
</div></div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransactionSignature" class="tsd-anchor"></a><h3>Transaction<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:277</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Transaction signature as base-58 encoded string</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransferParams" class="tsd-anchor"></a><h3>Transfer<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Transfer<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>toPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2211</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Transfer system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account that will transfer lamports</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to transfer</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>to<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account that will receive transferred lamports</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="TransferWithSeedParams" class="tsd-anchor"></a><h3>Transfer<wbr/>With<wbr/>Seed<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Transfer<wbr/>With<wbr/>Seed<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>basePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>fromPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>toPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2359</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Transfer with seed system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>base<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Base public key to use to derive the funding account address</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>from<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account that will transfer lamports</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to transfer</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>program<wbr/>Id<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Program id to use to derive the funding account address</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Seed to use to derive the funding account address</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>to<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Account that will receive transferred lamports</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="Version" class="tsd-anchor"></a><h3>Version</h3><div class="tsd-signature tsd-kind-icon">Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feature-set<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>solana-core<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:680</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Version info for a node</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> feature-<wbr/>set<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>solana-<wbr/>core<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Version of solana-core</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="VoteAccountInfo" class="tsd-anchor"></a><h3>Vote<wbr/>Account<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Vote<wbr/>Account<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>activatedStake<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>commission<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>epochCredits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><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><span class="tsd-signature-symbol">; </span>epochVoteAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>lastVote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>nodePubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>votePubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:594</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Information describing a vote account</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>activated<wbr/>Stake<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>The stake, in lamports, delegated to this vote account and activated</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>commission<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A percentage (0-100) of rewards payout owed to the voter</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>epoch<wbr/>Credits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><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></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Recent epoch voting credit history for this voter</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>epoch<wbr/>Vote<wbr/>Account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Whether the vote account is staked for this epoch</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>last<wbr/>Vote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Most recent slot voted on by this vote account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>node<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Identity public key of the node voting with this account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>vote<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the vote account</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="VoteAccountStatus" class="tsd-anchor"></a><h3>Vote<wbr/>Account<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">Vote<wbr/>Account<wbr/>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current<span class="tsd-signature-symbol">: </span><a href="web3.html#VoteAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">VoteAccountInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>delinquent<span class="tsd-signature-symbol">: </span><a href="web3.html#VoteAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">VoteAccountInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:613</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>A collection of cluster vote accounts</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>current<span class="tsd-signature-symbol">: </span><a href="web3.html#VoteAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">VoteAccountInfo</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Active vote accounts</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>delinquent<span class="tsd-signature-symbol">: </span><a href="web3.html#VoteAccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">VoteAccountInfo</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Inactive vote accounts</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="WithdrawNonceParams" class="tsd-anchor"></a><h3>Withdraw<wbr/>Nonce<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Withdraw<wbr/>Nonce<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>noncePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>toPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2298</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Withdraw nonce account system transaction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the nonce authority</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Amount of lamports to withdraw from the nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>nonce<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Nonce account</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5>to<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Public key of the account which will receive the withdrawn nonce account balance</p>
|
|
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a id="WithdrawStakeParams" class="tsd-anchor"></a><h3>Withdraw<wbr/>Stake<wbr/>Params</h3><div class="tsd-signature tsd-kind-icon">Withdraw<wbr/>Stake<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authorizedPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>custodianPubkey<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>stakePubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">; </span>toPubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2038</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Withdraw stake instruction params</p>
|
|
|
|
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authorized<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> custodian<wbr/>Pubkey<span class="tsd-signature-symbol">?: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>lamports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>stake<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li class="tsd-parameter"><h5>to<wbr/>Pubkey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="BPF_LOADER_DEPRECATED_PROGRAM_ID" class="tsd-anchor"></a><h3>BPF_<wbr/>LOADER_<wbr/>DEPRECATED_<wbr/>PROGRAM_<wbr/>ID</h3><div class="tsd-signature tsd-kind-icon">BPF_<wbr/>LOADER_<wbr/>DEPRECATED_<wbr/>PROGRAM_<wbr/>ID<span class="tsd-signature-symbol">:</span> <a href="../classes/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:122</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="BPF_LOADER_PROGRAM_ID" class="tsd-anchor"></a><h3>BPF_<wbr/>LOADER_<wbr/>PROGRAM_<wbr/>ID</h3><div class="tsd-signature tsd-kind-icon">BPF_<wbr/>LOADER_<wbr/>PROGRAM_<wbr/>ID<span class="tsd-signature-symbol">:</span> <a href="../classes/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:1857</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="LAMPORTS_PER_SOL" class="tsd-anchor"></a><h3>LAMPORTS_<wbr/>PER_<wbr/>SOL</h3><div class="tsd-signature tsd-kind-icon">LAMPORTS_<wbr/>PER_<wbr/>SOL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1000000000</span><span class="tsd-signature-symbol"> = 1000000000</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2723</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>There are 1-billion lamports in one SOL</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="MAX_SEED_LENGTH" class="tsd-anchor"></a><h3>MAX_<wbr/>SEED_<wbr/>LENGTH</h3><div class="tsd-signature tsd-kind-icon">MAX_<wbr/>SEED_<wbr/>LENGTH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">32</span><span class="tsd-signature-symbol"> = 32</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Maximum length of derived pubkey seed</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="NONCE_ACCOUNT_LENGTH" class="tsd-anchor"></a><h3>NONCE_<wbr/>ACCOUNT_<wbr/>LENGTH</h3><div class="tsd-signature tsd-kind-icon">NONCE_<wbr/>ACCOUNT_<wbr/>LENGTH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:132</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="PACKET_DATA_SIZE" class="tsd-anchor"></a><h3>PACKET_<wbr/>DATA_<wbr/>SIZE</h3><div class="tsd-signature tsd-kind-icon">PACKET_<wbr/>DATA_<wbr/>SIZE<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:285</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Maximum over-the-wire size of a Transaction</p>
|
|
|
|
|
</div><div><p>1280 is IPv6 minimum MTU
|
|
|
|
|
40 bytes is the size of the IPv6 header
|
|
|
|
|
8 bytes is the size of the fragment header</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SOLANA_SCHEMA" class="tsd-anchor"></a><h3>SOLANA_<wbr/>SCHEMA</h3><div class="tsd-signature tsd-kind-icon">SOLANA_<wbr/>SCHEMA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="STAKE_CONFIG_ID" class="tsd-anchor"></a><h3>STAKE_<wbr/>CONFIG_<wbr/>ID</h3><div class="tsd-signature tsd-kind-icon">STAKE_<wbr/>CONFIG_<wbr/>ID<span class="tsd-signature-symbol">:</span> <a href="../classes/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:1926</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Address of the stake config account which configures the rate
|
|
|
|
|
of stake warmup and cooldown as well as the slashing penalty.</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SYSVAR_CLOCK_PUBKEY" class="tsd-anchor"></a><h3>SYSVAR_<wbr/>CLOCK_<wbr/>PUBKEY</h3><div class="tsd-signature tsd-kind-icon">SYSVAR_<wbr/>CLOCK_<wbr/>PUBKEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2673</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SYSVAR_INSTRUCTIONS_PUBKEY" class="tsd-anchor"></a><h3>SYSVAR_<wbr/>INSTRUCTIONS_<wbr/>PUBKEY</h3><div class="tsd-signature tsd-kind-icon">SYSVAR_<wbr/>INSTRUCTIONS_<wbr/>PUBKEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2678</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SYSVAR_RECENT_BLOCKHASHES_PUBKEY" class="tsd-anchor"></a><h3>SYSVAR_<wbr/>RECENT_<wbr/>BLOCKHASHES_<wbr/>PUBKEY</h3><div class="tsd-signature tsd-kind-icon">SYSVAR_<wbr/>RECENT_<wbr/>BLOCKHASHES_<wbr/>PUBKEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2674</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SYSVAR_RENT_PUBKEY" class="tsd-anchor"></a><h3>SYSVAR_<wbr/>RENT_<wbr/>PUBKEY</h3><div class="tsd-signature tsd-kind-icon">SYSVAR_<wbr/>RENT_<wbr/>PUBKEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2675</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SYSVAR_REWARDS_PUBKEY" class="tsd-anchor"></a><h3>SYSVAR_<wbr/>REWARDS_<wbr/>PUBKEY</h3><div class="tsd-signature tsd-kind-icon">SYSVAR_<wbr/>REWARDS_<wbr/>PUBKEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2676</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="SYSVAR_STAKE_HISTORY_PUBKEY" class="tsd-anchor"></a><h3>SYSVAR_<wbr/>STAKE_<wbr/>HISTORY_<wbr/>PUBKEY</h3><div class="tsd-signature tsd-kind-icon">SYSVAR_<wbr/>STAKE_<wbr/>HISTORY_<wbr/>PUBKEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2677</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="StakeAuthorizationLayout" class="tsd-anchor"></a><h3>Stake<wbr/>Authorization<wbr/>Layout</h3><div class="tsd-signature tsd-kind-icon">Stake<wbr/>Authorization<wbr/>Layout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>Staker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>index<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>Withdrawer<
|
|
|
|
|
<p>An enumeration of valid StakeAuthorizationLayout's</p>
|
|
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="VALIDATOR_INFO_KEY" class="tsd-anchor"></a><h3>VALIDATOR_<wbr/>INFO_<wbr/>KEY</h3><div class="tsd-signature tsd-kind-icon">VALIDATOR_<wbr/>INFO_<wbr/>KEY<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2590</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external"><a id="VOTE_PROGRAM_ID" class="tsd-anchor"></a><h3>VOTE_<wbr/>PROGRAM_<wbr/>ID</h3><div class="tsd-signature tsd-kind-icon">VOTE_<wbr/>PROGRAM_<wbr/>ID<span class="tsd-signature-symbol">:</span> <a href="../classes/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:2635</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a id="clusterApiUrl" class="tsd-anchor"></a><h3>cluster<wbr/>Api<wbr/>Url</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><li class="tsd-signature tsd-kind-icon">cluster<wbr/>Api<wbr/>Url<span class="tsd-signature-symbol">(</span>cluster<span class="tsd-signature-symbol">?: </span><a href="web3.html#Cluster" class="tsd-signature-type" data-tsd-kind="Type alias">Cluster</a>, tls<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></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:2718</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Retrieves the RPC API URL for the specified cluster</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cluster: <a href="web3.html#Cluster" class="tsd-signature-type" data-tsd-kind="Type alias">Cluster</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> tls: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a id="sendAndConfirmRawTransaction" class="tsd-anchor"></a><h3>send<wbr/>And<wbr/>Confirm<wbr/>Raw<wbr/>Transaction</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><li class="tsd-signature tsd-kind-icon">send<wbr/>And<wbr/>Confirm<wbr/>Raw<wbr/>Transaction<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a>, rawTransaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="web3.html#ConfirmOptions" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">></span></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:2708</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Send and confirm a raw transaction</p>
|
|
|
|
|
</div><div><p>If <code>commitment</code> option is not specified, defaults to 'max' commitment.</p>
|
|
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connection: <a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a></h5></li><li><h5>rawTransaction: <span class="tsd-signature-type">Buffer</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="web3.html#ConfirmOptions" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a id="sendAndConfirmTransaction" class="tsd-anchor"></a><h3>send<wbr/>And<wbr/>Confirm<wbr/>Transaction</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><li class="tsd-signature tsd-kind-icon">send<wbr/>And<wbr/>Confirm<wbr/>Transaction<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a>, transaction<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a>, signers<span class="tsd-signature-symbol">: </span><a href="../interfaces/web3.Signer.html" class="tsd-signature-type" data-tsd-kind="Interface">Signer</a><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="web3.html#ConfirmOptions" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">></span></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:2691</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Sign, send and confirm a transaction.</p>
|
|
|
|
|
</div><div><p>If <code>commitment</code> option is not specified, defaults to 'max' commitment.</p>
|
2022-02-03 07:26:04 -08:00
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connection: <a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a></h5></li><li><h5>transaction: <a href="../classes/web3.Transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h5></li><li><h5>signers: <a href="../interfaces/web3.Signer.html" class="tsd-signature-type" data-tsd-kind="Interface">Signer</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="web3.html#ConfirmOptions" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">></span></h4><div></div></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="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="BN.html">BN</a></li><li class="current tsd-kind-namespace tsd-is-external"><a href="web3.html">web3</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Account.html" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Authorized.html" class="tsd-kind-icon">Authorized</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.BpfLoader.html" class="tsd-kind-icon">Bpf<wbr/>Loader</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Connection.html" class="tsd-kind-icon">Connection</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Enum.html" class="tsd-kind-icon">Enum</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Keypair.html" class="tsd-kind-icon">Keypair</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Loader.html" class="tsd-kind-icon">Loader</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Lockup.html" class="tsd-kind-icon">Lockup</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Message.html" class="tsd-kind-icon">Message</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.NonceAccount.html" class="tsd-kind-icon">Nonce<wbr/>Account</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.PublicKey.html" class="tsd-kind-icon">Public<wbr/>Key</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Secp256k1Program.html" class="tsd-kind-icon">Secp256k1<wbr/>Program</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.StakeInstruction.html" class="tsd-kind-icon">Stake<wbr/>Instruction</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.StakeProgram.html" class="tsd-kind-icon">Stake<wbr/>Program</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.Struct.html" class="tsd-kind-icon">Struct</a></li><li class="tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="../classes/web3.SystemInstruction.html" class="tsd-kind-icon">System<wbr/>Inst
|
