Home Reference Source

Typedef

Static Public Summary
public

Information describing an account

public
public

A condition that can unlock a payment

public

Information describing a cluster node

public
public

Network Inflation parameters

public

Info used to identity validators.

public

Account information identified by pubkey

public

Represents a payment to a given public key

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

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 Blockhhash: string source

public BudgetCondition: SignatureCondition | TimestampCondition source

A condition that can unlock a payment

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 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

Properties:

NameTypeAttributeDescription
foundation number

TODO - link to book terminology?

foundation_term number

TODO - link to book terminology?

grant number

TODO - link to book terminology?

grant_term number

TODO - link to book terminology?

initial number

TODO - link to book terminology?

storage number

TODO - link to book terminology?

taper number

TODO - link to book terminology?

terminal number

TODO - link to book terminology?

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

Account information identified by pubkey

Properties:

NameTypeAttributeDescription
accountId PublicKey
accountInfo AccountInfo

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

Properties:

NameTypeAttributeDescription
(index} *

The System Instruction index (from solana-sdk)

(BufferLayout} *

The BufferLayout to use to build data

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 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

commission number

A 8-bit unsigned integer used as a fraction (commission/0xFF) for rewards payout

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