@solana/web3.js 1.31.0 → 1.33.0

package/lib/index.d.ts

@@ -53,6 +53,7 @@ declare module '@solana/web3.js' {
      * Return the base-58 representation of the public key
      */
     toBase58(): string;
+    toJSON(): string;
     /**
      * Return the byte array representation of the public key
      */
@@ -534,6 +535,8 @@ declare module '@solana/web3.js' {
     skipPreflight?: boolean;
     /** preflight commitment level */
     preflightCommitment?: Commitment;
+    /** Maximum number of times for the RPC node to retry sending the transaction to the leader. */
+    maxRetries?: number;
   };
   /**
    * Options for confirming transactions
@@ -545,6 +548,8 @@ declare module '@solana/web3.js' {
     commitment?: Commitment;
     /** preflight commitment level */
     preflightCommitment?: Commitment;
+    /** Maximum number of times for the RPC node to retry sending the transaction to the leader. */
+    maxRetries?: number;
   };
   /**
    * Options for getConfirmedSignaturesForAddress2
@@ -759,12 +764,19 @@ declare module '@solana/web3.js' {
   export type TokenBalance = {
     accountIndex: number;
     mint: string;
+    owner?: string;
     uiTokenAmount: TokenAmount;
   };
   /**
    * Metadata for a parsed confirmed transaction on the ledger
+   *
+   * @deprecated Deprecated since Solana v1.8.0. Please use {@link ParsedTransactionMeta} instead.
+   */
+  export type ParsedConfirmedTransactionMeta = ParsedTransactionMeta;
+  /**
+   * Metadata for a parsed transaction on the ledger
    */
