2022-04-12 15:47:53 -07:00
<!DOCTYPE html> < html class = "default" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > Loader | @project-serum/anchor - v0.24.1< / title > < meta name = "description" content = "Documentation for @project-serum/anchor - v0.24.1" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script async src = "../assets/search.js" id = "search-script" > < / script > < / head > < body > < script > document . body . classList . add ( localStorage . getItem ( "tsd-theme" ) || "os" ) < / script > < header > < div class = "tsd-page-toolbar" > < div class = "container" > < div class = "table-wrap" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label > < input type = "text" id = "tsd-search-field" / > < / div > < ul class = "results" > < li class = "state loading" > Preparing search index...< / li > < li class = "state failure" > The search index is not available< / li > < / ul > < a href = "../index.html" class = "title" > @project-serum/anchor - v0.24.1< / a > < / div > < div class = "table-cell" id = "tsd-widgets" > < div id = "tsd-filter" > < a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a > < div class = "tsd-filter-group" > < div class = "tsd-select" id = "tsd-filter-visibility" > < span class = "tsd-select-label" > All< / span > < ul class = "tsd-select-list" > < li data-value = "public" > Public< / li > < li data-value = "protected" > Public/Protected< / li > < li data-value = "private" class = "selected" > All< / li > < / ul > < / div > < input type = "checkbox" id = "tsd-filter-inherited" checked / > < label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label > < input type = "checkbox" id = "tsd-filter-externals" checked / > < label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label > < / div > < / div > < a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a > < / div > < / div > < / div > < / div > < div class = "tsd-page-title" > < div class = "container" > < ul class = "tsd-breadcrumb" > < li > < a href = "../index.html" > @project-serum/anchor - v0.24.1< / a > < / li > < li > < a href = "../modules/web3.html" > web3< / a > < / li > < li > < a href = "web3.Loader.html" > Loader< / a > < / li > < / ul > < h1 > Class Loader< / h1 > < / div > < / div > < / header > < div class = "container container-main" > < div class = "row" > < div class = "col-8 col-content" > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-12 07:42:08 -08:00
< p > Program loader interface< / p >
2022-04-12 15:47:53 -07:00
< / div > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h3 > Hierarchy< / h3 > < ul class = "tsd-hierarchy" > < li > < span class = "target" > Loader< / span > < / li > < / ul > < / section > < section class = "tsd-panel-group tsd-index-group" > < h2 > Index< / h2 > < section class = "tsd-panel tsd-index-panel" > < div class = "tsd-index-content" > < section class = "tsd-index-section tsd-is-external" > < h3 > Constructors< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-external" > < a href = "web3.Loader.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li > < / ul > < / section > < section class = "tsd-index-section tsd-is-external" > < h3 > Properties< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external" > < a href = "web3.Loader.html#chunkSize" class = "tsd-kind-icon" > chunk< wbr / > Size< / a > < / li > < / ul > < / section > < section class = "tsd-index-section tsd-is-external" > < h3 > Methods< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < a href = "web3.Loader.html#getMinNumSignatures" class = "tsd-kind-icon" > get< wbr / > Min< wbr / > Num< wbr / > Signatures< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < a href = "web3.Loader.html#load" class = "tsd-kind-icon" > load< / a > < / li > < / ul > < / section > < / div > < / section > < / section > < section class = "tsd-panel-group tsd-member-group tsd-is-external" > < h2 > Constructors< / h2 > < section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external" > < a id = "constructor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > constructor< a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external" > < li class = "tsd-signature tsd-kind-icon" > new < wbr / > Loader< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "web3.Loader.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Loader< / a > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < a href = "web3.Loader.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Loader< / a > < / h4 > < / li > < / ul > < / section > < / section > < section class = "tsd-panel-group tsd-member-group tsd-is-external" > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external" > < a id = "chunkSize" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagStatic" > Static< / span > chunk< wbr / > Size< a href = "#chunkSize" 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" > chunk< wbr / > Size< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@solana/web3.js/lib/index.d.ts:2148< / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-12 07:42:08 -08:00
< p > Amount of program data placed in each load Transaction< / p >
2022-04-12 15:47:53 -07:00
< / div > < / div > < / section > < / section > < section class = "tsd-panel-group tsd-member-group tsd-is-external" > < h2 > Methods< / h2 > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < a id = "getMinNumSignatures" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagStatic" > Static< / span > get< wbr / > Min< wbr / > Num< wbr / > Signatures< a href = "#getMinNumSignatures" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Min< wbr / > Num< wbr / > Signatures< span class = "tsd-signature-symbol" > (< / span > dataLength< 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" > number< / span > < / li > < / ul > < ul class = "tsd-descriptions" > < li class = "tsd-description" > < aside class = "tsd-sources" > < ul > < li > Defined in node_modules/@solana/web3.js/lib/index.d.ts:2155< / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-12 07:42:08 -08:00
< p > Minimum number of signatures required to load a program not including
retries< / p >
< / div > < div > < p > Can be used to calculate transaction fees< / p >
2022-04-12 15:47:53 -07:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > dataLength: < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < a id = "load" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagStatic" > Static< / span > load< a href = "#load" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < li class = "tsd-signature tsd-kind-icon" > load< span class = "tsd-signature-symbol" > (< / span > connection< span class = "tsd-signature-symbol" > : < / span > < a href = "web3.Connection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Connection< / a > , payer< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/web3.Signer.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Signer< / a > , program< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/web3.Signer.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Signer< / a > , programId< span class = "tsd-signature-symbol" > : < / span > < a href = "web3.PublicKey.html" class = "tsd-signature-type" data-tsd-kind = "Class" > PublicKey< / a > , data< 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" > Uint8Array< / span > < 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" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / 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 node_modules/@solana/web3.js/lib/index.d.ts:2166< / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-12 07:42:08 -08:00
< p > Loads a generic program< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > connection: < a href = "web3.Connection.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Connection< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The connection to use< / p >
< / div > < / div > < / li > < li > < h5 > payer: < a href = "../interfaces/web3.Signer.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Signer< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > System account that pays to load the program< / p >
< / div > < / div > < / li > < li > < h5 > program: < a href = "../interfaces/web3.Signer.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Signer< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Account to load the program into< / p >
< / div > < / div > < / li > < li > < h5 > programId: < a href = "web3.PublicKey.html" class = "tsd-signature-type" data-tsd-kind = "Class" > PublicKey< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Public key that identifies the loader< / p >
< / div > < / div > < / li > < li > < h5 > data: < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Buffer< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Program octets< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > true if program was loaded successfully, false if program was already loaded< / p >
2022-02-03 07:26:04 -08:00
< / div > < / li > < / ul > < / section > < / section > < / div > < div class = "col-4 col-menu menu-sticky-wrap menu-highlight" > < nav class = "tsd-navigation primary" > < ul > < li class = "" > < a href = "../index.html" > Exports< / a > < / li > < li class = "label tsd-is-external" > < span > Internals< / span > < / li > < li class = " tsd-kind-namespace" > < a href = "../modules/utils.html" > utils< / a > < / li > < li class = "label tsd-is-external" > < span > Externals< / span > < / li > < li class = " tsd-kind-namespace tsd-is-external" > < a href = "../modules/BN.html" > BN< / a > < / li > < li class = "current tsd-kind-namespace tsd-is-external" > < a href = "../modules/web3.html" > web3< / a > < / li > < / ul > < / nav > < nav class = "tsd-navigation secondary menu-sticky" > < ul > < li class = "current tsd-kind-class tsd-parent-kind-namespace tsd-is-external" > < a href = "web3.Loader.html" class = "tsd-kind-icon" > Loader< / a > < ul > < li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-external" > < a href = "web3.Loader.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external" > < a href = "web3.Loader.html#chunkSize" class = "tsd-kind-icon" > chunk< wbr / > Size< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < a href = "web3.Loader.html#getMinNumSignatures" class = "tsd-kind-icon" > get< wbr / > Min< wbr / > Num< wbr / > Signatures< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external" > < a href = "web3.Loader.html#load" class = "tsd-kind-icon" > load< / a > < / li > < / ul > < / li > < / ul > < / nav > < / div > < / div > < / div > < footer class = "with-border-bottom" > < div class = "container" > < h2 > Legend< / h2 > < div class = "tsd-legend-group" > < ul class = "tsd-legend" > < li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li > < / ul > < ul class = "tsd-legend" > < li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li > < / ul > < ul class = "tsd-legend" > < li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li > < li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li > < / ul > < ul class = "tsd-legend" > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li > < / ul > < / div > < h2 > Settings< / h2 > < p > Theme < select id = "theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / p > < / div > < / footer > < div class = "container tsd-generator" > < p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p > < / div > < div class = "overlay" > < / div > < script src = "../assets/main.js" > < / script > < / body > < / html >