Typedef
Static Public Summary | ||
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 |
|
|
public |
A condition that can unlock a payment |
|
public |
Commitment: 'max' | 'recent' | 'root' | 'single' 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 |
|
public |
An instruction to execute by a program |
|
public |
A ConfirmedBlock on the ledger |
|
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 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 |
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 |
Message constructor arguments |
|
public |
The message header, identifying signed and read-only account |
|
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 |
|
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 |
|
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:
Name | Type | Attribute | Description |
lamports | number | Number of lamports assigned to the account |
|
owner | PublicKey | Identifier of the program that owns the account |
|
data | Buffer |
|
Optional data assigned to the account |
executable | boolean |
|
public AuthorizeStakeParams: Object source
Authorize stake instruction params
Properties:
Name | Type | Attribute | Description |
stakePubkey | PublicKey | ||
authorizedPubkey | PublicKey | ||
newAuthorizedPubkey | PublicKey | ||
stakeAuthorizationType | StakeAuthorizationType |
public BudgetCondition: SignatureCondition | TimestampCondition source
A condition that can unlock a payment
public Commitment: 'max' | 'recent' | 'root' | 'single' 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
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 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 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 |
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 |
|
preBalances | Array<number> | The balances of the transaction accounts before processing |
|
postBalances | Array<number> | The 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 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 Inflation: 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 |
public MessageArgs: Object source
Message constructor arguments
Properties:
Name | Type | Attribute | Description |
header | MessageHeader | The message header, identifying signed and read-only |
|
accounts | PublicKey[] | 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 |
|
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 RpcResponseAndContext: Object source
RPC Response with extra contextual information
Properties:
Name | Type | Attribute | Description |
context | Context | ||
value | T | response |
public SignatureCondition: Object source
Represents a condition that is met by executing a applySignature()
transaction
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 |
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' | '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
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 |