@solana/web3.js 1.54.1 → 1.56.1

package/lib/index.d.ts

@@ -395,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;
   };
 
@@ -834,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;
   };
@@ -906,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;
   };
@@ -1121,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
@@ -1140,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
    *
@@ -1188,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
    */
@@ -1198,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
@@ -1226,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
@@ -1248,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<{
@@ -2121,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>;
@@ -2134,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.

package/lib/index.esm.js

@@ -862,16 +862,24 @@ class MessageV0 {
 
 // eslint-disable-next-line no-redeclare
 const VersionedMessage = {
-  deserialize: serializedMessage => {
+  deserializeMessageVersion(serializedMessage) {
     const prefix = serializedMessage[0];
     const maskedPrefix = prefix & VERSION_PREFIX_MASK; // if the highest bit of the prefix is not set, the message is not versioned
 
     if (maskedPrefix === prefix) {
-      return Message.from(serializedMessage);
+      return 'legacy';
     } // the lower 7 bits of the prefix indicate the message version
 
 
-    const version = maskedPrefix;
+    return maskedPrefix;
+  },
+
+  deserialize: serializedMessage => {
+    const version = VersionedMessage.deserializeMessageVersion(serializedMessage);
+
+    if (version === 'legacy') {
+      return Message.from(serializedMessage);
+    }
 
     if (version === 0) {
       return MessageV0.deserialize(serializedMessage);
@@ -3255,6 +3263,28 @@ function notificationResultAndContext(value) {
     value
   });
 }
+/**
+ * @internal
+ */
+
+
+function versionedMessageFromResponse(version, response) {
+  if (version === 0) {
+    return new MessageV0({
+      header: response.header,
+      staticAccountKeys: response.accountKeys.map(accountKey => new PublicKey(accountKey)),
+      recentBlockhash: response.recentBlockhash,
+      compiledInstructions: response.instructions.map(ix => ({
+        programIdIndex: ix.programIdIndex,
+        accountKeyIndexes: ix.accounts,
+        data: bs58.decode(ix.data)
+      })),
+      addressTableLookups: response.addressTableLookups
+    });
+  } else {
+    return new Message(response);
+  }
+}
 /**
  * The level of commitment desired when querying state
  * <pre>
@@ -3818,6 +3848,11 @@ const GetSignatureStatusesRpcResult = jsonRpcResultAndContext(array(nullable(Sig
  */
 
 const GetMinimumBalanceForRentExemptionRpcResult = jsonRpcResult(number());
+const AddressTableLookupStruct = type({
+  accountKey: PublicKeyFromString,
+  writableIndexes: array(number()),
+  readonlyIndexes: array(number())
+});
 const ConfirmedTransactionResult = type({
   signatures: array(string()),
   message: type({
@@ -3832,7 +3867,8 @@ const ConfirmedTransactionResult = type({
       data: string(),
       programIdIndex: number()
     })),
-    recentBlockhash: string()
+    recentBlockhash: string(),
+    addressTableLookups: optional(array(AddressTableLookupStruct))
   })
 });
 const ParsedInstructionResult = type({
@@ -3875,7 +3911,8 @@ const ParsedConfirmedTransactionResult = type({
       writable: boolean()
     })),
     instructions: array(ParsedOrRawInstruction),
-    recentBlockhash: string()
+    recentBlockhash: string(),
+    addressTableLookups: optional(nullable(array(AddressTableLookupStruct)))
   })
 });
 const TokenBalanceResult = type({
@@ -3928,6 +3965,7 @@ const ParsedConfirmedTransactionMetaResult = type({
   postTokenBalances: optional(nullable(array(TokenBalanceResult))),
   loadedAddresses: optional(LoadedAddressesResult)
 });
+const TransactionVersionStruct = union([literal(0), literal('legacy')]);
 /**
  * Expected JSON RPC response for the "getBlock" message
  */
@@ -3938,7 +3976,8 @@ const GetBlockRpcResult = jsonRpcResult(nullable(type({
   parentSlot: number(),
   transactions: array(type({
     transaction: ConfirmedTransactionResult,
-    meta: nullable(ConfirmedTransactionMetaResult)
+    meta: nullable(ConfirmedTransactionMetaResult),
+    version: optional(TransactionVersionStruct)
   })),
   rewards: optional(array(type({
     pubkey: string(),
@@ -3990,7 +4029,8 @@ const GetTransactionRpcResult = jsonRpcResult(nullable(type({
   slot: number(),
   meta: ConfirmedTransactionMetaResult,
   blockTime: optional(nullable(number())),
-  transaction: ConfirmedTransactionResult
+  transaction: ConfirmedTransactionResult,
+  version: optional(TransactionVersionStruct)
 })));
 /**
  * Expected parsed JSON RPC response for the "getTransaction" message
@@ -4000,7 +4040,8 @@ const GetParsedTransactionRpcResult = jsonRpcResult(nullable(type({
   slot: number(),
   transaction: ParsedConfirmedTransactionResult,
   meta: nullable(ParsedConfirmedTransactionMetaResult),
-  blockTime: optional(nullable(number()))
+  blockTime: optional(nullable(number())),
+  version: optional(TransactionVersionStruct)
 })));
 /**
  * Expected JSON RPC response for the "getRecentBlockhash" message
@@ -5243,9 +5284,16 @@ class Connection {
   }
   /**
    * Fetch a processed block from the cluster.
+   *
+   * @deprecated Instead, call `getBlock` using a `GetVersionedBlockConfig` by
+   * setting the `maxSupportedTransactionVersion` property.
    */
 
 
+  /**
+   * Fetch a processed block from the cluster.
+   */
+  // eslint-disable-next-line no-dupe-class-members
   async getBlock(slot, rawConfig) {
     const {
       commitment,
@@ -5268,16 +5316,15 @@ class Connection {
     return { ...result,
       transactions: result.transactions.map(({
         transaction,
-        meta
-      }) => {
-        const message = new Message(transaction.message);
-        return {
-          meta,
-          transaction: { ...transaction,
-            message
-          }
-        };
-      })
+        meta,
+        version
+      }) => ({
+        meta,
+        transaction: { ...transaction,
+          message: versionedMessageFromResponse(version, transaction.message)
+        },
+        version
+      }))
     };
   }
   /*
@@ -5337,9 +5384,17 @@ class Connection {
   }
   /**
    * Fetch a confirmed or finalized transaction from the cluster.
+   *
+   * @deprecated Instead, call `getTransaction` using a
+   * `GetVersionedTransactionConfig` by setting the
+   * `maxSupportedTransactionVersion` property.
    */
 
 
+  /**
+   * Fetch a confirmed or finalized transaction from the cluster.
+   */
+  // eslint-disable-next-line no-dupe-class-members
   async getTransaction(signature, rawConfig) {
     const {
       commitment,
@@ -5361,7 +5416,7 @@ class Connection {
     if (!result) return result;
     return { ...result,
       transaction: { ...result.transaction,
-        message: new Message(result.transaction.message)
+        message: versionedMessageFromResponse(result.version, result.transaction.message)
       }
     };
   }
@@ -5420,9 +5475,19 @@ class Connection {
   /**
    * 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.
    */
 
 
+  /**
+   * Fetch transaction details for a batch of confirmed transactions.
+   * Similar to {@link getParsedTransactions} but returns a {@link
+   * VersionedTransactionResponse}.
+   */
+  // eslint-disable-next-line no-dupe-class-members
   async getTransactions(signatures, commitmentOrConfig) {
     const {
       commitment,
@@ -5450,7 +5515,7 @@ class Connection {
       if (!result) return result;
       return { ...result,
         transaction: { ...result.transaction,
-          message: new Message(result.transaction.message)
+          message: versionedMessageFromResponse(result.version, result.transaction.message)
         }
       };
     });