@mysten/sui 1.32.0 → 1.34.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @mysten/sui.js
 
+## 1.34.0
+
+### Minor Changes
+
+- 3fb7a83: Fix transaction resolution when transactions are built with clients from older SDK
+  versions
+
+## 1.33.0
+
+### Minor Changes
+
+- a00522b: Add mvr APIs to core client
+
+### Patch Changes
+
+- Updated dependencies [a00522b]
+  - @mysten/utils@0.1.0
+  - @mysten/bcs@1.6.3
+
 ## 1.32.0
 
 ### Minor Changes

package/dist/cjs/client/client.d.ts

@@ -2,7 +2,7 @@ import type { Signer } from '../cryptography/index.js';
 import { Experimental_BaseClient } from '../experimental/client.js';
 import { JSONRpcTransport } from '../experimental/transports/jsonRPC.js';
 import type { Experimental_SuiClientTypes, SelfRegisteringClientExtension } from '../experimental/types.js';
-import type { Transaction } from '../transactions/index.js';
+import type { Transaction } from '../transactions/Transaction.js';
 import type { SuiTransport } from './http-transport.js';
 import type { AddressMetrics, AllEpochsAddressMetrics, Checkpoint, CheckpointPage, CoinBalance, CoinMetadata, CoinSupply, CommitteeInfo, DelegatedStake, DevInspectResults, DevInspectTransactionBlockParams, DryRunTransactionBlockParams, DryRunTransactionBlockResponse, DynamicFieldPage, EpochInfo, EpochMetricsPage, EpochPage, ExecuteTransactionBlockParams, GetAllBalancesParams, GetAllCoinsParams, GetBalanceParams, GetCheckpointParams, GetCheckpointsParams, GetCoinMetadataParams, GetCoinsParams, GetCommitteeInfoParams, GetDynamicFieldObjectParams, GetDynamicFieldsParams, GetLatestCheckpointSequenceNumberParams, GetLatestSuiSystemStateParams, GetMoveFunctionArgTypesParams, GetNormalizedMoveFunctionParams, GetNormalizedMoveModuleParams, GetNormalizedMoveModulesByPackageParams, GetNormalizedMoveStructParams, GetObjectParams, GetOwnedObjectsParams, GetProtocolConfigParams, GetReferenceGasPriceParams, GetStakesByIdsParams, GetStakesParams, GetTotalSupplyParams, GetTransactionBlockParams, MoveCallMetrics, MultiGetObjectsParams, MultiGetTransactionBlocksParams, NetworkMetrics, ObjectRead, Order, PaginatedCoins, PaginatedEvents, PaginatedObjectsResponse, PaginatedTransactionResponse, ProtocolConfig, QueryEventsParams, QueryTransactionBlocksParams, ResolvedNameServiceNames, ResolveNameServiceAddressParams, ResolveNameServiceNamesParams, SubscribeEventParams, SubscribeTransactionParams, SuiEvent, SuiMoveFunctionArgType, SuiMoveNormalizedFunction, SuiMoveNormalizedModule, SuiMoveNormalizedModules, SuiMoveNormalizedStruct, SuiObjectResponse, SuiSystemStateSummary, SuiTransactionBlockResponse, TransactionEffects, TryGetPastObjectParams, Unsubscribe, ValidatorsApy, VerifyZkLoginSignatureParams, ZkLoginVerifyResult } from './types/index.js';
 export interface PaginationArguments<Cursor> {
@@ -20,6 +20,7 @@ export interface OrderArguments {
  */
 export type SuiClientOptions = NetworkOrTransport & {
     network?: Experimental_SuiClientTypes.Network;
+    mvr?: Experimental_SuiClientTypes.MvrOptions;
 };
 type NetworkOrTransport = {
     url: string;
@@ -47,7 +48,7 @@ export declare class SuiClient extends Experimental_BaseClient implements SelfRe
     /**
      * Get all Coin<`coin_type`> objects owned by an address.
      */
-    getCoins(input: GetCoinsParams): Promise<PaginatedCoins>;
+    getCoins({ coinType, owner, cursor, limit, signal, }: GetCoinsParams): Promise<PaginatedCoins>;
     /**
      * Get all Coin objects owned by an address.
      */
@@ -55,7 +56,7 @@ export declare class SuiClient extends Experimental_BaseClient implements SelfRe
     /**
      * Get the total coin balance for one coin type, owned by the address owner.
      */
-    getBalance(input: GetBalanceParams): Promise<CoinBalance>;
+    getBalance({ owner, coinType, signal }: GetBalanceParams): Promise<CoinBalance>;
     /**
      * Get the total coin balance for all coin types, owned by the address owner.
      */
@@ -63,11 +64,11 @@ export declare class SuiClient extends Experimental_BaseClient implements SelfRe
     /**
      * Fetch CoinMetadata for a given coin type
      */
-    getCoinMetadata(input: GetCoinMetadataParams): Promise<CoinMetadata | null>;
+    getCoinMetadata({ coinType, signal }: GetCoinMetadataParams): Promise<CoinMetadata | null>;
     /**
      *  Fetch total supply for a coin
      */
-    getTotalSupply(input: GetTotalSupplyParams): Promise<CoinSupply>;
+    getTotalSupply({ coinType, signal }: GetTotalSupplyParams): Promise<CoinSupply>;
     /**
      * Invoke any RPC method
      * @param method the method to be invoked
@@ -79,24 +80,24 @@ export declare class SuiClient extends Experimental_BaseClient implements SelfRe
     /**
      * Get Move function argument types like read, write and full access
      */
-    getMoveFunctionArgTypes(input: GetMoveFunctionArgTypesParams): Promise<SuiMoveFunctionArgType[]>;
+    getMoveFunctionArgTypes({ package: pkg, module, function: fn, signal, }: GetMoveFunctionArgTypesParams): Promise<SuiMoveFunctionArgType[]>;
     /**
      * Get a map from module name to
      * structured representations of Move modules
      */
-    getNormalizedMoveModulesByPackage(input: GetNormalizedMoveModulesByPackageParams): Promise<SuiMoveNormalizedModules>;
+    getNormalizedMoveModulesByPackage({ package: pkg, signal, }: GetNormalizedMoveModulesByPackageParams): Promise<SuiMoveNormalizedModules>;
     /**
      * Get a structured representation of Move module
      */
-    getNormalizedMoveModule(input: GetNormalizedMoveModuleParams): Promise<SuiMoveNormalizedModule>;
+    getNormalizedMoveModule({ package: pkg, module, signal, }: GetNormalizedMoveModuleParams): Promise<SuiMoveNormalizedModule>;
     /**
      * Get a structured representation of Move function
      */
-    getNormalizedMoveFunction(input: GetNormalizedMoveFunctionParams): Promise<SuiMoveNormalizedFunction>;
+    getNormalizedMoveFunction({ package: pkg, module, function: fn, signal, }: GetNormalizedMoveFunctionParams): Promise<SuiMoveNormalizedFunction>;
     /**
      * Get a structured representation of Move struct
      */
-    getNormalizedMoveStruct(input: GetNormalizedMoveStructParams): Promise<SuiMoveNormalizedStruct>;
+    getNormalizedMoveStruct({ package: pkg, module, struct, signal, }: GetNormalizedMoveStructParams): Promise<SuiMoveNormalizedStruct>;
     /**
      * Get all objects owned by an address
      */
@@ -113,7 +114,7 @@ export declare class SuiClient extends Experimental_BaseClient implements SelfRe
     /**
      * Get transaction blocks for a given query criteria
      */
-    queryTransactionBlocks(input: QueryTransactionBlocksParams): Promise<PaginatedTransactionResponse>;
+    queryTransactionBlocks({ filter, options, cursor, limit, order, signal, }: QueryTransactionBlocksParams): Promise<PaginatedTransactionResponse>;
     getTransactionBlock(input: GetTransactionBlockParams): Promise<SuiTransactionBlockResponse>;
     multiGetTransactionBlocks(input: MultiGetTransactionBlocksParams): Promise<SuiTransactionBlockResponse[]>;
     executeTransactionBlock({ transactionBlock, signature, options, requestType, signal, }: ExecuteTransactionBlockParams): Promise<SuiTransactionBlockResponse>;
@@ -146,7 +147,7 @@ export declare class SuiClient extends Experimental_BaseClient implements SelfRe
     /**
      * Get events for a given query criteria
      */
-    queryEvents(input: QueryEventsParams): Promise<PaginatedEvents>;
+    queryEvents({ query, cursor, limit, order, signal, }: QueryEventsParams): Promise<PaginatedEvents>;
     /**
      * Subscribe to get notifications whenever an event matching the filter occurs
      *

package/dist/cjs/client/client.js

@@ -25,10 +25,12 @@ module.exports = __toCommonJS(client_exports);
 var import_bcs = require("@mysten/bcs");
 var import_client = require("../experimental/client.js");
 var import_jsonRPC = require("../experimental/transports/jsonRPC.js");
-var import_transactions = require("../transactions/index.js");
+var import_Transaction = require("../transactions/Transaction.js");
 var import_sui_types = require("../utils/sui-types.js");
 var import_suins = require("../utils/suins.js");
 var import_http_transport = require("./http-transport.js");
+var import_move_registry = require("../utils/move-registry.js");
+var import_mvr = require("../experimental/mvr.js");
 const SUI_CLIENT_BRAND = Symbol.for("@mysten/SuiClient");
 function isSuiClient(client) {
   return typeof client === "object" && client !== null && client[SUI_CLIENT_BRAND] === true;
@@ -41,9 +43,12 @@ class SuiClient extends import_client.Experimental_BaseClient {
    */
   constructor(options) {
     super({ network: options.network ?? "unknown" });
-    this.core = new import_jsonRPC.JSONRpcTransport(this);
     this.jsonRpc = this;
     this.transport = options.transport ?? new import_http_transport.SuiHTTPTransport({ url: options.url });
+    this.core = new import_jsonRPC.JSONRpcTransport({
+      jsonRpcClient: this,
+      mvr: options.mvr
+    });
   }
   get [SUI_CLIENT_BRAND]() {
     return true;
@@ -59,14 +64,25 @@ class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Get all Coin<`coin_type`> objects owned by an address.
    */
-  async getCoins(input) {
-    if (!input.owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(input.owner))) {
+  async getCoins({
+    coinType,
+    owner,
+    cursor,
+    limit,
+    signal
+  }) {
+    if (!owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(owner))) {
       throw new Error("Invalid Sui address");
     }
+    if (coinType && (0, import_mvr.hasMvrName)(coinType)) {
+      coinType = (await this.core.mvr.resolveType({
+        type: coinType
+      })).type;
+    }
     return await this.transport.request({
       method: "suix_getCoins",
-      params: [input.owner, input.coinType, input.cursor, input.limit],
-      signal: input.signal
+      params: [owner, coinType, cursor, limit],
+      signal
     });
   }
   /**
@@ -85,14 +101,19 @@ class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Get the total coin balance for one coin type, owned by the address owner.
    */
-  async getBalance(input) {
-    if (!input.owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(input.owner))) {
+  async getBalance({ owner, coinType, signal }) {
+    if (!owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(owner))) {
       throw new Error("Invalid Sui address");
     }
+    if (coinType && (0, import_mvr.hasMvrName)(coinType)) {
+      coinType = (await this.core.mvr.resolveType({
+        type: coinType
+      })).type;
+    }
     return await this.transport.request({
       method: "suix_getBalance",
-      params: [input.owner, input.coinType],
-      signal: input.signal
+      params: [owner, coinType],
+      signal
     });
   }
   /**
@@ -111,21 +132,31 @@ class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Fetch CoinMetadata for a given coin type
    */
-  async getCoinMetadata(input) {
+  async getCoinMetadata({ coinType, signal }) {
+    if (coinType && (0, import_mvr.hasMvrName)(coinType)) {
+      coinType = (await this.core.mvr.resolveType({
+        type: coinType
+      })).type;
+    }
     return await this.transport.request({
       method: "suix_getCoinMetadata",
-      params: [input.coinType],
-      signal: input.signal
+      params: [coinType],
+      signal
     });
   }
   /**
    *  Fetch total supply for a coin
    */
-  async getTotalSupply(input) {
+  async getTotalSupply({ coinType, signal }) {
+    if (coinType && (0, import_mvr.hasMvrName)(coinType)) {
+      coinType = (await this.core.mvr.resolveType({
+        type: coinType
+      })).type;
+    }
     return await this.transport.request({
       method: "suix_getTotalSupply",
-      params: [input.coinType],
-      signal: input.signal
+      params: [coinType],
+      signal
     });
   }
   /**
@@ -139,52 +170,99 @@ class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Get Move function argument types like read, write and full access
    */
-  async getMoveFunctionArgTypes(input) {
+  async getMoveFunctionArgTypes({
+    package: pkg,
+    module: module2,
+    function: fn,
+    signal
+  }) {
+    if (pkg && (0, import_move_registry.isValidNamedPackage)(pkg)) {
+      pkg = (await this.core.mvr.resolvePackage({
+        package: pkg
+      })).package;
+    }
     return await this.transport.request({
       method: "sui_getMoveFunctionArgTypes",
-      params: [input.package, input.module, input.function],
-      signal: input.signal
+      params: [pkg, module2, fn],
+      signal
     });
   }
   /**
    * Get a map from module name to
    * structured representations of Move modules
    */
-  async getNormalizedMoveModulesByPackage(input) {
+  async getNormalizedMoveModulesByPackage({
+    package: pkg,
+    signal
+  }) {
+    if (pkg && (0, import_move_registry.isValidNamedPackage)(pkg)) {
+      pkg = (await this.core.mvr.resolvePackage({
+        package: pkg
+      })).package;
+    }
     return await this.transport.request({
       method: "sui_getNormalizedMoveModulesByPackage",
-      params: [input.package],
-      signal: input.signal
+      params: [pkg],
+      signal
     });
   }
   /**
    * Get a structured representation of Move module
    */
-  async getNormalizedMoveModule(input) {
+  async getNormalizedMoveModule({
+    package: pkg,
+    module: module2,
+    signal
+  }) {
+    if (pkg && (0, import_move_registry.isValidNamedPackage)(pkg)) {
+      pkg = (await this.core.mvr.resolvePackage({
+        package: pkg
+      })).package;
+    }
     return await this.transport.request({
       method: "sui_getNormalizedMoveModule",
-      params: [input.package, input.module],
-      signal: input.signal
+      params: [pkg, module2],
+      signal
     });
   }
   /**
    * Get a structured representation of Move function
    */
-  async getNormalizedMoveFunction(input) {
+  async getNormalizedMoveFunction({
+    package: pkg,
+    module: module2,
+    function: fn,
+    signal
+  }) {
+    if (pkg && (0, import_move_registry.isValidNamedPackage)(pkg)) {
+      pkg = (await this.core.mvr.resolvePackage({
+        package: pkg
+      })).package;
+    }
     return await this.transport.request({
       method: "sui_getNormalizedMoveFunction",
-      params: [input.package, input.module, input.function],
-      signal: input.signal
+      params: [pkg, module2, fn],
+      signal
     });
   }
   /**
    * Get a structured representation of Move struct
    */
-  async getNormalizedMoveStruct(input) {
+  async getNormalizedMoveStruct({
+    package: pkg,
+    module: module2,
+    struct,
+    signal
+  }) {
+    if (pkg && (0, import_move_registry.isValidNamedPackage)(pkg)) {
+      pkg = (await this.core.mvr.resolvePackage({
+        package: pkg
+      })).package;
+    }
     return await this.transport.request({
       method: "sui_getNormalizedMoveStruct",
-      params: [input.package, input.module, input.struct],
-      signal: input.signal
+      params: [pkg, module2, struct],
+      signal
     });
   }
   /**
@@ -194,12 +272,27 @@ class SuiClient extends import_client.Experimental_BaseClient {
     if (!input.owner || !(0, import_sui_types.isValidSuiAddress)((0, import_sui_types.normalizeSuiAddress)(input.owner))) {
       throw new Error("Invalid Sui address");
     }
+    const filter = input.filter ? {
+      ...input.filter
+    } : void 0;
+    if (filter && "MoveModule" in filter && (0, import_move_registry.isValidNamedPackage)(filter.MoveModule.package)) {
+      filter.MoveModule = {
+        module: filter.MoveModule.module,
+        package: (await this.core.mvr.resolvePackage({
+          package: filter.MoveModule.package
+        })).package
+      };
+    } else if (filter && "StructType" in filter && (0, import_mvr.hasMvrName)(filter.StructType)) {
+      filter.StructType = (await this.core.mvr.resolveType({
+        type: filter.StructType
+      })).type;
+    }
     return await this.transport.request({
       method: "suix_getOwnedObjects",
       params: [
         input.owner,
         {
-          filter: input.filter,
+          filter,
           options: input.options
         },
         input.cursor,
@@ -250,19 +343,36 @@ class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Get transaction blocks for a given query criteria
    */
-  async queryTransactionBlocks(input) {
+  async queryTransactionBlocks({
+    filter,
+    options,
+    cursor,
+    limit,
+    order,
+    signal
+  }) {
+    if (filter && "MoveFunction" in filter && (0, import_move_registry.isValidNamedPackage)(filter.MoveFunction.package)) {
+      filter = {
+        ...filter,
+        MoveFunction: {
+          package: (await this.core.mvr.resolvePackage({
+            package: filter.MoveFunction.package
+          })).package
+        }
+      };
+    }
     return await this.transport.request({
       method: "suix_queryTransactionBlocks",
       params: [
         {
-          filter: input.filter,
-          options: input.options
+          filter,
+          options
         },
-        input.cursor,
-        input.limit,
-        (input.order || "descending") === "descending"
+        cursor,
+        limit,
+        (order || "descending") === "descending"
       ],
-      signal: input.signal
+      signal
     });
   }
   async getTransactionBlock(input) {
@@ -401,16 +511,47 @@ class SuiClient extends import_client.Experimental_BaseClient {
   /**
    * Get events for a given query criteria
    */
-  async queryEvents(input) {
+  async queryEvents({
+    query,
+    cursor,
+    limit,
+    order,
+    signal
+  }) {
+    if (query && "MoveEventType" in query && (0, import_mvr.hasMvrName)(query.MoveEventType)) {
+      query = {
+        ...query,
+        MoveEventType: (await this.core.mvr.resolveType({
+          type: query.MoveEventType
+        })).type
+      };
+    }
+    if (query && "MoveEventModule" in query && (0, import_move_registry.isValidNamedPackage)(query.MoveEventModule.package)) {
+      query = {
+        ...query,
+        MoveEventModule: {
+          module: query.MoveEventModule.module,
+          package: (await this.core.mvr.resolvePackage({
+            package: query.MoveEventModule.package
+          })).package
+        }
+      };
+    }
+    if ("MoveModule" in query && (0, import_move_registry.isValidNamedPackage)(query.MoveModule.package)) {
+      query = {
+        ...query,
+        MoveModule: {
+          module: query.MoveModule.module,
+          package: (await this.core.mvr.resolvePackage({
+            package: query.MoveModule.package
+          })).package
+        }
+      };
+    }
     return await this.transport.request({
       method: "suix_queryEvents",
-      params: [
-        input.query,
-        input.cursor,
-        input.limit,
-        (input.order || "descending") === "descending"
-      ],
-      signal: input.signal
+      params: [query, cursor, limit, (order || "descending") === "descending"],
+      signal
     });
   }
   /**
@@ -446,7 +587,7 @@ class SuiClient extends import_client.Experimental_BaseClient {
    */
   async devInspectTransactionBlock(input) {
     let devInspectTxBytes;
-    if ((0, import_transactions.isTransaction)(input.transactionBlock)) {
+    if ((0, import_Transaction.isTransaction)(input.transactionBlock)) {
       input.transactionBlock.setSenderIfNotSet(input.sender);
       devInspectTxBytes = (0, import_bcs.toBase64)(
         await input.transactionBlock.build({