Typedef
| Static Public Summary | ||
| public |
Pair of an account address and its balance |
|
| public |
Information describing an account |
|
| public |
Account metadata used to define instructions |
|
| 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 |
Authorize stake instruction params |
|
| public |
Authorize stake instruction params using a derived key |
|
| public |
|
|
| public |
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 |
An instruction to execute by a program |
|
| 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 |
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 |
Create a Secp256k1 instruction using a private key params |
|
| public |
Create a Secp256k1 instruction using a public key 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 |
Information about the current epoch |
|
| public |
Epoch schedule (see https://docs.solana.com/terminology#epoch) |
|
| public |
|
|
| public |
Configuration object for changing |
|
| public |
Network Inflation (see https://docs.solana.com/implemented-proposals/ed_overview) |
|
| 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 |
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 |
Leader schedule (see https://docs.solana.com/terminology#leader-schedule) |
|
| public |
Message constructor arguments |
|
| public |
The message header, identifying signed and read-only account |
|
| public |
NonceInformation to be used to build a Transaction. |
|
| 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 partially decoded transaction instruction |
|
| public |
A parsed transaction message account |
|
| public |
A parsed transaction |
|
| public |
A performance sample |
|
| public |
RPC Response with extra contextual information |
|
| public |
Options for sending transactions |
|
| public |
Configuration object for Transaction.serialize() |
|
| 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 |
Stake Activation data |
|
| public |
|
|
| public |
StakeInstructionType: 'Initialize' | 'Authorize' | 'AuthorizeWithSeed' | 'Delegate' | 'Split' | 'Withdraw' | 'Deactivate' An enumeration of valid StakeInstructionType's |
|
| public |
Supply |
|
| public |
SystemInstructionType: 'Create' | 'Assign' | 'Transfer' | 'CreateWithSeed' | 'AdvanceNonceAccount' | 'WithdrawNonceAccount' | 'InitializeNonceAccount' | 'AuthorizeNonceAccount' An enumeration of valid SystemInstructionType's |
|
| public |
Token address and balance. |
|
| public |
Token amount object which returns a token amount in different formats for various client use cases. |
|
| 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 |
Transfer with seed 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 AuthorizeStakeParams: Object source
Authorize stake instruction params
Properties:
| Name | Type | Attribute | Description |
| stakePubkey | PublicKey | ||
| authorizedPubkey | PublicKey | ||
| newAuthorizedPubkey | PublicKey | ||
| stakeAuthorizationType | StakeAuthorizationType | ||
| custodianPubkey | PublicKey |
public AuthorizeWithSeedStakeParams: Object source
Authorize stake instruction params using a derived key
public Commitment: 'max' | 'recent' | 'root' | 'single' | 'singleGossip' source
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 CompiledInstruction: Object source
An instruction to execute by a program
Properties:
| Name | Type | Attribute | Description |
| programIdIndex | number | Index into the transaction keys array indicating the program account that executes this instruction |
|
| accounts | number[] | Ordered indices into the transaction keys array indicating which accounts to pass to the program |
|
| data | string | The program input data encoded as base 58 |
public ConfirmOptions: Object source
Options for confirming transactions
Properties:
| Name | Type | Attribute | Description |
| skipPreflight | boolean | undefined | disable transaction verification step |
|
| commitment | Commitment | undefined | desired commitment level |
|
| preflightCommitment | Commitment | undefined | preflight commitment level |
public ConfirmedBlock: Object source
A ConfirmedBlock on the ledger
Properties:
| Name | Type | Attribute | Description |
| 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 ConfirmedSignatureInfo: Object source
A confirmed signature with its status
Properties:
| Name | Type | Attribute | Description |
| signature | string | the transaction signature |
|
| slot | number | when the transaction was processed |
|
| err | TransactionError | null | error, if any |
|
| memo | string | null | memo associated with the transaction, if any |
|
| blockTime | number | null | undefined | The unix timestamp of when the transaction was processed |
public ConfirmedSignaturesForAddress2Options: Object source
Options for getConfirmedSignaturesForAddress2
Properties:
| Name | Type | Attribute | Description |
| before | TransactionSignature | undefined | start searching backwards from this transaction signature. If not provided the search starts from the highest max confirmed block. |
|
| limit | number | undefined | maximum transaction signatures to return (between 1 and 1,000, default: 1,000). |
public ConfirmedTransaction: Object source
A confirmed transaction on the ledger
Properties:
| Name | Type | Attribute | Description |
| slot | number | The slot during which the transaction was processed |
|
| transaction | Transaction | The details of the transaction |
|
| meta | ConfirmedTransactionMeta | null | Metadata produced from the transaction |
|
| blockTime | number | null | undefined | The unix timestamp of when the transaction was processed |
public ConfirmedTransactionMeta: Object source
Metadata for a confirmed transaction on the ledger
Properties:
| Name | Type | Attribute | Description |
| fee | number | The fee charged for processing the transaction |
|
| innerInstructions | Array<CompiledInnerInstruction> | An array of cross program invoked instructions |
|
| preBalances | Array<number> | The balances of the transaction accounts before processing |
|
| postBalances | Array<number> | The balances of the transaction accounts after processing |
|
| logMessages | Array<string> | An array of program log messages emitted during a transaction |
|
| preTokenBalances | Array<TokenBalance> | The token balances of the transaction accounts before processing |
|
| postTokenBalances | Array<TokenBalance> | The token balances of the transaction accounts after processing |
|
| err | object | null | The error result of transaction processing |
public ContactInfo: Object source
Information describing a cluster node
Properties:
| Name | Type | Attribute | Description |
| pubkey | string | Identity public key of the node |
|
| gossip | string | null | Gossip network address for the node |
|
| tpu | string | null | TPU network address for the node (null if not available) |
|
| rpc | string | null | JSON RPC network address for the node (null if not available) |
|
| version | string | null | Software version of the node (null if not available) |
public Context: Object source
Extra contextual information for RPC responses
Properties:
| Name | Type | Attribute | Description |
| slot | number |
public CreateAccountWithSeedParams: Object source
Create account with seed system transaction params
public CreateNonceAccountWithSeedParams: Object source
Create nonce account with seed system transaction params
public CreateSecp256k1InstructionWithPrivateKeyParams: Object source
Create a Secp256k1 instruction using a private key params
public CreateSecp256k1InstructionWithPublicKeyParams: Object source
Create a Secp256k1 instruction using a public key params
public CreateStakeAccountParams: Object source
Create stake account transaction params
Properties:
| Name | Type | Attribute | Description |
| fromPubkey | PublicKey | ||
| stakePubkey | PublicKey | ||
| authorized | Authorized | ||
| lockup | Lockup | ||
| lamports | number |
public CreateStakeAccountWithSeedParams: Object source
Create stake account with seed transaction params
public EpochSchedule: Object source
Epoch schedule (see https://docs.solana.com/terminology#epoch)
Properties:
| Name | Type | Attribute | Description |
| 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 |
|
| firstNormalSlot | number | The first slot of |
public FeeCalculator: Object source
Properties:
| Name | Type | Attribute | Description |
| lamportsPerSignature | number | lamports Cost in lamports to validate a signature |
public GetLargestAccountsConfig: Object source
Configuration object for changing getLargestAccounts query behavior
Properties:
| Name | Type | Attribute | Description |
| commitment | Commitment | undefined | The level of commitment desired |
|
| filter | LargestAccountsFilter | undefined | Filter largest accounts by whether they are part of the circulating supply |
public InflationGovernor: Object source
Network Inflation (see https://docs.solana.com/implemented-proposals/ed_overview)
public Info: Object source
Info used to identity validators.
Properties:
| Name | Type | Attribute | Description |
| name | string | validator name |
|
| website | string |
|
optional, validator website |
| details | string |
|
optional, extra information the validator chose to share |
| keybaseUsername | string |
|
optional, used to identify validators on keybase.io |
public InitializeStakeParams: Object source
Initialize stake instruction params
Properties:
| Name | Type | Attribute | Description |
| stakePubkey | PublicKey | ||
| authorized | Authorized | ||
| lockup | Lockup |
public InstructionType: Object source
Properties:
| Name | Type | Attribute | Description |
| (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:
| Name | Type | Attribute | Description |
| accountId | PublicKey | ||
| accountInfo | AccountInfo<Buffer> |
public LargestAccountsFilter: 'circulating' | 'nonCirculating' source
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 LeaderSchedule: Object source
Leader schedule (see https://docs.solana.com/terminology#leader-schedule)
public MessageArgs: Object source
Message constructor arguments
Properties:
| Name | Type | Attribute | Description |
| header | MessageHeader | The message header, identifying signed and read-only |
|
| accounts | string[] | All the account keys used by this transaction |
|
| recentBlockhash | Blockhash | The hash of a recent ledger block |
|
| instructions | CompiledInstruction[] | Instructions that will be executed in sequence and committed in one atomic transaction if all succeed. |
public MessageHeader: Object source
The message header, identifying signed and read-only account
Properties:
| Name | Type | Attribute | Description |
| numRequiredSignatures | number | The number of signatures required for this message to be considered valid. The
signatures must match the first |
|
| numReadonlySignedAccounts: | number | The last |
|
| numReadonlyUnsignedAccounts | number | The last |
public NonceInformation: Object source
NonceInformation to be used to build a Transaction.
Properties:
| Name | Type | Attribute | Description |
| nonce | Blockhash | The current Nonce blockhash |
|
| nonceInstruction | TransactionInstruction | AdvanceNonceAccount Instruction |
public ParsedConfirmedTransaction: Object source
A parsed and confirmed transaction on the ledger
Properties:
| Name | Type | Attribute | Description |
| slot | number | The slot during which the transaction was processed |
|
| transaction | ParsedTransaction | The details of the transaction |
|
| meta | ConfirmedTransactionMeta | null | Metadata produced from the transaction |
|
| blockTime | number | null | undefined | The unix timestamp of when the transaction was processed |
public ParsedConfirmedTransactionMeta: Object source
Metadata for a parsed confirmed transaction on the ledger
Properties:
| Name | Type | Attribute | Description |
| fee | number | The fee charged for processing the transaction |
|
| innerInstructions | Array<ParsedInnerInstruction> | An array of cross program invoked parsed instructions |
|
| preBalances | Array<number> | The balances of the transaction accounts before processing |
|
| postBalances | Array<number> | The balances of the transaction accounts after processing |
|
| logMessages | Array<string> | An array of program log messages emitted during a transaction |
|
| preTokenBalances | Array<TokenBalance> | The token balances of the transaction accounts before processing |
|
| postTokenBalances | Array<TokenBalance> | The token balances of the transaction accounts after processing |
|
| err | object | null | The error result of transaction processing |
public ParsedMessage: Object source
A parsed transaction message
Properties:
| Name | Type | Attribute | Description |
| accountKeys | Array<ParsedMessageAccount> | Accounts used in the instructions |
|
| instructions | Array<ParsedInstruction|PartiallyDecodedInstruction> | The atomically executed instructions for the transaction |
|
| recentBlockhash | string | Recent blockhash |
public ParsedTransaction: Object source
A parsed transaction
Properties:
| Name | Type | Attribute | Description |
| signatures | Array<string> | Signatures for the transaction |
|
| message | ParsedMessage | Message of the transaction |
public RpcResponseAndContext: Object source
RPC Response with extra contextual information
Properties:
| Name | Type | Attribute | Description |
| context | Context | ||
| value | T | response |
public SendOptions: Object source
Options for sending transactions
Properties:
| Name | Type | Attribute | Description |
| skipPreflight | boolean | undefined | disable transaction verification step |
|
| preflightCommitment | Commitment | undefined | preflight commitment level |
public SignatureStatus: Object source
Signature status
Properties:
| Name | Type | Attribute | Description |
| 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 |
|
| err | TransactionError | null | error, if any |
|
| confirmationStatus | string | null | the transaction's cluster confirmation status, if data available. Possible non-null responses: |
public SignatureStatusConfig: Object source
Configuration object for changing query behavior
Properties:
| Name | Type | Attribute | Description |
| searchTransactionHistory | boolean | enable searching status history, not needed for recent transactions |
public StakeAuthorizationType: Object source
Properties:
| Name | Type | Attribute | Description |
| (index} | * | The Stake Authorization index (from solana-stake-program) |
public StakeInstructionType: 'Initialize' | 'Authorize' | 'AuthorizeWithSeed' | '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 TokenAmount: Object source
Token amount object which returns a token amount in different formats for various client use cases.
public TransactionCtorFields: Object source
List of Transaction object fields that may be initialized at construction
public TransactionInstructionCtorFields: Object source
List of TransactionInstruction object fields that may be initialized at construction
public Version: Object source
Version info for a node
Properties:
| Name | Type | Attribute | Description |
| solana-core | string | Version of solana-core |
public VoteAccountInfo: Object source
Information describing a vote account
Properties:
| Name | Type | Attribute | Description |
| 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:
| Name | Type | Attribute | Description |
| current | Array<VoteAccountInfo> | Active vote accounts |
|
| delinquent | Array<VoteAccountInfo> | Inactive vote accounts |
