anchor/ts/modules/utils.rpc.html

4 lines
12 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rpc | @project-serum/anchor - v0.22.0</title><meta name="description" content="Documentation for @project-serum/anchor - v0.22.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.22.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.22.0</a></li><li><a href="utils.html">utils</a></li><li><a href="utils.rpc.html">rpc</a></li></ul><h1>Namespace rpc</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>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.rpc.html#getMultipleAccounts" class="tsd-kind-icon">get<wbr/>Multiple<wbr/>Accounts</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.rpc.html#invoke" class="tsd-kind-icon">invoke</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getMultipleAccounts" class="tsd-anchor"></a><h3>get<wbr/>Multiple<wbr/>Accounts</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Multiple<wbr/>Accounts<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a>, publicKeys<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>, commitment<span class="tsd-signature-symbol">?: </span><a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>publicKey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</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/24ccaea9/ts/src/utils/rpc.ts#L46">src/utils/rpc.ts:46</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connection: <a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a></h5></li><li><h5>publicKeys: <a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> commitment: <a href="web3.html#Commitment" class="tsd-signature-type" data-tsd-kind="Type alias">Commitment</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><a href="web3.html#AccountInfo" class="tsd-signature-type" data-tsd-kind="Type alias">AccountInfo</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>publicKey<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="invoke" class="tsd-anchor"></a><h3>invoke</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">invoke<span class="tsd-signature-symbol">(</span>programId<span class="tsd-signature-symbol">: </span><a href="../index.html#Address" class="tsd-signature-type" data-tsd-kind="Type alias">Address</a>, accounts<span class="tsd-signature-symbol">?: </span><a href="web3.html#AccountMeta" class="tsd-signature-type" data-tsd-kind="Type alias">AccountMeta</a><span class="tsd-signature-symbol">[]</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Buffer</span>, provider<span class="tsd-signature-symbol">?: </span><a href="../classes/Provider.html" class="tsd-signature-type" data-tsd-kind="Class">Provider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">&gt;</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/24ccaea9/ts/src/utils/rpc.ts#L21">src/utils/rpc.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sends a transaction to a program with the given accounts and instruction
data.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>programId: <a href="../index.html#Address" class="tsd-signature-type" data-tsd-kind="Type alias">Address</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> accounts: <a href="web3.html#AccountMeta" class="tsd-signature-type" data-tsd-kind="Type alias">AccountMeta</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">Buffer</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> provider: <a href="../classes/Provider.html" class="tsd-signature-type" data-tsd-kind="Class">Provider</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="web3.html#TransactionSignature" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionSignature</a><span class="tsd-signature-symbol">&gt;</span></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="current tsd-kind-namespace"><a href="utils.html">utils</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.bytes.html">bytes</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.features.html">features</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.publicKey.html">public<wbr/>Key</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.registry.html">registry</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.rpc.html">rpc</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.sha256.html">sha256</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.token.html">token</a></li></ul></li><li class="label tsd-is-external"><span>Externals</span></li><li class=" tsd-kind-namespace tsd-is-external"><a href="BN.html">BN</a></li><li class=" tsd-kind-namespace tsd-is-external"><a href="web3.html">web3</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.rpc.html#getMultipleAccounts" class="tsd-kind-icon">get<wbr/>Multiple<wbr/>Accounts</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.rpc.html#invoke" class="tsd-kind-icon">invoke</a></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>