2022-07-05 13:51:36 -07:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@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"><h1>@project-serum/anchor - v0.25.0</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 "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace tsd-is-external"><a href="modules/BN.html" class="tsd-kind-icon">BN</a></li><li class="tsd-kind-namespace"><a href="modules/utils.html" class="tsd-kind-icon">utils</a></li><li class="tsd-kind-namespace tsd-is-external"><a href="modules/web3.html" class="tsd-kind-icon">web3</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/AccountClient.html" class="tsd-kind-icon">Account<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/AnchorError.html" class="tsd-kind-icon">Anchor<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/AnchorProvider.html" class="tsd-kind-icon">Anchor<wbr/>Provider</a></li><li class="tsd-kind-class tsd-is-external"><a href="classes/BN.html" class="tsd-kind-icon">BN</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/BorshAccountsCoder.html" class="tsd-kind-icon">Borsh<wbr/>Accounts<wbr/>Coder</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/BorshCoder.html" class="tsd-kind-icon">Borsh<wbr/>Coder</a></li><li class="tsd-kind-class"><a href="classes/BorshEventCoder.html" class="tsd-kind-icon">Borsh<wbr/>Event<wbr/>Coder</a></li><li class="tsd-kind-class"><a href="classes/BorshInstructionCoder.html" class="tsd-kind-icon">Borsh<wbr/>Instruction<wbr/>Coder</a></li><li class="tsd-kind-class"><a href="classes/BorshStateCoder.html" class="tsd-kind-icon">Borsh<wbr/>State<wbr/>Coder</a></li><li class="tsd-kind-class"><a href="classes/EventManager.html" class="tsd-kind-icon">Event<wbr/>Manager</a></li><li class="tsd-kind-class"><a href="classes/EventParser.html" class="tsd-kind-icon">Event<wbr/>Parser</a></li><li class="tsd-ki
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>The namespace provides handles to an <a href="classes/AccountClient.html">AccountClient</a> object for each
|
|
|
|
|
account in a program.</p>
|
|
|
|
|
</div><div>
|
|
|
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Usage</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-0">account</span><span class="hl-1">.<</span><span class="hl-0">account</span><span class="hl-1">-</span><span class="hl-0">client</span><span class="hl-1">></span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>To fetch a <code>Counter</code> account from the above example,</p>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">counter</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">account</span><span class="hl-1">.</span><span class="hl-0">counter</span><span class="hl-1">.</span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-0">address</span><span class="hl-1">);</span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
<p>For the full API, see the <a href="classes/AccountClient.html">AccountClient</a> reference.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="Accounts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Accounts<a href="#Accounts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Accounts<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</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><span class="tsd-signature-type">N</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Account</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">N</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 <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/context.ts#L64">src/program/context.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>A set of accounts mapping one-to-one to the program's accounts struct, i.e.,
|
|
|
|
|
the type deriving <code>#[derive(Accounts)]</code>.</p>
|
|
|
|
|
</div><div><p>The name of each field should match the name for that account in the IDL.</p>
|
|
|
|
|
<p>If multiple accounts are nested in the rust program, then they should be
|
|
|
|
|
nested here.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>A<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdlAccountItem</span> = <span class="tsd-signature-type">IdlAccountItem</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Address" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Address<a href="#Address" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">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><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/common.ts#L65">src/program/common.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>An address to identify an account on chain. Can be a <a href="classes/web3.PublicKey.html">PublicKey</a>,
|
|
|
|
|
or Base 58 encoded string.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="Context" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Context<a href="#Context" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Context<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">; </span>instructions<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><span class="tsd-signature-symbol">; </span>options<span class="tsd-signature-symbol">?: </span><a href="modules/web3.html#ConfirmOptions" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmOptions</a><span class="tsd-signature-symbol">; </span>postInstructions<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><span class="tsd-signature-symbol">; </span>preInstructions<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><span class="tsd-signature-symbol">; </span>remainingAccounts<span class="tsd-signature-symbol">?: </span><a href="modules/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>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><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/context.ts#L13">src/program/context.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Context provides all non-argument inputs for generating Anchor transactions.</p>
|
|
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>A<span class="tsd-signature-symbol">: </span><a href="index.html#Accounts" class="tsd-signature-type" data-tsd-kind="Type alias">Accounts</a> = <a href="index.html#Accounts" class="tsd-signature-type" data-tsd-kind="Type alias">Accounts</a></h4></li></ul><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> accounts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Accounts used in the instruction context.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> instructions<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></h5><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>use preInstructions instead.
|
|
|
|
|
Instructions to run <em>before</em> a given method. Often this is used, for
|
|
|
|
|
example to create accounts prior to executing a method.</p>
|
|
|
|
|
</dd></dl></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> options<span class="tsd-signature-symbol">?: </span><a href="modules/web3.html#ConfirmOptions" class="tsd-signature-type" data-tsd-kind="Type alias">ConfirmOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Commitment parameters to use for a transaction.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr/>Instructions<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></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Instructions to run <em>after</em> a given method. Often this is used, for
|
|
|
|
|
example to close accounts after executing a method.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> pre<wbr/>Instructions<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></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Instructions to run <em>before</em> a given method. Often this is used, for
|
|
|
|
|
example to create accounts prior to executing a method.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> remaining<wbr/>Accounts<span class="tsd-signature-symbol">?: </span><a href="modules/web3.html#AccountMeta" class="tsd-signature-type" data-tsd-kind="Type alias">AccountMeta</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>All accounts to pass into an instruction <em>after</em> the main <code>accounts</code>.
|
|
|
|
|
This can be used for optional or otherwise unknown accounts.</p>
|
|
|
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> 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></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
|
|
|
<p>Accounts that must sign a given transaction.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="Event" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Event<a href="#Event" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Event<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Defined</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><a href="index.html#EventData" class="tsd-signature-type" data-tsd-kind="Type alias">EventData</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"fields"</span><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-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Defined</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/event.ts#L14">src/program/event.ts:14</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>E<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdlEvent</span> = <span class="tsd-signature-type">IdlEvent</span></h4></li><li><h4>Defined = <span class="tsd-signature-type">Record</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">never</span><span class="tsd-signature-symbol">></span></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><a href="index.html#EventData" class="tsd-signature-type" data-tsd-kind="Type alias">EventData</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"fields"</span><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-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Defined</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">E</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Function to create a <code>TransactionInstruction</code> generated from an IDL.
|
|
|
|
|
Additionally it provides an <code>accounts</code> utility method, returning a list
|
|
|
|
|
of ordered accounts for the instruction.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="InstructionNamespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Instruction<wbr/>Namespace<a href="#InstructionNamespace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Instruction<wbr/>Namespace<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MakeInstructionsNamespace</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><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><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">M</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">AllInstructionsMap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</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>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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 <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/instruction.ts#L151">src/program/namespace/instruction.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>The namespace provides functions to build <a href="classes/web3.TransactionInstruction.html">TransactionInstruction</a>
|
|
|
|
|
objects for each method of a program.</p>
|
|
|
|
|
</div><div>
|
|
|
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Usage</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-0">instruction</span><span class="hl-1">.<</span><span class="hl-0">method</span><span class="hl-1">>(...</span><span class="hl-0">args</span><span class="hl-1">, </span><span class="hl-0">ctx</span><span class="hl-1">);</span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<a href="#parameters" id="parameters" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Parameters</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><code>args</code> - The positional arguments for the program. The type and number
|
|
|
|
|
of these arguments depend on the program being used.</li>
|
|
|
|
|
<li><code>ctx</code> - <a href="modules/web3.html#Context">Context</a> non-argument parameters to pass to the method.
|
|
|
|
|
Always the last parameter in the method call.</li>
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>To create an instruction for the <code>increment</code> method above,</p>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">tx</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">instruction</span><span class="hl-1">.</span><span class="hl-5">increment</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">accounts:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">counter</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
|
|
|
</code></pre>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdlInstruction</span> = <span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"instructions"</span><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></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="MethodsNamespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Methods<wbr/>Namespace<a href="#MethodsNamespace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Methods<wbr/>Namespace<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MakeMethodsNamespace</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/methods.ts#L28">src/program/namespace/methods.ts:28</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="RpcFn" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Rpc<wbr/>Fn<a href="#RpcFn" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Rpc<wbr/>Fn<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type p
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>RpcFn is a single RPC method generated from an IDL, sending a transaction
|
|
|
|
|
paid for and signed by the configured provider.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="RpcNamespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Rpc<wbr/>Namespace<a href="#RpcNamespace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Rpc<wbr/>Namespace<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MakeInstructionsNamespace</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="modules/web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/rpc.ts#L77">src/program/namespace/rpc.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>The namespace provides async methods to send signed transactions for each
|
|
|
|
|
<em>non</em>-state method on Anchor program.</p>
|
|
|
|
|
</div><div><p>Keys are method names, values are RPC functions returning a
|
|
|
|
|
<a href="classes/web3.TransactionInstruction.html">TransactionInstruction</a>.</p>
|
|
|
|
|
|
|
|
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Usage</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-0">rpc</span><span class="hl-1">.<</span><span class="hl-0">method</span><span class="hl-1">>(...</span><span class="hl-0">args</span><span class="hl-1">, </span><span class="hl-0">ctx</span><span class="hl-1">);</span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<a href="#parameters" id="parameters" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Parameters</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><code>args</code> - The positional arguments for the program. The type and number
|
|
|
|
|
of these arguments depend on the program being used.</li>
|
|
|
|
|
<li><code>ctx</code> - <a href="modules/web3.html#Context">Context</a> non-argument parameters to pass to the method.
|
|
|
|
|
Always the last parameter in the method call.
|
|
|
|
|
```</li>
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>To send a transaction invoking the <code>increment</code> method above,</p>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">txSignature</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">rpc</span><span class="hl-1">.</span><span class="hl-5">increment</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">accounts:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">counter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">authority</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
|
|
|
</code></pre>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="SimulateFn" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Simulate<wbr/>Fn<a href="#SimulateFn" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Simulate<wbr/>Fn<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstructionContextFn</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SimulateResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">NullableEvents</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><a href="index.html#IdlTypes" class="tsd-signature-type" data-tsd-kind="Type alias">IdlTypes</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/simulate.ts#L120">src/program/namespace/simulate.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>SimulateFn is a single method generated from an IDL. It simulates a method
|
|
|
|
|
against a cluster configured by the provider, returning a list of all the
|
|
|
|
|
events and raw logs that were emitted during the execution of the
|
|
|
|
|
method.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="SimulateNamespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Simulate<wbr/>Namespace<a href="#SimulateNamespace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Simulate<wbr/>Namespace<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MakeInstructionsNamespace</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SimulateResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">NullableEvents</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><a href="index.html#IdlTypes" class="tsd-signature-type" data-tsd-kind="Type alias">IdlTypes</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/simulate.ts#L101">src/program/namespace/simulate.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>The namespace provides functions to simulate transactions for each method
|
|
|
|
|
of a program, returning a list of deserialized events <em>and</em> raw program
|
|
|
|
|
logs.</p>
|
|
|
|
|
</div><div><p>One can use this to read data calculated from a program on chain, by
|
|
|
|
|
emitting an event in the program and reading the emitted event client side
|
|
|
|
|
via the <code>simulate</code> namespace.</p>
|
|
|
|
|
|
|
|
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Usage</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">simulate</span><span class="hl-1">.<</span><span class="hl-0">method</span><span class="hl-1">>(...</span><span class="hl-0">args</span><span class="hl-1">, </span><span class="hl-0">ctx</span><span class="hl-1">);</span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<a href="#parameters" id="parameters" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Parameters</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><code>args</code> - The positional arguments for the program. The type and number
|
|
|
|
|
of these arguments depend on the program being used.</li>
|
|
|
|
|
<li><code>ctx</code> - <a href="modules/web3.html#Context">Context</a> non-argument parameters to pass to the method.
|
|
|
|
|
Always the last parameter in the method call.</li>
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>To simulate the <code>increment</code> method above,</p>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">events</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">simulate</span><span class="hl-1">.</span><span class="hl-5">increment</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">accounts:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">counter</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
|
|
|
</code></pre>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SplToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Spl<wbr/>Token<a href="#SplToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Spl<wbr/>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"mint"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"mintAuthority"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>coption<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"publicKey"</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>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"supply"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u64"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"decimals"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"isInitialized"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"bool"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"freezeAuthority"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>SplToken IDL.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</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><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"mint"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"mintAuthority"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>coption<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"publicKey"</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>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"supply"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u64"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"decimals"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"isInitialized"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"bool"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"freezeAuthority"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>coption<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"publicKey"</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>kind<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"struct"</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>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"token"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"mint"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"publicKey"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"authority"</span><span class="tsd-signature-symbol">; </span>type<span
|
|
|
|
|
<p>System IDL.</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><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"nonce"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"version"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u32"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"u32"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"authorizedPubkey"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"publicKey"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"nonce"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"publicKey"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"feeCalculator"</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>defined<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"FeeCalculator"</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>kind<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"struct"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">]</span></h5></li><li class="tsd-parameter"><h5>instructions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">{ </span>isMut<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>isSigner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"from"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>isMut<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>isSigner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Tx is a function to create a <code>Transaction</code> for a given program instruction.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="TransactionNamespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Transaction<wbr/>Namespace<a href="#TransactionNamespace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Namespace<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MakeInstructionsNamespace</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><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 <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/transaction.ts#L62">src/program/namespace/transaction.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>The namespace provides functions to build <a href="classes/web3.Transaction.html">Transaction</a> objects for each
|
|
|
|
|
method of a program.</p>
|
|
|
|
|
</div><div>
|
|
|
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Usage</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">transaction</span><span class="hl-1">.<</span><span class="hl-0">method</span><span class="hl-1">>(...</span><span class="hl-0">args</span><span class="hl-1">, </span><span class="hl-0">ctx</span><span class="hl-1">);</span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<a href="#parameters" id="parameters" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Parameters</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><code>args</code> - The positional arguments for the program. The type and number
|
|
|
|
|
of these arguments depend on the program being used.</li>
|
|
|
|
|
<li><code>ctx</code> - <a href="modules/web3.html#Context">Context</a> non-argument parameters to pass to the method.
|
|
|
|
|
Always the last parameter in the method call.</li>
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<a href="#example" id="example" style="color: inherit; text-decoration: none;">
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
</a>
|
|
|
|
|
<p>To create an instruction for the <code>increment</code> method above,</p>
|
|
|
|
|
<pre><code class="language-javascript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">tx</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">program</span><span class="hl-1">.</span><span class="hl-0">transaction</span><span class="hl-1">.</span><span class="hl-5">increment</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">accounts:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">counter</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
|
|
|
</code></pre>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="ViewFn" class="tsd-anchor"></a><h3 class="tsd-anchor-link">View<wbr/>Fn<a href="#ViewFn" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">View<wbr/>Fn<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">InstructionContextFn</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/views.ts#L57">src/program/namespace/views.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-04-12 07:50:18 -07:00
|
|
|
<p>ViewFn is a single method generated from an IDL. It simulates a method
|
|
|
|
|
against a cluster configured by the provider, and then parses the events
|
|
|
|
|
and extracts return data from the raw logs emitted during the simulation.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="ViewNamespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">View<wbr/>Namespace<a href="#ViewNamespace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">View<wbr/>Namespace<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MakeInstructionsNamespace</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/namespace/views.ts#L47">src/program/namespace/views.ts:47</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>IDL<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a> = <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h4></li><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">AllInstructions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IDL</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable"><a id="ACCOUNT_DISCRIMINATOR_SIZE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ACCOUNT_<wbr/>DISCRIMINATOR_<wbr/>SIZE<a href="#ACCOUNT_DISCRIMINATOR_SIZE" 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"
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Number of bytes of the account discriminator.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="LangErrorCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Lang<wbr/>Error<wbr/>Code<a href="#LangErrorCode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Lang<wbr/>Error<wbr/>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>AccountDidNotDeserialize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountDidNotSerialize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountDiscriminatorAlreadySet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountDiscriminatorMismatch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountDiscriminatorNotFound<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountDuplicateReallocs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotAssociatedTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotEnoughKeys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotInitialized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotMutable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotProgramData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotSigner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountNotSystemOwned<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountOwnedByWrongProgram<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountReallocExceedsLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>AccountSysvarMismatch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ConstraintAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ConstraintAssociated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ConstraintAssociatedInit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ConstraintClose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ConstraintExecutable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-t
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Returns the default provider being used by the client.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="interfaces/Provider.html" class="tsd-signature-type" data-tsd-kind="Interface">Provider</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="parseIdlErrors" class="tsd-anchor"></a><h3 class="tsd-anchor-link">parse<wbr/>Idl<wbr/>Errors<a href="#parseIdlErrors" 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-function"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Idl<wbr/>Errors<span class="tsd-signature-symbol">(</span>idl<span class="tsd-signature-symbol">: </span><a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</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">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/common.ts#L11">src/program/common.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>idl: <a href="index.html#Idl" class="tsd-signature-type" data-tsd-kind="Type alias">Idl</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</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">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="setProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Provider<a href="#setProvider" 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-function"><li class="tsd-signature tsd-kind-icon">set<wbr/>Provider<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="interfaces/Provider.html" class="tsd-signature-type" data-tsd-kind="Interface">Provider</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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/provider.ts#L318">src/provider.ts:318</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
2022-01-12 07:42:08 -08:00
|
|
|
<p>Sets the default provider on the client.</p>
|
2022-07-05 13:51:36 -07:00
|
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>provider: <a href="interfaces/Provider.html" class="tsd-signature-type" data-tsd-kind="Interface">Provider</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="splitArgsAndCtx" class="tsd-anchor"></a><h3 class="tsd-anchor-link">split<wbr/>Args<wbr/>And<wbr/>Ctx<a href="#splitArgsAndCtx" 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-function"><li class="tsd-signature tsd-kind-icon">split<wbr/>Args<wbr/>And<wbr/>Ctx<span class="tsd-signature-symbol">(</span>idlIx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdlInstruction</span>, args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="index.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</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 <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/program/context.ts#L72">src/program/context.ts:72</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>idlIx: <span class="tsd-signature-type">IdlInstruction</span></h5></li><li><h5>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="index.html#Context" class="tsd-signature-type" data-tsd-kind="Type alias">Context</a><span class="tsd-signature-symbol">]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="stateDiscriminator" class="tsd-anchor"></a><h3 class="tsd-anchor-link">state<wbr/>Discriminator<a href="#stateDiscriminator" 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-function"><li class="tsd-signature tsd-kind-icon">state<wbr/>Discriminator<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/anchor/blob/6baed77e/ts/src/coder/borsh/state.ts#L36">src/coder/borsh/state.ts:36</a></
|
