@solana/web3.js 1.54.0 → 1.56.0

package/lib/index.d.ts

@@ -141,7 +141,9 @@ declare module '@solana/web3.js' {
      */
     get publicKey(): PublicKey;
     /**
-     * The **unencrypted** secret key for this account
+     * The **unencrypted** secret key for this account. The first 32 bytes
+     * is the private scalar and the last 32 bytes is the public key.
+     * Read more: https://blog.mozilla.org/warner/2011/11/29/ed25519-keys/
      */
     get secretKey(): Buffer;
   }
@@ -218,17 +220,24 @@ declare module '@solana/web3.js' {
   }
 
   /**
-   * Keypair signer interface
+   * A 64 byte secret key, the first 32 bytes of which is the
+   * private scalar and the last 32 bytes is the public key.
+   * Read more: https://blog.mozilla.org/warner/2011/11/29/ed25519-keys/
    */
-  interface Signer {
-    publicKey: PublicKey;
-    secretKey: Uint8Array;
-  }
+  export type Ed25519SecretKey = Uint8Array;
   /**
    * Ed25519 Keypair
    */
   interface Ed25519Keypair {
     publicKey: Uint8Array;
+    secretKey: Ed25519SecretKey;
+  }
+
+  /**
+   * Keypair signer interface
+   */
+  interface Signer {
+    publicKey: PublicKey;
     secretKey: Uint8Array;
   }
   /**
@@ -386,6 +395,7 @@ declare module '@solana/web3.js' {
 
   export type VersionedMessage = Message | MessageV0;
   export const VersionedMessage: {
+    deserializeMessageVersion(serializedMessage: Uint8Array): 'legacy' | number;
     deserialize: (serializedMessage: Uint8Array) => VersionedMessage;
   };
 
@@ -825,6 +835,13 @@ declare module '@solana/web3.js' {
   export type GetBlockConfig = {
     /** The level of finality desired */
     commitment?: Finality;
+  };
+  /**
+   * Configuration object for changing `getBlock` query behavior
+   */
+  export type GetVersionedBlockConfig = {
+    /** 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;
   };
@@ -897,6 +914,13 @@ declare module '@solana/web3.js' {
   export type GetTransactionConfig = {
     /** The level of finality desired */
     commitment?: Finality;
+  };
+  /**
+   * Configuration object for changing `getTransaction` query behavior
+   */
+  export type GetVersionedTransactionConfig = {
+    /** 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;
   };
@@ -1112,6 +1136,8 @@ declare module '@solana/web3.js' {
     postTokenBalances?: Array<TokenBalance> | null;
     /** The error result of transaction processing */
     err: TransactionError | null;
+    /** The collection of addresses loaded using address lookup tables */
+    loadedAddresses?: LoadedAddresses;
   };
   /**
    * A processed transaction from the RPC API
@@ -1131,6 +1157,26 @@ declare module '@solana/web3.js' {
     /** The unix timestamp of when the transaction was processed */
     blockTime?: number | null;
   };
+  /**
+   * A processed transaction from the RPC API
+   */
+  export type VersionedTransactionResponse = {
+    /** The slot during which the transaction was processed */
+    slot: number;
+    /** The transaction */
+    transaction: {
+      /** The transaction message */
+      message: VersionedMessage;
+      /** The transaction signatures */
+      signatures: string[];
+    };
+    /** Metadata produced from the transaction */
+    meta: ConfirmedTransactionMeta | null;
+    /** The unix timestamp of when the transaction was processed */
+    blockTime?: number | null;
+    /** The transaction version */
+    version?: TransactionVersion;
+  };
   /**
    * A confirmed transaction on the ledger
    *
@@ -1179,6 +1225,17 @@ declare module '@solana/web3.js' {
     /** Parsed instruction info */
     parsed: any;
   };
+  /**
+   * A parsed address table lookup
+   */
+  export type ParsedAddressTableLookup = {
+    /** Address lookup table account key */
+    accountKey: PublicKey;
+    /** Parsed instruction info */
+    writableIndexes: number[];
+    /** Parsed instruction info */
+    readonlyIndexes: number[];
+  };
   /**
    * A parsed transaction message
    */
@@ -1189,6 +1246,8 @@ declare module '@solana/web3.js' {
     instructions: (ParsedInstruction | PartiallyDecodedInstruction)[];
     /** Recent blockhash */
     recentBlockhash: string;
+    /** Address table lookups used to load additional accounts */
+    addressTableLookups?: ParsedAddressTableLookup[] | null;
   };
   /**
    * A parsed transaction
@@ -1217,6 +1276,8 @@ declare module '@solana/web3.js' {
     meta: ParsedTransactionMeta | null;
     /** The unix timestamp of when the transaction was processed */
     blockTime?: number | null;
+    /** The version of the transaction message */
+    version?: TransactionVersion;
   };
   /**
    * A processed block fetched from the RPC API
@@ -1239,6 +1300,46 @@ declare module '@solana/web3.js' {
       };
       /** Metadata produced from the transaction */
       meta: ConfirmedTransactionMeta | null;
