@solana/web3.js 1.66.5 → 1.67.1

package/lib/index.d.ts

@@ -46,7 +46,7 @@ declare module '@solana/web3.js' {
      */
     constructor(value: PublicKeyInitData);
     /**
-     * Returns a unique PublicKey for tests and benchmarks using acounter
+     * Returns a unique PublicKey for tests and benchmarks using a counter
      */
     static unique(): PublicKey;
     /**
@@ -95,6 +95,8 @@ declare module '@solana/web3.js' {
     /**
      * Async version of createProgramAddressSync
      * For backwards compatibility
+     *
+     * @deprecated Use {@link createProgramAddressSync} instead
      */
     static createProgramAddress(
       seeds: Array<Buffer | Uint8Array>,
@@ -114,6 +116,8 @@ declare module '@solana/web3.js' {
     /**
      * Async version of findProgramAddressSync
      * For backwards compatibility
+     *
+     * @deprecated Use {@link findProgramAddressSync} instead
      */
     static findProgramAddress(
       seeds: Array<Buffer | Uint8Array>,
@@ -139,7 +143,7 @@ declare module '@solana/web3.js' {
      *
      * @param secretKey Secret key for the account
      */
-    constructor(secretKey?: Buffer | Uint8Array | Array<number>);
+    constructor(secretKey?: Uint8Array | Array<number>);
     /**
      * The public key for this account
      */
@@ -205,12 +209,16 @@ declare module '@solana/web3.js' {
   }
 
   export const NONCE_ACCOUNT_LENGTH: number;
+  /**
+   * A durable nonce is a 32 byte value encoded as a base58 string.
+   */
+  export type DurableNonce = string;
   /**
    * NonceAccount class
    */
   export class NonceAccount {
     authorizedPubkey: PublicKey;
-    nonce: Blockhash;
+    nonce: DurableNonce;
     feeCalculator: FeeCalculator;
     /**
      * Deserialize NonceAccount from the account data.
@@ -313,6 +321,10 @@ declare module '@solana/web3.js' {
     signature: string;
     constructor(signature: string, timeoutSeconds: number);
   }
+  export class TransactionExpiredNonceInvalidError extends Error {
+    signature: string;
+    constructor(signature: string);
+  }
 
   export type AccountKeysFromLookups = LoadedAddresses;
   export class MessageAccountKeys {
@@ -1642,6 +1654,7 @@ declare module '@solana/web3.js' {
     BLOCKHEIGHT_EXCEEDED = 0,
     PROCESSED = 1,
     TIMED_OUT = 2,
+    NONCE_INVALID = 3,
   }
   /**
    * Account metadata used to define instructions
@@ -1712,7 +1725,9 @@ declare module '@solana/web3.js' {
   };
   export type TransactionCtorFields = TransactionCtorFields_DEPRECATED;
   /**
-   * List of Transaction object fields that may be initialized at construction
+   * Blockhash-based transactions have a lifetime that are defined by
+   * the blockhash they include. Any transaction whose blockhash is
+   * too old will be rejected.
    */
   export type TransactionBlockhashCtor = {
     /** The transaction fee payer */
@@ -1724,6 +1739,17 @@ declare module '@solana/web3.js' {
     /** the last block chain can advance to before tx is exportd expired */
     lastValidBlockHeight: number;
   };
+  /**
+   * Use these options to construct a durable nonce transaction.
+   */
+  export type TransactionNonceCtor = {
+    /** The transaction fee payer */
+    feePayer?: PublicKey | null;
+    minContextSlot: number;
+    nonceInfo: NonceInformation;
+    /** One or more signatures */
+    signatures?: Array<SignaturePubkeyPair>;
+  };
   /**
    * Nonce information to be used to build an offline Transaction.
    */
@@ -1767,7 +1793,16 @@ declare module '@solana/web3.js' {
      * Nonce hash instead of a recentBlockhash. Must be populated by the caller
      */
     nonceInfo?: NonceInformation;
+    /**
+     * If this is a nonce transaction this represents the minimum slot from which
+     * to evaluate if the nonce has advanced when attempting to confirm the
+     * transaction. This protects against a case where the transaction confirmation
+     * logic loads the nonce account from an old slot and assumes the mismatch in
+     * nonce value implies that the nonce has been advanced.
+     */
+    minNonceContextSlot?: number;
     constructor(opts?: TransactionBlockhashCtor);
+    constructor(opts?: TransactionNonceCtor);
     /**
      * @deprecated `TransactionCtorFields` has been deprecated and will be removed in a future version.
      * Please supply a `TransactionBlockhashCtor` instead.
@@ -1985,6 +2020,27 @@ declare module '@solana/web3.js' {
   export type BlockheightBasedTransactionConfirmationStrategy = {
     signature: TransactionSignature;
   } & BlockhashWithExpiryBlockHeight;
+  /**
+   * A strategy for confirming durable nonce transactions.
+   */
+  export type DurableNonceTransactionConfirmationStrategy = {
+    /**
+     * The lowest slot at which to fetch the nonce value from the
+     * nonce account. This should be no lower than the slot at
+     * which the last-known value of the nonce was fetched.
+     */
+    minContextSlot: number;
+    /**
+     * The account where the current value of the nonce is stored.
+     */
+    nonceAccountPubkey: PublicKey;
+    /**
+     * The nonce value that was used to sign the transaction
+     * for which confirmation is being sought.
+     */
+    nonceValue: DurableNonce;
+    signature: TransactionSignature;
+  };
   /**
    * The level of commitment desired when querying state
    * <pre>
@@ -2941,6 +2997,24 @@ declare module '@solana/web3.js' {
     /** The minimum slot that the request can be evaluated at */
     minContextSlot?: number;
   };
+  /**
+   * Configuration object for `getNonce`
+   */
+  export type GetNonceConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
+  /**
+   * Configuration object for `getNonceAndContext`
+   */
+  export type GetNonceAndContextConfig = {
+    /** Optional commitment level */
+    commitment?: Commitment;
+    /** The minimum slot that the request can be evaluated at */
+    minContextSlot?: number;
+  };
   /**
    * Information describing an account
    */
@@ -3330,7 +3404,9 @@ declare module '@solana/web3.js' {
       }>
     >;
     confirmTransaction(
-      strategy: BlockheightBasedTransactionConfirmationStrategy,
+      strategy:
+        | BlockheightBasedTransactionConfirmationStrategy
+        | DurableNonceTransactionConfirmationStrategy,
       commitment?: Commitment,
     ): Promise<RpcResponseAndContext<SignatureResult>>;
     /** @deprecated Instead, call `confirmTransaction` using a `TransactionConfirmationConfig` */
@@ -3338,6 +3414,10 @@ declare module '@solana/web3.js' {
       strategy: TransactionSignature,
       commitment?: Commitment,
     ): Promise<RpcResponseAndContext<SignatureResult>>;
+    private getTransactionConfirmationPromise;
+    private confirmTransactionUsingBlockHeightExceedanceStrategy;
+    private confirmTransactionUsingDurableNonceStrategy;
+    private confirmTransactionUsingLegacyTimeoutStrategy;
     /**
      * Return the list of nodes that are currently participating in the cluster
      */
@@ -3683,14 +3763,14 @@ declare module '@solana/web3.js' {
      */
     getNonceAndContext(
       nonceAccount: PublicKey,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetNonceAndContextConfig,
     ): Promise<RpcResponseAndContext<NonceAccount | null>>;
     /**
      * Fetch the contents of a Nonce account from the cluster
      */
     getNonce(
       nonceAccount: PublicKey,
-      commitment?: Commitment,
+      commitmentOrConfig?: Commitment | GetNonceConfig,
     ): Promise<NonceAccount | null>;
     /**
      * Request an allocation of lamports to the specified address