29 lines
39 KiB
HTML
29 lines
39 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SystemInstruction | @project-serum/anchor - v0.25.0</title><meta name="description" content="Documentation for @project-serum/anchor - v0.25.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@project-serum/anchor - v0.25.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@project-serum/anchor - v0.25.0</a></li><li><a href="../modules/web3.html">web3</a></li><li><a href="web3.SystemInstruction.html">SystemInstruction</a></li></ul><h1>Class SystemInstruction</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>System Instruction class</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SystemInstruction</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-external"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="web3.SystemInstruction.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAllocate" class="tsd-kind-icon">decode<wbr/>Allocate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAllocateWithSeed" class="tsd-kind-icon">decode<wbr/>Allocate<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAssign" class="tsd-kind-icon">decode<wbr/>Assign</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAssignWithSeed" class="tsd-kind-icon">decode<wbr/>Assign<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeCreateAccount" class="tsd-kind-icon">decode<wbr/>Create<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeCreateWithSeed" class="tsd-kind-icon">decode<wbr/>Create<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeInstructionType" class="tsd-kind-icon">decode<wbr/>Instruction<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceAdvance" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Advance</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceAuthorize" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Authorize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceInitialize" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Initialize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceWithdraw" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Withdraw</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeTransfer" class="tsd-kind-icon">decode<wbr/>Transfer</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeTransferWithSeed" class="tsd-kind-icon">decode<wbr/>Transfer<wbr/>With<wbr/>Seed</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">new <wbr/>System<wbr/>Instruction<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="web3.SystemInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">SystemInstruction</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="web3.SystemInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">SystemInstruction</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeAllocate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Allocate<a href="#decodeAllocate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Allocate<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AllocateParams" class="tsd-signature-type" data-tsd-kind="Type alias">AllocateParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2688</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode an allocate system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#AllocateParams" class="tsd-signature-type" data-tsd-kind="Type alias">AllocateParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeAllocateWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Allocate<wbr/>With<wbr/>Seed<a href="#decodeAllocateWithSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Allocate<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AllocateWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">AllocateWithSeedParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2692</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode an allocate with seed system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#AllocateWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">AllocateWithSeedParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeAssign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Assign<a href="#decodeAssign" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Assign<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AssignParams" class="tsd-signature-type" data-tsd-kind="Type alias">AssignParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2698</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode an assign system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#AssignParams" class="tsd-signature-type" data-tsd-kind="Type alias">AssignParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeAssignWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Assign<wbr/>With<wbr/>Seed<a href="#decodeAssignWithSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Assign<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AssignWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">AssignWithSeedParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2702</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode an assign with seed system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#AssignWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">AssignWithSeedParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeCreateAccount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Create<wbr/>Account<a href="#decodeCreateAccount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Create<wbr/>Account<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#CreateAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateAccountParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2672</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a create account system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#CreateAccountParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateAccountParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeCreateWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Create<wbr/>With<wbr/>Seed<a href="#decodeCreateWithSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Create<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#CreateAccountWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateAccountWithSeedParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2708</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a create account with seed system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#CreateAccountWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">CreateAccountWithSeedParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeInstructionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Instruction<wbr/>Type<a href="#decodeInstructionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Instruction<wbr/>Type<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#SystemInstructionType" class="tsd-signature-type" data-tsd-kind="Type alias">SystemInstructionType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2666</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a system instruction and retrieve the instruction type.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#SystemInstructionType" class="tsd-signature-type" data-tsd-kind="Type alias">SystemInstructionType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeNonceAdvance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Nonce<wbr/>Advance<a href="#decodeNonceAdvance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Nonce<wbr/>Advance<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AdvanceNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">AdvanceNonceParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2720</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a nonce advance system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#AdvanceNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">AdvanceNonceParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeNonceAuthorize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Nonce<wbr/>Authorize<a href="#decodeNonceAuthorize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Nonce<wbr/>Authorize<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#AuthorizeNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeNonceParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2732</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a nonce authorize system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#AuthorizeNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">AuthorizeNonceParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeNonceInitialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Nonce<wbr/>Initialize<a href="#decodeNonceInitialize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Nonce<wbr/>Initialize<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#InitializeNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">InitializeNonceParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2714</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a nonce initialize system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#InitializeNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">InitializeNonceParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeNonceWithdraw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Nonce<wbr/>Withdraw<a href="#decodeNonceWithdraw" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Nonce<wbr/>Withdraw<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#WithdrawNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawNonceParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2726</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a nonce withdraw system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#WithdrawNonceParams" class="tsd-signature-type" data-tsd-kind="Type alias">WithdrawNonceParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeTransfer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Transfer<a href="#decodeTransfer" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Transfer<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#TransferParams" class="tsd-signature-type" data-tsd-kind="Type alias">TransferParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2678</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a transfer system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#TransferParams" class="tsd-signature-type" data-tsd-kind="Type alias">TransferParams</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a id="decodeTransferWithSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> decode<wbr/>Transfer<wbr/>With<wbr/>Seed<a href="#decodeTransferWithSeed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Transfer<wbr/>With<wbr/>Seed<span class="tsd-signature-symbol">(</span>instruction<span class="tsd-signature-symbol">: </span><a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/web3.html#TransferWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">TransferWithSeedParams</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@solana/web3.js/lib/index.d.ts:2682</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Decode a transfer with seed system instruction and retrieve the instruction params.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>instruction: <a href="web3.TransactionInstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/web3.html#TransferWithSeedParams" class="tsd-signature-type" data-tsd-kind="Type alias">TransferWithSeedParams</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class="label tsd-is-external"><span>Internals</span></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class="label tsd-is-external"><span>Externals</span></li><li class=" tsd-kind-namespace tsd-is-external"><a href="../modules/BN.html">BN</a></li><li class="current tsd-kind-namespace tsd-is-external"><a href="../modules/web3.html">web3</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="web3.SystemInstruction.html" class="tsd-kind-icon">System<wbr/>Instruction</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="web3.SystemInstruction.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAllocate" class="tsd-kind-icon">decode<wbr/>Allocate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAllocateWithSeed" class="tsd-kind-icon">decode<wbr/>Allocate<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAssign" class="tsd-kind-icon">decode<wbr/>Assign</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeAssignWithSeed" class="tsd-kind-icon">decode<wbr/>Assign<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeCreateAccount" class="tsd-kind-icon">decode<wbr/>Create<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeCreateWithSeed" class="tsd-kind-icon">decode<wbr/>Create<wbr/>With<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeInstructionType" class="tsd-kind-icon">decode<wbr/>Instruction<wbr/>Type</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceAdvance" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Advance</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceAuthorize" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Authorize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceInitialize" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Initialize</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeNonceWithdraw" class="tsd-kind-icon">decode<wbr/>Nonce<wbr/>Withdraw</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeTransfer" class="tsd-kind-icon">decode<wbr/>Transfer</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="web3.SystemInstruction.html#decodeTransferWithSeed" class="tsd-kind-icon">decode<wbr/>Transfer<wbr/>With<wbr/>Seed</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |