Home Reference Source

Typedef

Static Public Summary
public

Information describing an account

public
public

A condition that can unlock a payment

public

Commitment: 'max' | 'recent'

The level of commitment desired when querying state 'max': Query the most recent block which has reached max voter lockout 'recent': Query the most recent block

public

A ConfirmedBlock on the ledger

public

Information describing a cluster node

public
public
public
public
public

Info used to identity validators.

public
public

Account information identified by pubkey

public

NonceInformation to be used to build a Transaction.

public

Represents a payment to a given public key

public

RPC Response with extra contextual information

public

Represents a condition that is met by executing a applySignature() transaction

public

Signature status: Success

public
public

Represents a condition that is met by executing a applyTimestamp() transaction

public

List of Transaction object fields that may be initialized at construction

public

Signature status: TransactionError

public

List of TransactionInstruction object fields that may be initialized at construction

public
public

Version info for a node

public

Information describing a vote account

public

A collection of cluster vote accounts

Static Public

public AccountInfo: Object source

Information describing an account

Properties:

NameTypeAttributeDescription
lamports number

Number of lamports assigned to the account

owner PublicKey

Identifier of the program that owns the account

data Buffer
  • nullable: true

Optional data assigned to the account

executable boolean

true if this account's data contains a loaded program

public Blockhash: string source

public BudgetCondition: SignatureCondition | TimestampCondition source

A condition that can unlock a payment

public Commitment: 'max' | 'recent' source

The level of commitment desired when querying state 'max': Query the most recent block which has reached max voter lockout 'recent': Query the most recent block

public ConfirmedBlock: Object source

A ConfirmedBlock on the ledger

Properties:

NameTypeAttributeDescription
blockhash Blockhash

Blockhash of this block

previousBlockhash Blockhash

Blockhash of this block's parent

parentSlot number

Slot index of this block's parent

transactions Array<object>

Vector of transactions and status metas

rewards Array<object>

Vector of block rewards

public ContactInfo: Object source

Information describing a cluster node

Properties:

NameTypeAttributeDescription
pubkey string

Identity public key of the node

gossip string

Gossip network address for the node

tpu string

TPU network address for the node (null if not available)

rpc string | null

JSON RPC network address for the node (null if not available)

public EpochInfo: Object source

EpochInfo parameters (see https://docs.solana.com/book/v/master/terminology#epoch)

Properties:

NameTypeAttributeDescription
epoch number
slotIndex number
slotsInEpoch number
absoluteSlot number

public EpochSchedule: Object source

EpochSchedule parameters (see https://docs.solana.com/book/v/master/terminology#epoch)

Properties:

NameTypeAttributeDescription
slots_per_epoch number
leader_schedule_slot_offset number
warmup boolean
first_normal_epoch number
first_normal_slot number

public FeeCalculator: Object source

Properties:

NameTypeAttributeDescription
lamportsPerSignature number

lamports Cost in lamports to validate a signature

targetLamportsPerSignature number
targetSignaturesPerSlot number

public Inflation: Object source

Network Inflation parameters (see https://docs.solana.com/book/v/master/implemented-proposals/ed_overview)

Properties:

NameTypeAttributeDescription
foundation number
foundation_term number
initial number
storage number
taper number
terminal number

public Info: Object source

Info used to identity validators.

Properties:

NameTypeAttributeDescription
name string

validator name

website string
  • nullable: true

optional, validator website

details string
  • nullable: true

optional, extra information the validator chose to share

keybaseUsername string
  • nullable: true

optional, used to identify validators on keybase.io

public InstructionType: Object source

Properties:

NameTypeAttributeDescription
(index} *

The Instruction index (from solana upstream program)

(BufferLayout} *

The BufferLayout to use to build data

public KeyedAccountInfo: Object source

Account information identified by pubkey

Properties:

NameTypeAttributeDescription
accountId PublicKey
accountInfo AccountInfo

public NonceInformation: Object source

NonceInformation to be used to build a Transaction.

Properties:

NameTypeAttributeDescription
The nonce

current Nonce blockhash

The nonceInstruction

AdvanceNonceAccount Instruction

public Payment: Object source

Represents a payment to a given public key

Properties:

NameTypeAttributeDescription
amount number

Number of lamports

to PublicKey

Public key of the recipient

public RpcResponseAndContext: Object source

RPC Response with extra contextual information

Properties:

NameTypeAttributeDescription
context {slot: number}
value T

response

public SignatureCondition: Object source

Represents a condition that is met by executing a applySignature() transaction

Properties:

NameTypeAttributeDescription
type string

Must equal the string 'timestamp'

from PublicKey

Public key from which applySignature() will be accepted from

public SignatureSuccess: Object source

Signature status: Success

public StakeAuthorizationType: Object source

Properties:

NameTypeAttributeDescription
(index} *

The Stake Authorization index (from solana-stake-program)

public TimestampCondition: Object source

Represents a condition that is met by executing a applyTimestamp() transaction

Properties:

NameTypeAttributeDescription
type string

Must equal the string 'timestamp'

from PublicKey

Public key from which applyTimestamp() will be accepted from

when Date

The timestamp that was observed

public TransactionCtorFields: Object source

List of Transaction object fields that may be initialized at construction

Properties:

NameTypeAttributeDescription
(?recentBlockhash} *

A recent block hash

(?signatures} *

One or more signatures

public TransactionError: Object source

Signature status: TransactionError

public TransactionInstructionCtorFields: Object source

List of TransactionInstruction object fields that may be initialized at construction

Properties:

NameTypeAttributeDescription
keys Array<PublicKey>
  • nullable: true
programId PublicKey
  • nullable: true
data Buffer
  • nullable: true

public TransactionSignature: string source

public Version: Object source

Version info for a node

Properties:

NameTypeAttributeDescription
solana-core string

Version of solana-core

public VoteAccountInfo: Object source

Information describing a vote account

Properties:

NameTypeAttributeDescription
votePubkey string

Public key of the vote account

nodePubkey string

Identity public key of the node voting with this account

activatedStake number

The stake, in lamports, delegated to this vote account and activated

epochVoteAccount boolean

Whether the vote account is staked for this epoch

epochCredits Array<Array<number>>

Recent epoch voting credit history for this voter

commission number

A percentage (0-100) of rewards payout owed to the voter

lastVote number

Most recent slot voted on by this vote account

public VoteAccountStatus: Object source

A collection of cluster vote accounts

Properties:

NameTypeAttributeDescription
current Array<VoteAccountInfo>

Active vote accounts

delinquent Array<VoteAccountInfo>

Inactive vote accounts