+      /** The transaction version */
+      version?: TransactionVersion;
+    }>;
+    /** Vector of block rewards */
+    rewards?: Array<{
+      /** Public key of reward recipient */
+      pubkey: string;
+      /** Reward value in lamports */
+      lamports: number;
+      /** Account balance after reward is applied */
+      postBalance: number | null;
+      /** Type of reward received */
+      rewardType: string | null;
+    }>;
+    /** The unix timestamp of when the block was processed */
+    blockTime: number | null;
+  };
+  /**
+   * A processed block fetched from the RPC API
+   */
+  export type VersionedBlockResponse = {
+    /** Blockhash of this block */
+    blockhash: Blockhash;
+    /** Blockhash of this block's parent */
+    previousBlockhash: Blockhash;
+    /** Slot index of this block's parent */
+    parentSlot: number;
+    /** Vector of transactions with status meta and original message */
+    transactions: Array<{
+      /** The transaction */
+      transaction: {
+        /** The transaction message */
+        message: VersionedMessage;
+        /** The transaction signatures */
+        signatures: string[];
+      };
+      /** Metadata produced from the transaction */
+      meta: ConfirmedTransactionMeta | null;
+      /** The transaction version */
+      version?: TransactionVersion;
     }>;
     /** Vector of block rewards */
     rewards?: Array<{
@@ -2112,11 +2213,21 @@ declare module '@solana/web3.js' {
     getGenesisHash(): Promise<string>;
     /**
      * Fetch a processed block from the cluster.
+     *
+     * @deprecated Instead, call `getBlock` using a `GetVersionedBlockConfig` by
+     * setting the `maxSupportedTransactionVersion` property.
      */
     getBlock(
       slot: number,
       rawConfig?: GetBlockConfig,
     ): Promise<BlockResponse | null>;
+    /**
+     * Fetch a processed block from the cluster.
+     */
+    getBlock(
+      slot: number,
+      rawConfig?: GetVersionedBlockConfig,
+    ): Promise<VersionedBlockResponse | null>;
     getBlockHeight(
       commitmentOrConfig?: Commitment | GetBlockHeightConfig,
     ): Promise<number>;
@@ -2125,33 +2236,57 @@ declare module '@solana/web3.js' {
     ): Promise<RpcResponseAndContext<BlockProduction>>;
     /**
      * Fetch a confirmed or finalized transaction from the cluster.
+     *
+     * @deprecated Instead, call `getTransaction` using a
+     * `GetVersionedTransactionConfig` by setting the
+     * `maxSupportedTransactionVersion` property.
      */
     getTransaction(
       signature: string,
       rawConfig?: GetTransactionConfig,
     ): Promise<TransactionResponse | null>;
+    /**
+     * Fetch a confirmed or finalized transaction from the cluster.
+     */
+    getTransaction(
+      signature: string,
+      rawConfig: GetVersionedTransactionConfig,
+    ): Promise<VersionedTransactionResponse | null>;
     /**
      * Fetch parsed transaction details for a confirmed or finalized transaction
      */
     getParsedTransaction(
       signature: TransactionSignature,
-      commitmentOrConfig?: GetTransactionConfig | Finality,
-    ): Promise<ParsedConfirmedTransaction | null>;
+      commitmentOrConfig?: GetVersionedTransactionConfig | Finality,
+    ): Promise<ParsedTransactionWithMeta | null>;
     /**
      * Fetch parsed transaction details for a batch of confirmed transactions
      */
     getParsedTransactions(
       signatures: TransactionSignature[],
-      commitmentOrConfig?: GetTransactionConfig | Finality,
-    ): Promise<(ParsedConfirmedTransaction | null)[]>;
+      commitmentOrConfig?: GetVersionedTransactionConfig | Finality,
+    ): Promise<(ParsedTransactionWithMeta | null)[]>;
     /**
      * Fetch transaction details for a batch of confirmed transactions.
      * Similar to {@link getParsedTransactions} but returns a {@link TransactionResponse}.
+     *
+     * @deprecated Instead, call `getTransactions` using a
+     * `GetVersionedTransactionConfig` by setting the
+     * `maxSupportedTransactionVersion` property.
      */
     getTransactions(
       signatures: TransactionSignature[],
       commitmentOrConfig?: GetTransactionConfig | Finality,
     ): Promise<(TransactionResponse | null)[]>;
+    /**
+     * Fetch transaction details for a batch of confirmed transactions.
+     * Similar to {@link getParsedTransactions} but returns a {@link
+     * VersionedTransactionResponse}.
+     */
+    getTransactions(
+      signatures: TransactionSignature[],
+      commitmentOrConfig: GetVersionedTransactionConfig | Finality,
+    ): Promise<(VersionedTransactionResponse | null)[]>;
     /**
      * Fetch a list of Transactions and transaction statuses from the cluster
      * for a confirmed block.