| 12345678 |
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>registry | @coral-xyz/anchor - v0.30.1</title><meta name="description" content="Documentation for @coral-xyz/anchor - v0.30.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coral-xyz/anchor - v0.30.1</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@coral-xyz/anchor - v0.30.1</a></li><li><a href="utils.html">utils</a></li><li><a href="utils.registry.html">registry</a></li></ul><h1>Namespace registry </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>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="utils.registry.html#Build" class="tsd-kind-icon">Build</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="utils.registry.html#ProgramData" class="tsd-kind-icon">Program<wbr/>Data</a></li></ul></section><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.registry.html#decodeUpgradeableLoaderState" class="tsd-kind-icon">decode<wbr/>Upgradeable<wbr/>Loader<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.registry.html#fetchData" class="tsd-kind-icon">fetch<wbr/>Data</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.registry.html#verifiedBuild" class="tsd-kind-icon">verified<wbr/>Build</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type Aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="Build" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Build<a href="#Build" 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">Build<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>aborted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>created_at<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>descriptor<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>docker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sha256<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>updated_at<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>upgrade_authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>verified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>verified_slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/acheroncrypto/anchor/blob/c029437a/ts/packages/anchor/src/utils/registry.ts#L96">packages/anchor/src/utils/registry.ts:96</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>aborted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>created_<wbr/>at<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>descriptor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>docker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>sha256<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>updated_<wbr/>at<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>upgrade_<wbr/>authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>verified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>verified_<wbr/>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="ProgramData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Program<wbr/>Data<a href="#ProgramData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Program<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><a href="../classes/BN.html" class="tsd-signature-type" data-tsd-kind="Class">BN</a><span class="tsd-signature-symbol">; </span>upgradeAuthorityAddress<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/acheroncrypto/anchor/blob/c029437a/ts/packages/anchor/src/utils/registry.ts#L91">packages/anchor/src/utils/registry.ts:91</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>slot<span class="tsd-signature-symbol">: </span><a href="../classes/BN.html" class="tsd-signature-type" data-tsd-kind="Class">BN</a></h5></li><li class="tsd-parameter"><h5>upgrade<wbr/>Authority<wbr/>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">null</span></h5></li></ul></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="decodeUpgradeableLoaderState" class="tsd-anchor"></a><h3 class="tsd-anchor-link">decode<wbr/>Upgradeable<wbr/>Loader<wbr/>State<a href="#decodeUpgradeableLoaderState" 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 tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">decode<wbr/>Upgradeable<wbr/>Loader<wbr/>State<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/acheroncrypto/anchor/blob/c029437a/ts/packages/anchor/src/utils/registry.ts#L87">packages/anchor/src/utils/registry.ts:87</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">Buffer</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="fetchData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fetch<wbr/>Data<a href="#fetchData" 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 tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">fetch<wbr/>Data<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>, programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="utils.registry.html#ProgramData" class="tsd-signature-type" data-tsd-kind="Type alias">ProgramData</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/acheroncrypto/anchor/blob/c029437a/ts/packages/anchor/src/utils/registry.ts#L46">packages/anchor/src/utils/registry.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
- <p>Returns the program data account for this program, containing the
- metadata for this program, e.g., the upgrade authority.</p>
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connection: <a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a></h5></li><li><h5>programId: <a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="utils.registry.html#ProgramData" class="tsd-signature-type" data-tsd-kind="Type alias">ProgramData</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="verifiedBuild" class="tsd-anchor"></a><h3 class="tsd-anchor-link">verified<wbr/>Build<a href="#verifiedBuild" 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 tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">verified<wbr/>Build<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>, programId<span class="tsd-signature-symbol">: </span><a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a>, limit<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="utils.registry.html#Build" class="tsd-signature-type" data-tsd-kind="Type alias">Build</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</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/acheroncrypto/anchor/blob/c029437a/ts/packages/anchor/src/utils/registry.ts#L11">packages/anchor/src/utils/registry.ts:11</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
- <p>Returns a verified build from the anchor registry. null if no such
- verified build exists, e.g., if the program has been upgraded since the
- last verified build.</p>
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connection: <a href="../classes/web3.Connection.html" class="tsd-signature-type" data-tsd-kind="Class">Connection</a></h5></li><li><h5>programId: <a href="../classes/web3.PublicKey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="utils.registry.html#Build" class="tsd-signature-type" data-tsd-kind="Type alias">Build</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></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="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="utils.registry.html">registry</a></li><li class=" 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-type-alias tsd-parent-kind-namespace"><a href="utils.registry.html#Build" class="tsd-kind-icon">Build</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="utils.registry.html#ProgramData" class="tsd-kind-icon">Program<wbr/>Data</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.registry.html#decodeUpgradeableLoaderState" class="tsd-kind-icon">decode<wbr/>Upgradeable<wbr/>Loader<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.registry.html#fetchData" class="tsd-kind-icon">fetch<wbr/>Data</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.registry.html#verifiedBuild" class="tsd-kind-icon">verified<wbr/>Build</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-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-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></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>
|