@solana/web3.js 1.41.9 → 1.43.0

package/lib/index.d.ts

@@ -338,6 +338,11 @@ declare module '@solana/web3.js' {
    * Transaction signature as base-58 encoded string
    */
   export type TransactionSignature = string;
+  export const enum TransactionStatus {
+    BLOCKHEIGHT_EXCEEDED = 0,
+    PROCESSED = 1,
+    TIMED_OUT = 2,
+  }
   /**
    * Account metadata used to define instructions
    */
@@ -394,17 +399,29 @@ declare module '@solana/web3.js' {
   };
   /**
    * List of Transaction object fields that may be initialized at construction
-   *
    */
-  export type TransactionCtorFields = {
-    /** A recent blockhash */
-    recentBlockhash?: Blockhash | null;
+  export type TransactionCtorFields_DEPRECATED = {
     /** Optional nonce information used for offline nonce'd transactions */
     nonceInfo?: NonceInformation | null;
     /** The transaction fee payer */
     feePayer?: PublicKey | null;
     /** One or more signatures */
     signatures?: Array<SignaturePubkeyPair>;
+    /** A recent blockhash */
+    recentBlockhash?: Blockhash;
+  };
+  /**
+   * List of Transaction object fields that may be initialized at construction
+   */
+  export type TransactionBlockhashCtor = {
+    /** The transaction fee payer */
+    feePayer?: PublicKey | null;
+    /** One or more signatures */
+    signatures?: Array<SignaturePubkeyPair>;
+    /** A recent blockhash */
+    blockhash: Blockhash;
+    /** the last block chain can advance to before tx is exportd expired */
+    lastValidBlockHeight: number;
   };
   /**
    * Nonce information to be used to build an offline Transaction.
@@ -440,15 +457,21 @@ declare module '@solana/web3.js' {
      * A recent transaction id. Must be populated by the caller
      */
     recentBlockhash?: Blockhash;
+    /**
+     * the last block chain can advance to before tx is exportd expired
+     * */
+    lastValidBlockHeight?: number;
     /**
      * Optional Nonce information. If populated, transaction will use a durable
      * Nonce hash instead of a recentBlockhash. Must be populated by the caller
      */
     nonceInfo?: NonceInformation;
+    constructor(opts?: TransactionBlockhashCtor);
     /**
-     * Construct an empty Transaction
+     * @deprecated `TransactionCtorFields` has been deprecated and will be removed in a future version.
+     * Please supply a `TransactionBlockhashCtor` instead.
      */
-    constructor(opts?: TransactionCtorFields);
+    constructor(opts?: TransactionCtorFields_DEPRECATED);
     /**
      * Add one or more instructions to this Transaction
      */
@@ -602,6 +625,17 @@ declare module '@solana/web3.js' {
     /** response value */
     value: T;
   };
+  export type BlockhashWithExpiryBlockHeight = Readonly<{
+    blockhash: Blockhash;
+    lastValidBlockHeight: number;
+  }>;
+  /**
+   * A strategy for confirming transactions that uses the last valid
+   * block height for a given blockhash to check for transaction expiration.
+   */
+  export type BlockheightBasedTransactionConfirmationStrategy = {
+    signature: TransactionSignature;
+  } & BlockhashWithExpiryBlockHeight;
   /**
    * The level of commitment desired when querying state
    * <pre>
@@ -1624,11 +1658,13 @@ declare module '@solana/web3.js' {
         account: AccountInfo<Buffer | ParsedAccountData>;
       }>
     >;
-    /**
-     * Confirm the transaction identified by the specified signature.
-     */
     confirmTransaction(
-      signature: TransactionSignature,
+      strategy: BlockheightBasedTransactionConfirmationStrategy,
+      commitment?: Commitment,
+    ): Promise<RpcResponseAndContext<SignatureResult>>;
+    /** @deprecated Instead, call `confirmTransaction` using a `TransactionConfirmationConfig` */
+    confirmTransaction(
+      strategy: TransactionSignature,
       commitment?: Commitment,
     ): Promise<RpcResponseAndContext<SignatureResult>>;
     /**
@@ -1756,22 +1792,18 @@ declare module '@solana/web3.js' {
     }>;
     /**
      * Fetch the latest blockhash from the cluster
-     * @return {Promise<{blockhash: Blockhash, lastValidBlockHeight: number}>}
+     * @return {Promise<BlockhashWithExpiryBlockHeight>}
      */
-    getLatestBlockhash(commitment?: Commitment): Promise<{
-      blockhash: Blockhash;
-      lastValidBlockHeight: number;
-    }>;
+    getLatestBlockhash(
+      commitment?: Commitment,
+    ): Promise<BlockhashWithExpiryBlockHeight>;
     /**
      * Fetch the latest blockhash from the cluster
-     * @return {Promise<{blockhash: Blockhash, lastValidBlockHeight: number}>}
+     * @return {Promise<BlockhashWithExpiryBlockHeight>}
      */
-    getLatestBlockhashAndContext(commitment?: Commitment): Promise<
-      RpcResponseAndContext<{
-        blockhash: Blockhash;
-        lastValidBlockHeight: number;
-      }>
-    >;
+    getLatestBlockhashAndContext(
+      commitment?: Commitment,
+    ): Promise<RpcResponseAndContext<BlockhashWithExpiryBlockHeight>>;
     /**
      * Fetch the node version
      */
@@ -2194,20 +2226,34 @@ declare module '@solana/web3.js' {
     static decodeRequestHeapFrame(
       instruction: TransactionInstruction,
     ): RequestHeapFrameParams;
+    /**
+     * Decode set compute unit limit compute budget instruction and retrieve the instruction params.
+     */
+    static decodeSetComputeUnitLimit(
+      instruction: TransactionInstruction,
+    ): SetComputeUnitLimitParams;
+    /**
+     * Decode set compute unit price compute budget instruction and retrieve the instruction params.
+     */
+    static decodeSetComputeUnitPrice(
+      instruction: TransactionInstruction,
+    ): SetComputeUnitPriceParams;
   }
   /**
    * An enumeration of valid ComputeBudgetInstructionType's
    */
   export type ComputeBudgetInstructionType =
     | 'RequestUnits'
-    | 'RequestHeapFrame';
+    | 'RequestHeapFrame'
+    | 'SetComputeUnitLimit'
+    | 'SetComputeUnitPrice';
   /**
    * Request units instruction params
    */
   interface RequestUnitsParams {
     /** Units to request for transaction-wide compute */
     units: number;
-    /** Additional fee to pay */
+    /** Prioritization fee lamports */
     additionalFee: number;
   }
   /**
@@ -2217,6 +2263,20 @@ declare module '@solana/web3.js' {
     /** Requested transaction-wide program heap size in bytes. Must be multiple of 1024. Applies to each program, including CPIs. */
     bytes: number;
   };
+  /**
+   * Set compute unit limit instruction params
+   */
+  interface SetComputeUnitLimitParams {
+    /** Transaction-wide compute unit limit */
+    units: number;
+  }
+  /**
+   * Set compute unit price instruction params
+   */
+  interface SetComputeUnitPriceParams {
+    /** Transaction compute unit price used for prioritization fees */
+    microLamports: number | bigint;
+  }
   /**
    * Factory class for transaction instructions to interact with the Compute Budget program
    */
@@ -2229,6 +2289,12 @@ declare module '@solana/web3.js' {
     static requestHeapFrame(
       params: RequestHeapFrameParams,
     ): TransactionInstruction;
+    static setComputeUnitLimit(
+      params: SetComputeUnitLimitParams,
+    ): TransactionInstruction;
+    static setComputeUnitPrice(
+      params: SetComputeUnitPriceParams,
+    ): TransactionInstruction;
   }
 
   /**
@@ -3320,9 +3386,20 @@ declare module '@solana/web3.js' {
    *
    * @param {Connection} connection
    * @param {Buffer} rawTransaction
+   * @param {BlockheightBasedTransactionConfirmationStrategy} confirmationStrategy
    * @param {ConfirmOptions} [options]
    * @returns {Promise<TransactionSignature>}
    */
+  export function sendAndConfirmRawTransaction(
+    connection: Connection,
+    rawTransaction: Buffer,
+    confirmationStrategy: BlockheightBasedTransactionConfirmationStrategy,
+    options?: ConfirmOptions,
+  ): Promise<TransactionSignature>;
+  /**
+   * @deprecated Calling `sendAndConfirmRawTransaction()` without a `confirmationStrategy`
+   * is no longer supported and will be removed in a future version.
+   */
   export function sendAndConfirmRawTransaction(
     connection: Connection,
     rawTransaction: Buffer,