Home Reference Source

Typedef

Static Public Summary
public

Information describing an account

public

Advance nonce account system instruction params

public

Assign system transaction params

public

Create nonce account system transaction params

public

Authorize nonce account system transaction params

public

Authorize stake instruction params

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

Extra contextual information for RPC responses

public

Create account system transaction params

public

Create account with seed system transaction params

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

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

public

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

public
public
public

Info used to identity validators.

public

Initialize nonce account system instruction params

public

Initialize stake instruction params

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 result

public

Signature status

public

Configuration object for changing query behavior

public

Information about the latest slot being processed by a node

public

Split stake instruction params

public
public

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

An enumeration of valid StakeInstructionType's

public

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

An enumeration of valid SystemInstructionType's

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

Transaction error

public

List of TransactionInstruction object fields that may be initialized at construction

public
public

Transfer system transaction params

public

Version info for a node

public

Information describing a vote account

public

A collection of cluster vote accounts

public

Withdraw nonce account system transaction params

public

Withdraw stake instruction params

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 AdvanceNonceParams: Object source

Advance nonce account system instruction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
programId PublicKey

public AssignParams: Object source

Assign system transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
programId PublicKey

public AssignParams: Object source

Create nonce account system transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
programId PublicKey

public AuthorizeNonceParams: Object source

Authorize nonce account system transaction params

Properties:

NameTypeAttributeDescription
noncePubkey PublicKey
authorizedPubkey PublicKey
newAuthorizedPubkey PublicKey

public AuthorizeStakeParams: Object source

Authorize stake instruction params

Properties:

NameTypeAttributeDescription
stakePubkey PublicKey
authorizedPubkey PublicKey
newAuthorizedPubkey PublicKey
stakeAuthorizationType StakeAuthorizationType

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 Context: Object source

Extra contextual information for RPC responses

Properties:

NameTypeAttributeDescription
slot number

public CreateAccountParams: Object source

Create account system transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
newAccountPubkey PublicKey
lamports number
space number
programId PublicKey

public CreateAccountWithSeedParams: Object source

Create account with seed system transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
newAccountPubkey PublicKey
basePubkey PublicKey
seed string
lamports number
space number
programId PublicKey

public CreateStakeAccountParams: Object source

Create stake account transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
stakePubkey PublicKey
authorized Authorized
lockup Lockup
lamports number

public CreateStakeAccountWithSeedParams: Object source

Create stake account with seed transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
stakePubkey PublicKey
basePubkey PublicKey
seed string
authorized Authorized
lockup Lockup
lamports number

public DeactivateStakeParams: Object source

Deactivate stake instruction params

Properties:

NameTypeAttributeDescription
stakePubkey PublicKey
authorizedPubkey PublicKey

public DelegateStakeParams: Object source

Delegate stake instruction params

Properties:

NameTypeAttributeDescription
stakePubkey PublicKey
authorizedPubkey PublicKey
votePubkey PublicKey

public EpochInfo: Object source

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

Properties:

NameTypeAttributeDescription
epoch number
slotIndex number
slotsInEpoch number
absoluteSlot number

public EpochSchedule: Object source

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

Properties:

NameTypeAttributeDescription
slotsPerEpoch number

The maximum number of slots in each epoch

leaderScheduleSlotOffset number

The number of slots before beginning of an epoch to calculate a leader schedule for that epoch

warmup boolean

Indicates whether epochs start short and grow

firstNormalEpoch number

The first epoch with slotsPerEpoch slots

firstNormalSlot number

The first slot of firstNormalEpoch

public FeeCalculator: Object source

Properties:

NameTypeAttributeDescription
lamportsPerSignature number

lamports Cost in lamports to validate a signature

public Inflation: Object source

Network Inflation parameters (see https://docs.solana.com/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 InitializeNonceParams: Object source

Initialize nonce account system instruction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
programId PublicKey

public InitializeStakeParams: Object source

Initialize stake instruction params

Properties:

NameTypeAttributeDescription
stakePubkey PublicKey
authorized Authorized
lockup Lockup

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 Context
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 SignatureResult: Object source

Signature result

public SignatureStatus: Object source

Signature status

Properties:

NameTypeAttributeDescription
slot number

when the transaction was processed

confirmations number | null

the number of blocks that have been confirmed and voted on in the fork containing slot (TODO)

err TransactionError | null

error, if any

public SignatureStatusConfig: Object source

Configuration object for changing query behavior

Properties:

NameTypeAttributeDescription
searchTransactionHistory boolean

enable searching status history, not needed for recent transactions

public SlotInfo: Object source

Information about the latest slot being processed by a node

Properties:

NameTypeAttributeDescription
slot number

Currently processing slot

parent number

Parent of the current slot

root number

The root block of the current slot's fork

public SplitStakeParams: Object source

Split stake instruction params

Properties:

NameTypeAttributeDescription
stakePubkey PublicKey
authorizedPubkey PublicKey
splitStakePubkey PublicKey
lamports number

public StakeAuthorizationType: Object source

Properties:

NameTypeAttributeDescription
(index} *

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

public StakeInstructionType: 'Initialize' | 'Authorize' | 'Delegate' | 'Split' | 'Withdraw' | 'Deactivate' source

An enumeration of valid StakeInstructionType's

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

An enumeration of valid SystemInstructionType's

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

Transaction error

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 TransferParams: Object source

Transfer system transaction params

Properties:

NameTypeAttributeDescription
fromPubkey PublicKey
toPubkey PublicKey
lamports number

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

public WithdrawNonceParams: Object source

Withdraw nonce account system transaction params

Properties:

NameTypeAttributeDescription
noncePubkey PublicKey
authorizedPubkey PublicKey
toPubkey PublicKey
lamports number

public WithdrawStakeParams: Object source

Withdraw stake instruction params

Properties:

NameTypeAttributeDescription
stakePubkey PublicKey
authorizedPubkey PublicKey
toPubkey PublicKey
lamports number