@solana/web3.js 1.44.3 → 1.47.0

package/lib/index.d.ts

@@ -580,6 +580,8 @@ declare module '@solana/web3.js' {
     preflightCommitment?: Commitment;
     /** Maximum number of times for the RPC node to retry sending the transaction to the leader. */
     maxRetries?: number;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
   };
   /**
    * Options for confirming transactions
@@ -593,6 +595,8 @@ declare module '@solana/web3.js' {
     preflightCommitment?: Commitment;
     /** Maximum number of times for the RPC node to retry sending the transaction to the leader. */
     maxRetries?: number;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
   };
   /**
    * Options for getConfirmedSignaturesForAddress2
@@ -621,6 +625,8 @@ declare module '@solana/web3.js' {
     until?: TransactionSignature;
     /** Maximum transaction signatures to return (between 1 and 1,000, default: 1,000). */
     limit?: number;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
   };
   /**
    * RPC Response with extra contextual information
@@ -675,6 +681,80 @@ declare module '@solana/web3.js' {
    * </pre>
    */
   export type LargestAccountsFilter = 'circulating' | 'nonCirculating';
+  /**
+   * Configuration object for changing `getAccountInfo` query behavior
+   */
+  export type GetAccountInfoConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getBalance` query behavior
+   */
+  export type GetBalanceConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getBlockHeight` query behavior
+   */
+  export type GetBlockHeightConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getEpochInfo` query behavior
+   */
+  export type GetEpochInfoConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getInflationReward` query behavior
+   */
+  export type GetInflationRewardConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** An epoch for which the reward occurs. If omitted, the previous epoch will be used */
+    epoch?: number;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getLatestBlockhash` query behavior
+   */
+  export type GetLatestBlockhashConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getSlot` query behavior
+   */
+  export type GetSlotConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for changing `getSlotLeader` query behavior
+   */
+  export type GetSlotLeaderConfig = {
+    /** The level of commitment desired */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
   /**
    * Configuration object for changing `getLargestAccounts` query behavior
    */
@@ -1277,6 +1357,8 @@ declare module '@solana/web3.js' {
     dataSlice?: DataSlice;
     /** Optional array of filters to apply to accounts */
     filters?: GetProgramAccountsFilter[];
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
   };
   /**
    * Configuration object for getParsedProgramAccounts
@@ -1286,6 +1368,8 @@ declare module '@solana/web3.js' {
     commitment?: Commitment;
     /** Optional array of filters to apply to accounts */
     filters?: GetProgramAccountsFilter[];
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
   };
   /**
    * Configuration object for getMultipleAccounts
@@ -1293,8 +1377,37 @@ declare module '@solana/web3.js' {
   export type GetMultipleAccountsConfig = {
     /** Optional commitment level */
     commitment?: Commitment;
-    /** Optional encoding for account data (default base64) */
-    encoding?: 'base64' | 'jsonParsed';
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for `getStakeActivation`
+   */
+  export type GetStakeActivationConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** Epoch for which to calculate activation details. If parameter not provided, defaults to current epoch */
+    epoch?: number;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for `getStakeActivation`
+   */
+  export type GetTokenAccountsByOwnerConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for `getStakeActivation`
+   */
+  export type GetTransactionCountConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
   };
   /**
    * Information describing an account
@@ -1449,6 +1562,8 @@ declare module '@solana/web3.js' {
    */
   export type HttpHeaders = {
     [header: string]: string;
+  } & {
+    'solana-client'?: never;
   };
   /**
    * The type of the JavaScript `fetch()` API
@@ -1508,12 +1623,15 @@ declare module '@solana/web3.js' {
      */
     getBalanceAndContext(
       publicKey: PublicKey,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetBalanceConfig,
     ): Promise<RpcResponseAndContext<number>>;
     /**
      * Fetch the balance for the specified public key
      */
-    getBalance(publicKey: PublicKey, commitment?: Commitment): Promise<number>;
+    getBalance(
+      publicKey: PublicKey,
+      commitmentOrConfig?: Commitment | GetBalanceConfig,
+    ): Promise<number>;
     /**
      * Fetch the estimated production time of a block
      */
