@solana/web3.js 1.47.3 → 1.49.0

package/lib/index.d.ts

@@ -142,13 +142,6 @@ declare module '@solana/web3.js' {
     get secretKey(): Buffer;
   }
 
-  /**
-   * Blockhash as Base58 string.
-   */
-  export type Blockhash = string;
-
-  export const BPF_LOADER_DEPRECATED_PROGRAM_ID: PublicKey;
-
   /**
    * Epoch schedule
    * (see https://docs.solana.com/terminology#epoch)
@@ -184,6 +177,11 @@ declare module '@solana/web3.js' {
     init?: nodeFetch.RequestInit,
   ): Promise<nodeFetch.Response>;
 
+  /**
+   * Blockhash as Base58 string.
+   */
+  export type Blockhash = string;
+
   /**
    * Calculator for transaction fees.
    */
@@ -339,223 +337,6 @@ declare module '@solana/web3.js' {
     static from(buffer: Buffer | Uint8Array | Array<number>): Message;
   }
 
-  /**
-   * 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
-   */
-  export type AccountMeta = {
-    /** An account's public key */
-    pubkey: PublicKey;
-    /** True if an instruction requires a transaction signature matching `pubkey` */
-    isSigner: boolean;
-    /** True if the `pubkey` can be loaded as a read-write account. */
-    isWritable: boolean;
-  };
-  /**
-   * List of TransactionInstruction object fields that may be initialized at construction
-   */
-  export type TransactionInstructionCtorFields = {
-    keys: Array<AccountMeta>;
-    programId: PublicKey;
-    data?: Buffer;
-  };
-  /**
-   * Configuration object for Transaction.serialize()
-   */
-  export type SerializeConfig = {
-    /** Require all transaction signatures be present (default: true) */
-    requireAllSignatures?: boolean;
-    /** Verify provided signatures (default: true) */
-    verifySignatures?: boolean;
-  };
-  /**
-   * Transaction Instruction class
-   */
-  export class TransactionInstruction {
-    /**
-     * Public keys to include in this transaction
-     * Boolean represents whether this pubkey needs to sign the transaction
-     */
-    keys: Array<AccountMeta>;
-    /**
-     * Program Id to execute
-     */
-    programId: PublicKey;
-    /**
-     * Program input
-     */
-    data: Buffer;
-    constructor(opts: TransactionInstructionCtorFields);
-  }
-  /**
-   * Pair of signature and corresponding public key
-   */
-  export type SignaturePubkeyPair = {
-    signature: Buffer | null;
-    publicKey: PublicKey;
-  };
-  /**
-   * List of Transaction object fields that may be initialized at construction
-   */
-  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;
-  };
-  export type TransactionCtorFields = TransactionCtorFields_DEPRECATED;
-  /**
-   * 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.
-   */
-  export type NonceInformation = {
-    /** The current blockhash stored in the nonce */
-    nonce: Blockhash;
-    /** AdvanceNonceAccount Instruction */
-    nonceInstruction: TransactionInstruction;
-  };
-  /**
-   * Transaction class
-   */
-  export class Transaction {
-    /**
-     * Signatures for the transaction.  Typically created by invoking the
-     * `sign()` method
-     */
-    signatures: Array<SignaturePubkeyPair>;
-    /**
-     * The first (payer) Transaction signature
-     */
-    get signature(): Buffer | null;
-    /**
-     * The transaction fee payer
-     */
-    feePayer?: PublicKey;
-    /**
-     * The instructions to atomically execute
-     */
-    instructions: Array<TransactionInstruction>;
-    /**
-     * 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);
-    /**
-     * @deprecated `TransactionCtorFields` has been deprecated and will be removed in a future version.
-     * Please supply a `TransactionBlockhashCtor` instead.
-     */
-    constructor(opts?: TransactionCtorFields_DEPRECATED);
-    /**
-     * Add one or more instructions to this Transaction
-     */
-    add(
-      ...items: Array<
-        Transaction | TransactionInstruction | TransactionInstructionCtorFields
-      >
-    ): Transaction;
-    /**
-     * Compile transaction data
-     */
-    compileMessage(): Message;
-    /**
-     * Get a buffer of the Transaction data that need to be covered by signatures
-     */
-    serializeMessage(): Buffer;
-    /**
-     * Get the estimated fee associated with a transaction
-     */
-    getEstimatedFee(connection: Connection): Promise<number>;
-    /**
-     * Specify the public keys which will be used to sign the Transaction.
-     * The first signer will be used as the transaction fee payer account.
-     *
-     * Signatures can be added with either `partialSign` or `addSignature`
-     *
-     * @deprecated Deprecated since v0.84.0. Only the fee payer needs to be
-     * specified and it can be set in the Transaction constructor or with the
-     * `feePayer` property.
-     */
-    setSigners(...signers: Array<PublicKey>): void;
-    /**
-     * Sign the Transaction with the specified signers. Multiple signatures may
-     * be applied to a Transaction. The first signature is considered "primary"
-     * and is used identify and confirm transactions.
-     *
-     * If the Transaction `feePayer` is not set, the first signer will be used
-     * as the transaction fee payer account.
-     *
-     * Transaction fields should not be modified after the first call to `sign`,
-     * as doing so may invalidate the signature and cause the Transaction to be
-     * rejected.
-     *
-     * The Transaction must be assigned a valid `recentBlockhash` before invoking this method
-     */
-    sign(...signers: Array<Signer>): void;
-    /**
-     * Partially sign a transaction with the specified accounts. All accounts must
-     * correspond to either the fee payer or a signer account in the transaction
-     * instructions.
-     *
-     * All the caveats from the `sign` method apply to `partialSign`
-     */
-    partialSign(...signers: Array<Signer>): void;
-    /**
-     * Add an externally created signature to a transaction. The public key
-     * must correspond to either the fee payer or a signer account in the transaction
-     * instructions.
-     */
-    addSignature(pubkey: PublicKey, signature: Buffer): void;
-    /**
-     * Verify signatures of a complete, signed Transaction
-     */
-    verifySignatures(): boolean;
-    /**
-     * Serialize the Transaction in the wire format.
-     */
-    serialize(config?: SerializeConfig): Buffer;
-    /**
-     * Parse a wire transaction into a Transaction object.
-     */
-    static from(buffer: Buffer | Uint8Array | Array<number>): Transaction;
-    /**
-     * Populate Transaction object from message and signatures
-     */
-    static populate(message: Message, signatures?: Array<string>): Transaction;
-  }
-
   export type ClientSubscriptionId = number;
   export type TokenAccountsFilter =
     | {
@@ -699,6 +480,15 @@ declare module '@solana/web3.js' {
     /** The minimum slot that the request can be evaluated at */
     minContextSlot?: number;
   };
+  /**
+   * Configuration object for changing `getBlock` query behavior
+   */
+  export type GetBlockConfig = {
+    /** The level of finality desired */
+    commitment?: Finality;
+    /** The max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned */
+    maxSupportedTransactionVersion?: number;
+  };
   /**
    * Configuration object for changing `getBlockHeight` query behavior
    */
@@ -755,6 +545,15 @@ declare module '@solana/web3.js' {
     /** The minimum slot that the request can be evaluated at */
     minContextSlot?: number;
   };
+  /**
+   * Configuration object for changing `getTransaction` query behavior
+   */
+  export type GetTransactionConfig = {
+    /** The level of finality desired */
+    commitment?: Finality;
+    /** The max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned */
+    maxSupportedTransactionVersion?: number;
+  };
   /**
    * Configuration object for changing `getLargestAccounts` query behavior
    */
@@ -885,11 +684,17 @@ declare module '@solana/web3.js' {
     /** Optional rent epoch info for account */
     rentEpoch?: number;
   };
+  export type TransactionReturnDataEncoding = 'base64';
+  export type TransactionReturnData = {
+    programId: string;
+    data: [string, TransactionReturnDataEncoding];
+  };
   export type SimulatedTransactionResponse = {
     err: TransactionError | string | null;
     logs: Array<string> | null;
     accounts?: (SimulatedTransactionAccountInfo | null)[] | null;
     unitsConsumed?: number;
+    returnData?: TransactionReturnData | null;
   };
   export type ParsedInnerInstruction = {
     index: number;
@@ -1951,9 +1756,7 @@ declare module '@solana/web3.js' {
      */
     getBlock(
       slot: number,
-      opts?: {
-        commitment?: Finality;
-      },
+      rawConfig?: GetBlockConfig,
     ): Promise<BlockResponse | null>;
     getBlockHeight(
       commitmentOrConfig?: Commitment | GetBlockHeightConfig,
@@ -1966,9 +1769,7 @@ declare module '@solana/web3.js' {
      */
     getTransaction(
       signature: string,
-      opts?: {
-        commitment?: Finality;
-      },
+      rawConfig?: GetTransactionConfig,
     ): Promise<TransactionResponse | null>;
     /**
      * Fetch parsed transaction details for a confirmed or finalized transaction
@@ -2309,6 +2110,312 @@ declare module '@solana/web3.js' {
     ): Promise<void>;
   }
 
+  /**
+   * 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
+   */
+  export type AccountMeta = {
+    /** An account's public key */
+    pubkey: PublicKey;
+    /** True if an instruction requires a transaction signature matching `pubkey` */
+    isSigner: boolean;
+    /** True if the `pubkey` can be loaded as a read-write account. */
+    isWritable: boolean;
+  };
+  /**
+   * List of TransactionInstruction object fields that may be initialized at construction
+   */
+  export type TransactionInstructionCtorFields = {
+    keys: Array<AccountMeta>;
+    programId: PublicKey;
+    data?: Buffer;
+  };
+  /**
+   * Configuration object for Transaction.serialize()
+   */
+  export type SerializeConfig = {
+    /** Require all transaction signatures be present (default: true) */
+    requireAllSignatures?: boolean;
+    /** Verify provided signatures (default: true) */
+    verifySignatures?: boolean;
+  };
+  /**
+   * Transaction Instruction class
+   */
+  export class TransactionInstruction {
+    /**
+     * Public keys to include in this transaction
+     * Boolean represents whether this pubkey needs to sign the transaction
+     */
+    keys: Array<AccountMeta>;
+    /**
+     * Program Id to execute
+     */
+    programId: PublicKey;
+    /**
+     * Program input
+     */
+    data: Buffer;
+    constructor(opts: TransactionInstructionCtorFields);
+  }
+  /**
+   * Pair of signature and corresponding public key
+   */
+  export type SignaturePubkeyPair = {
+    signature: Buffer | null;
+    publicKey: PublicKey;
+  };
+  /**
+   * List of Transaction object fields that may be initialized at construction
+   */
+  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;
+  };
+  export type TransactionCtorFields = TransactionCtorFields_DEPRECATED;
+  /**
+   * 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.
+   */
+  export type NonceInformation = {
+    /** The current blockhash stored in the nonce */
+    nonce: Blockhash;
+    /** AdvanceNonceAccount Instruction */
+    nonceInstruction: TransactionInstruction;
+  };
+  /**
+   * Transaction class
+   */
+  export class Transaction {
+    /**
+     * Signatures for the transaction.  Typically created by invoking the
+     * `sign()` method
+     */
+    signatures: Array<SignaturePubkeyPair>;
+    /**
+     * The first (payer) Transaction signature
+     */
+    get signature(): Buffer | null;
+    /**
+     * The transaction fee payer
+     */
+    feePayer?: PublicKey;
+    /**
+     * The instructions to atomically execute
+     */
+    instructions: Array<TransactionInstruction>;
+    /**
+     * 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);
+    /**
+     * @deprecated `TransactionCtorFields` has been deprecated and will be removed in a future version.
+     * Please supply a `TransactionBlockhashCtor` instead.
+     */
+    constructor(opts?: TransactionCtorFields_DEPRECATED);
+    /**
+     * Add one or more instructions to this Transaction
+     */
+    add(
+      ...items: Array<
+        Transaction | TransactionInstruction | TransactionInstructionCtorFields
+      >
+    ): Transaction;
+    /**
+     * Compile transaction data
+     */
+    compileMessage(): Message;
+    /**
+     * Get a buffer of the Transaction data that need to be covered by signatures
+     */
+    serializeMessage(): Buffer;
+    /**
+     * Get the estimated fee associated with a transaction
+     */
+    getEstimatedFee(connection: Connection): Promise<number>;
+    /**
+     * Specify the public keys which will be used to sign the Transaction.
+     * The first signer will be used as the transaction fee payer account.
+     *
+     * Signatures can be added with either `partialSign` or `addSignature`
+     *
+     * @deprecated Deprecated since v0.84.0. Only the fee payer needs to be
+     * specified and it can be set in the Transaction constructor or with the
+     * `feePayer` property.
+     */
+    setSigners(...signers: Array<PublicKey>): void;
+    /**
+     * Sign the Transaction with the specified signers. Multiple signatures may
+     * be applied to a Transaction. The first signature is considered "primary"
+     * and is used identify and confirm transactions.
+     *
+     * If the Transaction `feePayer` is not set, the first signer will be used
+     * as the transaction fee payer account.
+     *
+     * Transaction fields should not be modified after the first call to `sign`,
+     * as doing so may invalidate the signature and cause the Transaction to be
+     * rejected.
+     *
+     * The Transaction must be assigned a valid `recentBlockhash` before invoking this method
+     */
+    sign(...signers: Array<Signer>): void;
+    /**
+     * Partially sign a transaction with the specified accounts. All accounts must
+     * correspond to either the fee payer or a signer account in the transaction
+     * instructions.
+     *
+     * All the caveats from the `sign` method apply to `partialSign`
+     */
+    partialSign(...signers: Array<Signer>): void;
+    /**
+     * Add an externally created signature to a transaction. The public key
+     * must correspond to either the fee payer or a signer account in the transaction
+     * instructions.
+     */
+    addSignature(pubkey: PublicKey, signature: Buffer): void;
+    /**
+     * Verify signatures of a complete, signed Transaction
+     */
+    verifySignatures(): boolean;
+    /**
+     * Serialize the Transaction in the wire format.
+     */
+    serialize(config?: SerializeConfig): Buffer;
+    /**
+     * Parse a wire transaction into a Transaction object.
+     */
+    static from(buffer: Buffer | Uint8Array | Array<number>): Transaction;
+    /**
+     * Populate Transaction object from message and signatures
+     */
+    static populate(message: Message, signatures?: Array<string>): Transaction;
+  }
+
+  export type CreateLookupTableParams = {
+    /** Account used to derive and control the new address lookup table. */
+    authority: PublicKey;
+    /** Account that will fund the new address lookup table. */
+    payer: PublicKey;
+    /** A recent slot must be used in the derivation path for each initialized table. */
+    recentSlot: bigint | number;
+  };
+  export type FreezeLookupTableParams = {
+    /** Address lookup table account to freeze. */
+    lookupTable: PublicKey;
+    /** Account which is the current authority. */
+    authority: PublicKey;
+  };
+  export type ExtendLookupTableParams = {
+    /** Address lookup table account to extend. */
+    lookupTable: PublicKey;
+    /** Account which is the current authority. */
+    authority: PublicKey;
+    /** Account that will fund the table reallocation.
+     * Not required if the reallocation has already been funded. */
+    payer?: PublicKey;
+    /** List of Public Keys to be added to the lookup table. */
+    addresses: Array<PublicKey>;
+  };
+  export type DeactivateLookupTableParams = {
+    /** Address lookup table account to deactivate. */
+    lookupTable: PublicKey;
+    /** Account which is the current authority. */
+    authority: PublicKey;
+  };
+  export type CloseLookupTableParams = {
+    /** Address lookup table account to close. */
+    lookupTable: PublicKey;
+    /** Account which is the current authority. */
+    authority: PublicKey;
+    /** Recipient of closed account lamports. */
+    recipient: PublicKey;
+  };
+  /**
+   * An enumeration of valid LookupTableInstructionType's
+   */
+  export type LookupTableInstructionType =
+    | 'CreateLookupTable'
+    | 'ExtendLookupTable'
+    | 'CloseLookupTable'
+    | 'FreezeLookupTable'
+    | 'DeactivateLookupTable';
+  export class AddressLookupTableInstruction {
+    static decodeInstructionType(
+      instruction: TransactionInstruction,
+    ): LookupTableInstructionType;
+    static decodeCreateLookupTable(
+      instruction: TransactionInstruction,
+    ): CreateLookupTableParams;
+    static decodeExtendLookupTable(
+      instruction: TransactionInstruction,
+    ): ExtendLookupTableParams;
+    static decodeCloseLookupTable(
+      instruction: TransactionInstruction,
+    ): CloseLookupTableParams;
+    static decodeFreezeLookupTable(
+      instruction: TransactionInstruction,
+    ): FreezeLookupTableParams;
+    static decodeDeactivateLookupTable(
+      instruction: TransactionInstruction,
+    ): DeactivateLookupTableParams;
+  }
+  export class AddressLookupTableProgram {
+    static programId: PublicKey;
+    static createLookupTable(
+      params: CreateLookupTableParams,
+    ): [TransactionInstruction, PublicKey];
+    static freezeLookupTable(
+      params: FreezeLookupTableParams,
+    ): TransactionInstruction;
+    static extendLookupTable(
+      params: ExtendLookupTableParams,
+    ): TransactionInstruction;
+    static deactivateLookupTable(
+      params: DeactivateLookupTableParams,
+    ): TransactionInstruction;
+    static closeLookupTable(
+      params: CloseLookupTableParams,
+    ): TransactionInstruction;
+  }
+
+  export const BPF_LOADER_DEPRECATED_PROGRAM_ID: PublicKey;
+
   export const BPF_LOADER_PROGRAM_ID: PublicKey;
   /**
    * Factory class for transactions to interact with a program loader