-  export type ParsedConfirmedTransactionMeta = {
+  export type ParsedTransactionMeta = {
     /** The fee charged for processing the transaction */
     fee: number;
     /** An array of cross program invoked parsed instructions */
@@ -893,14 +905,20 @@ declare module '@solana/web3.js' {
   };
   /**
    * A parsed and confirmed transaction on the ledger
+   *
+   * @deprecated Deprecated since Solana v1.8.0. Please use {@link ParsedTransactionWithMeta} instead.
    */
-  export type ParsedConfirmedTransaction = {
+  export type ParsedConfirmedTransaction = ParsedTransactionWithMeta;
+  /**
+   * A parsed transaction on the ledger with meta
+   */
+  export type ParsedTransactionWithMeta = {
     /** The slot during which the transaction was processed */
     slot: number;
     /** The details of the transaction */
     transaction: ParsedTransaction;
     /** Metadata produced from the transaction */
-    meta: ParsedConfirmedTransactionMeta | null;
+    meta: ParsedTransactionMeta | null;
     /** The unix timestamp of when the transaction was processed */
     blockTime?: number | null;
   };
@@ -966,9 +984,9 @@ declare module '@solana/web3.js' {
     blockTime: number | null;
   };
   /**
-   * A ConfirmedBlock on the ledger with signatures only
+   * A Block on the ledger with signatures only
    */
-  export type ConfirmedBlockSignatures = {
+  export type BlockSignatures = {
     /** Blockhash of this block */
     blockhash: Blockhash;
     /** Blockhash of this block's parent */
@@ -1188,6 +1206,15 @@ declare module '@solana/web3.js' {
     /** Optional array of filters to apply to accounts */
     filters?: GetProgramAccountsFilter[];
   };
+  /**
+   * Configuration object for getMultipleAccounts
+   */
+  export type GetMultipleAccountsConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** Optional encoding for account data (default base64) */
+    encoding?: 'base64' | 'jsonParsed';
+  };
   /**
    * Information describing an account
    */
@@ -1200,7 +1227,7 @@ declare module '@solana/web3.js' {
     lamports: number;
     /** Optional data assigned to the account */
     data: T;
-    /** Optional rent epoch infor for account */
+    /** Optional rent epoch info for account */
     rentEpoch?: number;
   };
   /**
@@ -1348,7 +1375,7 @@ declare module '@solana/web3.js' {
   export type FetchMiddleware = (
     url: string,
     options: any,
-    fetch: Function,
+    fetch: (modifiedUrl: string, modifiedOptions: any) => void,
   ) => void;
   /**
    * Configuration for instantiating a Connection
@@ -1505,8 +1532,8 @@ declare module '@solana/web3.js' {
      */
     getMultipleAccountsInfo(
       publicKeys: PublicKey[],
-      commitment?: Commitment,
-    ): Promise<(AccountInfo<Buffer> | null)[]>;
+      configOrCommitment?: GetMultipleAccountsConfig | Commitment,
+    ): Promise<(AccountInfo<Buffer | ParsedAccountData> | null)[]>;
     /**
      * Returns epoch activation information for a stake account that has been delegated
      */
@@ -1633,6 +1660,8 @@ declare module '@solana/web3.js' {
     /**
      * Fetch a recent blockhash from the cluster, return with context
      * @return {Promise<RpcResponseAndContext<{blockhash: Blockhash, feeCalculator: FeeCalculator}>>}
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getLatestBlockhash} instead.
      */
     getRecentBlockhashAndContext(commitment?: Commitment): Promise<
       RpcResponseAndContext<{
@@ -1647,19 +1676,48 @@ declare module '@solana/web3.js' {
     getRecentPerformanceSamples(limit?: number): Promise<Array<PerfSample>>;
     /**
      * Fetch the fee calculator for a recent blockhash from the cluster, return with context
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getFeeForMessage} instead.
      */
     getFeeCalculatorForBlockhash(
       blockhash: Blockhash,
       commitment?: Commitment,
     ): Promise<RpcResponseAndContext<FeeCalculator | null>>;
+    /**
+     * Fetch the fee for a message from the cluster, return with context
+     */
+    getFeeForMessage(
+      message: Message,
+      commitment?: Commitment,
+    ): Promise<RpcResponseAndContext<number>>;
     /**
      * Fetch a recent blockhash from the cluster
      * @return {Promise<{blockhash: Blockhash, feeCalculator: FeeCalculator}>}
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getLatestBlockhash} instead.
      */
     getRecentBlockhash(commitment?: Commitment): Promise<{
       blockhash: Blockhash;
       feeCalculator: FeeCalculator;
     }>;
+    /**
+     * Fetch the latest blockhash from the cluster
+     * @return {Promise<{blockhash: Blockhash, lastValidBlockHeight: number}>}
+     */
+    getLatestBlockhash(commitment?: Commitment): Promise<{
+      blockhash: Blockhash;
+      lastValidBlockHeight: number;
+    }>;
+    /**
+     * Fetch the latest blockhash from the cluster
+     * @return {Promise<{blockhash: Blockhash, lastValidBlockHeight: number}>}
+     */
+    getLatestBlockhashAndContext(commitment?: Commitment): Promise<
+      RpcResponseAndContext<{
+        blockhash: Blockhash;
+        lastValidBlockHeight: number;
+      }>
+    >;
     /**
      * Fetch the node version
      */
@@ -1678,7 +1736,7 @@ declare module '@solana/web3.js' {
       },
     ): Promise<BlockResponse | null>;
     /**
-     * Fetch a processed transaction from the cluster.
+     * Fetch a confirmed or finalized transaction from the cluster.
      */
     getTransaction(
       signature: string,
@@ -1686,6 +1744,20 @@ declare module '@solana/web3.js' {
         commitment?: Finality;
       },
     ): Promise<TransactionResponse | null>;
+    /**
+     * Fetch parsed transaction details for a confirmed or finalized transaction
+     */
+    getParsedTransaction(
+      signature: TransactionSignature,
+      commitment?: Finality,
+    ): Promise<ParsedConfirmedTransaction | null>;
+    /**
+     * Fetch parsed transaction details for a batch of confirmed transactions
+     */
+    getParsedTransactions(
+      signatures: TransactionSignature[],
+      commitment?: Finality,
+    ): Promise<(ParsedConfirmedTransaction | null)[]>;
     /**
      * Fetch a list of Transactions and transaction statuses from the cluster
      * for a confirmed block.
@@ -1704,15 +1776,26 @@ declare module '@solana/web3.js' {
       endSlot?: number,
       commitment?: Finality,
     ): Promise<Array<number>>;
+    /**
+     * Fetch a list of Signatures from the cluster for a block, excluding rewards
+     */
+    getBlockSignatures(
+      slot: number,
+      commitment?: Finality,
+    ): Promise<BlockSignatures>;
     /**
      * Fetch a list of Signatures from the cluster for a confirmed block, excluding rewards
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getBlockSignatures} instead.
      */
     getConfirmedBlockSignatures(
       slot: number,
       commitment?: Finality,
-    ): Promise<ConfirmedBlockSignatures>;
+    ): Promise<BlockSignatures>;
     /**
      * Fetch a transaction details for a confirmed transaction
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getTransaction} instead.
      */
     getConfirmedTransaction(
       signature: TransactionSignature,
@@ -1720,6 +1803,8 @@ declare module '@solana/web3.js' {
     ): Promise<ConfirmedTransaction | null>;
     /**
      * Fetch parsed transaction details for a confirmed transaction
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getParsedTransaction} instead.
      */
     getParsedConfirmedTransaction(
       signature: TransactionSignature,
@@ -1727,6 +1812,8 @@ declare module '@solana/web3.js' {
     ): Promise<ParsedConfirmedTransaction | null>;
     /**
      * Fetch parsed transaction details for a batch of confirmed transactions
+     *
+     * @deprecated Deprecated since Solana v1.8.0. Please use {@link getParsedTransactions} instead.
      */
     getParsedConfirmedTransactions(
       signatures: TransactionSignature[],
@@ -2824,20 +2911,32 @@ declare module '@solana/web3.js' {
     credits: number;
     prevCredits: number;
   };
+  export type AuthorizedVoter = {
+    epoch: number;
+    authorizedVoter: PublicKey;
+  };
+  export type PriorVoter = {
+    authorizedPubkey: PublicKey;
+    epochOfLastAuthorizedSwitch: number;
+    targetEpoch: number;
+  };
+  export type BlockTimestamp = {
+    slot: number;
+    timetamp: number;
+  };
   /**
    * VoteAccount class
    */
   export class VoteAccount {
     nodePubkey: PublicKey;
-    authorizedVoterPubkey: PublicKey;
-    authorizedWithdrawerPubkey: PublicKey;
+    authorizedWithdrawer: PublicKey;
     commission: number;
-    votes: Array<Lockout>;
     rootSlot: number | null;
-    epoch: number;
-    credits: number;
-    lastEpochCredits: number;
-    epochCredits: Array<EpochCredits>;
+    votes: Lockout[];
+    authorizedVoters: AuthorizedVoter[];
+    priorVoters: PriorVoter[];
+    epochCredits: EpochCredits[];
+    lastTimestamp: BlockTimestamp;
     /**
      * Deserialize VoteAccount from the account data.
      *
@@ -2849,12 +2948,115 @@ declare module '@solana/web3.js' {
     ): VoteAccount;
   }
 
+  /**
+   * Vote account info
+   */
+  export class VoteInit {
+    nodePubkey: PublicKey;
+    authorizedVoter: PublicKey;
+    authorizedWithdrawer: PublicKey;
+    commission: number; /** [0, 100] */
+    constructor(
+      nodePubkey: PublicKey,
+      authorizedVoter: PublicKey,
+      authorizedWithdrawer: PublicKey,
+      commission: number,
+    );
+  }
+  /**
+   * Create vote account transaction params
+   */
+  export type CreateVoteAccountParams = {
+    fromPubkey: PublicKey;
+    votePubkey: PublicKey;
+    voteInit: VoteInit;
+    lamports: number;
+  };
+  /**
+   * InitializeAccount instruction params
+   */
+  export type InitializeAccountParams = {
+    votePubkey: PublicKey;
+    nodePubkey: PublicKey;
+    voteInit: VoteInit;
+  };
+  /**
+   * Withdraw from vote account transaction params
+   */
+  export type WithdrawFromVoteAccountParams = {
+    votePubkey: PublicKey;
+    authorizedWithdrawerPubkey: PublicKey;
+    lamports: number;
+    toPubkey: PublicKey;
+  };
+  /**
+   * Vote Instruction class
+   */
+  export class VoteInstruction {
+    /**
+     * Decode a vote instruction and retrieve the instruction type.
+     */
+    static decodeInstructionType(
+      instruction: TransactionInstruction,
+    ): VoteInstructionType;
+    /**
+     * Decode an initialize vote instruction and retrieve the instruction params.
+     */
+    static decodeInitializeAccount(
+      instruction: TransactionInstruction,
+    ): InitializeAccountParams;
+    /**
+     * Decode a withdraw instruction and retrieve the instruction params.
+     */
+    static decodeWithdraw(
+      instruction: TransactionInstruction,
+    ): WithdrawFromVoteAccountParams;
+  }
+  /**
+   * An enumeration of valid VoteInstructionType's
+   */
+  export type VoteInstructionType = 'InitializeAccount' | 'Withdraw';
+  /**
+   * Factory class for transactions to interact with the Vote program
+   */
+  export class VoteProgram {
+    /**
+     * Public key that identifies the Vote program
+     */
+    static programId: PublicKey;
+    /**
+     * Max space of a Vote account
+     *
+     * This is generated from the solana-vote-program VoteState struct as
+     * `VoteState::size_of()`:
+     * https://docs.rs/solana-vote-program/1.9.5/solana_vote_program/vote_state/struct.VoteState.html#method.size_of
+     */
+    static space: number;
+    /**
+     * Generate an Initialize instruction.
+     */
+    static initializeAccount(
+      params: InitializeAccountParams,
+    ): TransactionInstruction;
+    /**
+     * Generate a transaction that creates a new Vote account.
+     */
+    static createAccount(params: CreateVoteAccountParams): Transaction;
+    /**
+     * Generate a transaction to withdraw from a Vote account.
+     */
+    static withdraw(params: WithdrawFromVoteAccountParams): Transaction;
+  }
+
   export const SYSVAR_CLOCK_PUBKEY: PublicKey;
+  export const SYSVAR_EPOCH_SCHEDULE_PUBKEY: PublicKey;
+  export const SYSVAR_INSTRUCTIONS_PUBKEY: PublicKey;
   export const SYSVAR_RECENT_BLOCKHASHES_PUBKEY: PublicKey;
   export const SYSVAR_RENT_PUBKEY: PublicKey;
   export const SYSVAR_REWARDS_PUBKEY: PublicKey;
+  export const SYSVAR_SLOT_HASHES_PUBKEY: PublicKey;
+  export const SYSVAR_SLOT_HISTORY_PUBKEY: PublicKey;
   export const SYSVAR_STAKE_HISTORY_PUBKEY: PublicKey;
-  export const SYSVAR_INSTRUCTIONS_PUBKEY: PublicKey;
 
   export class SendTransactionError extends Error {
     logs: string[] | undefined;