@@ -1555,7 +1673,7 @@ declare module '@solana/web3.js' {
     getTokenAccountsByOwner(
       ownerAddress: PublicKey,
       filter: TokenAccountsFilter,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetTokenAccountsByOwnerConfig,
     ): Promise<
       RpcResponseAndContext<
         Array<{
@@ -1600,7 +1718,7 @@ declare module '@solana/web3.js' {
      */
     getAccountInfoAndContext(
       publicKey: PublicKey,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetAccountInfoConfig,
     ): Promise<RpcResponseAndContext<AccountInfo<Buffer> | null>>;
     /**
      * Fetch parsed account info for the specified public key
@@ -1616,28 +1734,28 @@ declare module '@solana/web3.js' {
      */
     getAccountInfo(
       publicKey: PublicKey,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetAccountInfoConfig,
     ): Promise<AccountInfo<Buffer> | null>;
     /**
      * Fetch all the account info for multiple accounts specified by an array of public keys, return with context
      */
     getMultipleAccountsInfoAndContext(
       publicKeys: PublicKey[],
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetMultipleAccountsConfig,
     ): Promise<RpcResponseAndContext<(AccountInfo<Buffer> | null)[]>>;
     /**
      * Fetch all the account info for multiple accounts specified by an array of public keys
      */
     getMultipleAccountsInfo(
       publicKeys: PublicKey[],
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetMultipleAccountsConfig,
     ): Promise<(AccountInfo<Buffer> | null)[]>;
     /**
      * Returns epoch activation information for a stake account that has been delegated
      */
     getStakeActivation(
       publicKey: PublicKey,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetStakeActivationConfig,
       epoch?: number,
     ): Promise<StakeActivationData>;
     /**
@@ -1688,11 +1806,13 @@ declare module '@solana/web3.js' {
     /**
      * Fetch the current slot that the node is processing
      */
-    getSlot(commitment?: Commitment): Promise<number>;
+    getSlot(commitmentOrConfig?: Commitment | GetSlotConfig): Promise<number>;
     /**
      * Fetch the current slot leader of the cluster
      */
-    getSlotLeader(commitment?: Commitment): Promise<string>;
+    getSlotLeader(
+      commitmentOrConfig?: Commitment | GetSlotLeaderConfig,
+    ): Promise<string>;
     /**
      * Fetch `limit` number of slot leaders starting from `startSlot`
      *
@@ -1717,7 +1837,9 @@ declare module '@solana/web3.js' {
     /**
      * Fetch the current transaction count of the cluster
      */
-    getTransactionCount(commitment?: Commitment): Promise<number>;
+    getTransactionCount(
+      commitmentOrConfig?: Commitment | GetTransactionCountConfig,
+    ): Promise<number>;
     /**
      * Fetch the current total currency supply of the cluster in lamports
      *
@@ -1734,12 +1856,14 @@ declare module '@solana/web3.js' {
     getInflationReward(
       addresses: PublicKey[],
       epoch?: number,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetInflationRewardConfig,
     ): Promise<(InflationReward | null)[]>;
     /**
      * Fetch the Epoch Info parameters
      */
-    getEpochInfo(commitment?: Commitment): Promise<EpochInfo>;
+    getEpochInfo(
+      commitmentOrConfig?: Commitment | GetEpochInfoConfig,
+    ): Promise<EpochInfo>;
     /**
      * Fetch the Epoch Schedule parameters
      */
@@ -1805,14 +1929,14 @@ declare module '@solana/web3.js' {
      * @return {Promise<BlockhashWithExpiryBlockHeight>}
      */
     getLatestBlockhash(
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetLatestBlockhashConfig,
     ): Promise<BlockhashWithExpiryBlockHeight>;
     /**
      * Fetch the latest blockhash from the cluster
      * @return {Promise<BlockhashWithExpiryBlockHeight>}
      */
     getLatestBlockhashAndContext(
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetLatestBlockhashConfig,
     ): Promise<RpcResponseAndContext<BlockhashWithExpiryBlockHeight>>;
     /**
      * Fetch the node version
@@ -1831,7 +1955,9 @@ declare module '@solana/web3.js' {
         commitment?: Finality;
       },
     ): Promise<BlockResponse | null>;
-    getBlockHeight(commitment?: Commitment): Promise<number>;
+    getBlockHeight(
+      commitmentOrConfig?: Commitment | GetBlockHeightConfig,
+    ): Promise<number>;
     getBlockProduction(
       configOrCommitment?: GetBlockProductionConfig | Commitment,
     ): Promise<RpcResponseAndContext<BlockProduction>>;
@@ -3371,6 +3497,42 @@ declare module '@solana/web3.js' {
     logs: string[] | undefined;
     constructor(message: string, logs?: string[]);
   }
+  export const SolanaJSONRPCErrorCode: {
+    readonly JSON_RPC_SERVER_ERROR_BLOCK_CLEANED_UP: -32001;
+    readonly JSON_RPC_SERVER_ERROR_SEND_TRANSACTION_PREFLIGHT_FAILURE: -32002;
+    readonly JSON_RPC_SERVER_ERROR_TRANSACTION_SIGNATURE_VERIFICATION_FAILURE: -32003;
+    readonly JSON_RPC_SERVER_ERROR_BLOCK_NOT_AVAILABLE: -32004;
+    readonly JSON_RPC_SERVER_ERROR_NODE_UNHEALTHY: -32005;
+    readonly JSON_RPC_SERVER_ERROR_TRANSACTION_PRECOMPILE_VERIFICATION_FAILURE: -32006;
+    readonly JSON_RPC_SERVER_ERROR_SLOT_SKIPPED: -32007;
+    readonly JSON_RPC_SERVER_ERROR_NO_SNAPSHOT: -32008;
+    readonly JSON_RPC_SERVER_ERROR_LONG_TERM_STORAGE_SLOT_SKIPPED: -32009;
+    readonly JSON_RPC_SERVER_ERROR_KEY_EXCLUDED_FROM_SECONDARY_INDEX: -32010;
+    readonly JSON_RPC_SERVER_ERROR_TRANSACTION_HISTORY_NOT_AVAILABLE: -32011;
+    readonly JSON_RPC_SCAN_ERROR: -32012;
+    readonly JSON_RPC_SERVER_ERROR_TRANSACTION_SIGNATURE_LEN_MISMATCH: -32013;
+    readonly JSON_RPC_SERVER_ERROR_BLOCK_STATUS_NOT_AVAILABLE_YET: -32014;
+    readonly JSON_RPC_SERVER_ERROR_UNSUPPORTED_TRANSACTION_VERSION: -32015;
+    readonly JSON_RPC_SERVER_ERROR_MIN_CONTEXT_SLOT_NOT_REACHED: -32016;
+  };
+  export type SolanaJSONRPCErrorCodeEnum =
+    typeof SolanaJSONRPCErrorCode[keyof typeof SolanaJSONRPCErrorCode];
+  export class SolanaJSONRPCError extends Error {
+    code: SolanaJSONRPCErrorCodeEnum | unknown;
+    data?: any;
+    constructor(
+      {
+        code,
+        message,
+        data,
+      }: Readonly<{
+        code: unknown;
+        message: string;
+        data?: any;
+      }>,
+      customMessage?: string,
+    );
+  }
 
   /**
    * Sign, send and confirm a transaction.