Home Reference Source

References

summary
public

An account key pair (public and secret keys).

public
public

Factory class for transactions to interact with a program loader

public

A connection to a fullnode JSON RPC endpoint

public

C Loader

Program loader interface

public

List of instructions to be processed atomically

public

NonceAccount class

public

A public key

public
public
public

C Lockup

public

Stake Instruction class

public

Factory class for transactions to interact with the Stake program

public

System Instruction class

public

Factory class for transactions to interact with the System program

public

Transaction class

public

Transaction Instruction class

public

ValidatorInfo class

public

VoteAccount class

public

F decodeData(type: *, buffer: *): *

Decode instruction data buffer using an InstructionType

public

F encodeData(type: *, fields: *): *

Populate a buffer of instruction data using an InstructionType

public

F authorized(property: string): *

Layout for an Authorized object

public

F getAlloc(type: Object, fields: Object): number

public

F lockup(property: string): *

Layout for a Lockup object

public

F publicKey(property: string): *

Layout for a public key

public

F rustString(property: string): *

Layout for a Rust String type

public

F uint64(property: string): *

Layout for a 64bit unsigned value

public
public
public
public
public

Expected JSON RPC response for the "getConfirmedBlock" message

public

There are 1-billion lamports in one SOL

public
public

Maximum length of derived pubkey seed

public
public

An enumeration of valid stake InstructionType's

public

An enumeration of valid StakeAuthorizationLayout's

public

An enumeration of valid system InstructionType's

public
public
public
public
public
public
public

Maximum over-the-wire size of a Transaction

public
public
public
public

Pair of an account address and its balance

public

Information describing an account

public

T Commitment: 'max' | 'recent' | 'root' | 'single' | 'singleGossip'

The level of commitment desired when querying state

  'max':    Query the most recent block which has been finalized by the cluster
  'recent': Query the most recent block which has reached 1 confirmation by the connected node
  'root':   Query the most recent block which has been rooted by the connected node
  'single': Query the most recent block which has reached 1 confirmation by the cluster
  'singleGossip': Query the most recent block which has reached 1 confirmation according to votes seen in gossip

public

Options for confirming transactions

public

A ConfirmedBlock on the ledger

public

A confirmed signature with its status

public

Options for getConfirmedSignaturesForAddress2

public

A confirmed transaction on the ledger

public

Metadata for a confirmed transaction on the ledger

public

Information describing a cluster node

public

Extra contextual information for RPC responses

public

Information about the current epoch

public
public

Configuration object for changing getLargestAccounts query behavior

public
public

Account information identified by pubkey

public

T LargestAccountsFilter: 'circulating' | 'nonCirculating'

Filter for largest accounts query

  'circulating':    Return the largest accounts that are part of the circulating supply
  'nonCirculating': Return the largest accounts that are not part of the circulating supply

public
public

Parsed account data

public

A parsed and confirmed transaction on the ledger

public

Metadata for a parsed confirmed transaction on the ledger

public

A parsed transaction instruction

public

A parsed transaction message

public

A parsed transaction message account

public

A partially decoded transaction instruction

public

A parsed transaction

public

A performance sample

public

RPC Response with extra contextual information

public

Options for sending transactions

public

Signature result

public

Signature status

public

Configuration object for changing query behavior

public

Information about the latest slot being processed by a node

public

Stake Activation data

public

Supply

public

Token address and balance.

public

Token amount object which returns a token amount in different formats for various client use cases.

public

Transaction error

public

Version info for a node

public

Information describing a vote account

public

A collection of cluster vote accounts

public
public
public

An instruction to execute by a program

public

Message constructor arguments

public

The message header, identifying signed and read-only account

public

Create a Secp256k1 instruction using a private key params

public

Create a Secp256k1 instruction using a public key params

public

Authorize stake instruction params

public

Authorize stake instruction params using a derived key

public

Create stake account transaction params

public

Create stake account with seed transaction params

public

Deactivate stake instruction params

public

Delegate stake instruction params

public

Initialize stake instruction params

public

Split stake instruction params

public
public

T StakeInstructionType: 'Initialize' | 'Authorize' | 'AuthorizeWithSeed' | 'Delegate' | 'Split' | 'Withdraw' | 'Deactivate'

An enumeration of valid StakeInstructionType's

public

Withdraw stake instruction params

public

Advance nonce account system instruction params

public

Allocate account system transaction params

public

Allocate account with seed system transaction params

public

Assign system transaction params

public

Assign account with seed system transaction params

public

Authorize nonce account system transaction params

public

Create account system transaction params

public

Create account with seed system transaction params

public

Create nonce account system transaction params

public

Create nonce account with seed system transaction params

public

Initialize nonce account system instruction params

public

T SystemInstructionType: 'Create' | 'Assign' | 'Transfer' | 'CreateWithSeed' | 'AdvanceNonceAccount' | 'WithdrawNonceAccount' | 'InitializeNonceAccount' | 'AuthorizeNonceAccount'

An enumeration of valid SystemInstructionType's

public

Transfer system transaction params

public

Transfer with seed system transaction params

public

Withdraw nonce account system transaction params

public

Account metadata used to define instructions

public

NonceInformation to be used to build a Transaction.

public

Configuration object for Transaction.serialize()

public

List of Transaction object fields that may be initialized at construction

public

List of TransactionInstruction object fields that may be initialized at construction

public
public

Info used to identity validators.

util

summary
public

F clusterApiUrl(cluster: *, tls: *): *

Retrieves the RPC API URL for the specified cluster

public

F promiseTimeout(promise: Promise<T>, timeoutMs: number): Promise<T|nullliteral>

public

F async sendAndConfirmRawTransaction(connection: Connection, rawTransaction: Buffer, options: ConfirmOptions): Promise<TransactionSignature>

Send and confirm a raw transaction

public

F async sendAndConfirmTransaction(connection: Connection, transaction: Transaction, signers: Array<Account>, options: ConfirmOptions): Promise<TransactionSignature>

Sign, send and confirm a transaction.

public
public

F encodeLength(bytes: Array<number>, len: number)

public

F sleep(ms: number): Promise<void>

public

F toBuffer(arr: *): *

Directories