@mysten/sui 1.24.0 → 1.25.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mysten/sui.js
 
+## 1.25.0
+
+### Minor Changes
+
+- e8b5d04: Update NamedPackagesPlugin to use the new MVR API and support single-types in the cache
+
 ## 1.24.0
 
 ### Minor Changes

package/dist/cjs/transactions/Arguments.d.ts

@@ -25,8 +25,8 @@ export declare const Arguments: {
         type?: "object";
     };
     objectRef: (args_0: {
-        objectId: string;
         version: string | number;
+        objectId: string;
         digest: string;
     }) => (tx: Transaction) => {
         $kind: "Input";
@@ -34,8 +34,8 @@ export declare const Arguments: {
         type?: "object";
     };
     receivingRef: (args_0: {
-        objectId: string;
         version: string | number;
+        objectId: string;
         digest: string;
     }) => (tx: Transaction) => {
         $kind: "Input";

package/dist/cjs/transactions/Transaction.d.ts

@@ -290,8 +290,8 @@ export declare class Transaction {
         })[];
         gasConfig: {
             payment?: {
-                objectId: string;
                 version: string | number | bigint;
+                objectId: string;
                 digest: string;
             }[] | undefined;
             owner?: string | undefined;
@@ -311,8 +311,8 @@ export declare class Transaction {
         inputs: import("@mysten/bcs").EnumOutputShapeWithKeys<{
             Object: import("@mysten/bcs").EnumOutputShapeWithKeys<{
                 ImmOrOwnedObject: {
-                    objectId: string;
                     version: string | number;
+                    objectId: string;
                     digest: string;
                 };
                 SharedObject: {
@@ -321,8 +321,8 @@ export declare class Transaction {
                     mutable: boolean;
                 };
                 Receiving: {
-                    objectId: string;
                     version: string | number;
+                    objectId: string;
                     digest: string;
                 };
             }, "ImmOrOwnedObject" | "SharedObject" | "Receiving">;
@@ -576,8 +576,8 @@ export declare class Transaction {
         }, "MoveCall" | "TransferObjects" | "SplitCoins" | "MergeCoins" | "Publish" | "MakeMoveVec" | "Upgrade" | "$Intent">[];
         gasData: {
             payment: {
-                objectId: string;
                 version: string | number;
+                objectId: string;
                 digest: string;
             }[] | null;
             owner: string | null;

package/dist/cjs/transactions/TransactionData.d.ts

@@ -16,8 +16,8 @@ export declare class TransactionDataBuilder implements TransactionData {
     static getDigestFromBytes(bytes: Uint8Array): string;
     get gasConfig(): {
         payment: {
-            objectId: string;
             version: string | number;
+            objectId: string;
             digest: string;
         }[] | null;
         owner: string | null;
@@ -26,8 +26,8 @@ export declare class TransactionDataBuilder implements TransactionData {
     };
     set gasConfig(value: {
         payment: {
-            objectId: string;
             version: string | number;
+            objectId: string;
             digest: string;
         }[] | null;
         owner: string | null;

package/dist/cjs/transactions/data/v1.d.ts

@@ -9,8 +9,8 @@ export declare const ObjectRef: import("valibot").ObjectSchema<{
 export declare const NormalizedCallArg: GenericSchema<import("@mysten/bcs").EnumInputShape<{
     Object: import("@mysten/bcs").EnumInputShape<{
         ImmOrOwned: {
-            objectId: string;
             version: string | number | bigint;
+            objectId: string;
             digest: string;
         };
         Shared: {
@@ -19,8 +19,8 @@ export declare const NormalizedCallArg: GenericSchema<import("@mysten/bcs").Enum
             mutable: boolean;
         };
         Receiving: {
-            objectId: string;
             version: string | number | bigint;
+            objectId: string;
             digest: string;
         };
     }>;
@@ -28,8 +28,8 @@ export declare const NormalizedCallArg: GenericSchema<import("@mysten/bcs").Enum
 }>, import("@mysten/bcs").EnumOutputShapeWithKeys<{
     Object: import("@mysten/bcs").EnumOutputShapeWithKeys<{
         ImmOrOwned: {
-            objectId: string;
             version: string | number | bigint;
+            objectId: string;
             digest: string;
         };
         Shared: {
@@ -38,8 +38,8 @@ export declare const NormalizedCallArg: GenericSchema<import("@mysten/bcs").Enum
             mutable: boolean;
         };
         Receiving: {
-            objectId: string;
             version: string | number | bigint;
+            objectId: string;
             digest: string;
         };
     }, "Receiving" | "Shared" | "ImmOrOwned">;

package/dist/cjs/transactions/data/v2.d.ts

@@ -23,8 +23,8 @@ export declare const SerializedTransactionDataV2: import("valibot").ObjectSchema
     readonly inputs: import("valibot").ArraySchema<GenericSchema<EnumInputShape<{
         Object: EnumInputShape<{
             ImmOrOwnedObject: {
-                objectId: string;
                 version: string | number;
+                objectId: string;
                 digest: string;
             };
             SharedObject: {
@@ -33,8 +33,8 @@ export declare const SerializedTransactionDataV2: import("valibot").ObjectSchema
                 mutable: boolean;
             };
             Receiving: {
-                objectId: string;
                 version: string | number;
+                objectId: string;
                 digest: string;
             };
         }>;
@@ -53,8 +53,8 @@ export declare const SerializedTransactionDataV2: import("valibot").ObjectSchema
     }>, EnumInputShape<{
         Object: EnumInputShape<{
             ImmOrOwnedObject: {
-                objectId: string;
                 version: string | number;
+                objectId: string;
                 digest: string;
             };
             SharedObject: {
@@ -63,8 +63,8 @@ export declare const SerializedTransactionDataV2: import("valibot").ObjectSchema
                 mutable: boolean;
             };
             Receiving: {
-                objectId: string;
                 version: string | number;
+                objectId: string;
                 digest: string;
             };
         }>;

package/dist/cjs/transactions/plugins/NamedPackagesPlugin.d.ts

@@ -1,15 +1,11 @@
-import type { SuiGraphQLClient } from '../../graphql/client.js';
 import type { BuildTransactionOptions } from '../json-rpc-resolver.js';
 import type { TransactionDataBuilder } from '../TransactionData.js';
 import type { NamedPackagesPluginCache } from './utils.js';
 export type NamedPackagesPluginOptions = {
     /**
-     * The SuiGraphQLClient to use for resolving names.
-     * The endpoint should be the GraphQL endpoint of the network you are targeting.
-     * For non-mainnet networks, if the plugin doesn't work as expected, you need to validate that the
-     * RPC provider has support for the `packageByName` and `typeByName` queries (using external resolver).
+     * The URL of the MVR API to use for resolving names.
      */
-    suiGraphQLClient: SuiGraphQLClient;
+    url: string;
     /**
      * The number of names to resolve in each batch request.
      * Needs to be calculated based on the GraphQL query limits.
@@ -19,6 +15,8 @@ export type NamedPackagesPluginOptions = {
      * Local overrides for the resolution plugin. Pass this to pre-populate
      * the cache with known packages / types (especially useful for local or CI testing).
      *
+     * The type cache expects ONLY first-level types to ensure the cache is more composable.
+     *
      * 	Expected format example:
      *  {
      * 		packages: {
@@ -46,4 +44,4 @@ export type NamedPackagesPluginOptions = {
  *
  * You can also define `overrides` to pre-populate name resolutions locally (removes the GraphQL request).
  */
-export declare const namedPackagesPlugin: ({ suiGraphQLClient, pageSize, overrides, }: NamedPackagesPluginOptions) => (transactionData: TransactionDataBuilder, _buildOptions: BuildTransactionOptions, next: () => Promise<void>) => Promise<void>;
+export declare const namedPackagesPlugin: ({ url, pageSize, overrides, }: NamedPackagesPluginOptions) => (transactionData: TransactionDataBuilder, _buildOptions: BuildTransactionOptions, next: () => Promise<void>) => Promise<void>;

package/dist/cjs/transactions/plugins/NamedPackagesPlugin.js

@@ -21,58 +21,99 @@ __export(NamedPackagesPlugin_exports, {
   namedPackagesPlugin: () => namedPackagesPlugin
 });
 module.exports = __toCommonJS(NamedPackagesPlugin_exports);
+var import_sui_types = require("../../utils/sui-types.js");
 var import_utils = require("./utils.js");
 const namedPackagesPlugin = ({
-  suiGraphQLClient,
-  pageSize = 10,
+  url,
+  pageSize = 50,
   overrides = { packages: {}, types: {} }
 }) => {
-  const cache = {
-    packages: { ...overrides.packages },
-    types: { ...overrides.types }
-  };
+  Object.keys(overrides.types).forEach((type) => {
+    if ((0, import_sui_types.parseStructTag)(type).typeParams.length > 0)
+      throw new Error(
+        "Type overrides must be first-level only. If you want to supply generic types, just pass each type individually."
+      );
+  });
+  const cache = overrides;
   return async (transactionData, _buildOptions, next) => {
-    const names = (0, import_utils.findTransactionBlockNames)(transactionData);
-    const batches = (0, import_utils.listToRequests)(
-      {
-        packages: names.packages.filter((x) => !cache.packages[x]),
-        types: names.types.filter((x) => !cache.types[x])
-      },
-      pageSize
-    );
-    (await Promise.all(batches.map((batch) => query(suiGraphQLClient, batch)))).forEach((res) => {
-      Object.assign(cache.types, res.types);
-      Object.assign(cache.packages, res.packages);
+    const names = (0, import_utils.findNamesInTransaction)(transactionData);
+    const [packages, types] = await Promise.all([
+      resolvePackages(
+        names.packages.filter((x) => !cache.packages[x]),
+        url,
+        pageSize
+      ),
+      resolveTypes(
+        [...(0, import_utils.getFirstLevelNamedTypes)(names.types)].filter((x) => !cache.types[x]),
+        url,
+        pageSize
+      )
+    ]);
+    Object.assign(cache.packages, packages);
+    Object.assign(cache.types, types);
+    const composedTypes = (0, import_utils.populateNamedTypesFromCache)(names.types, cache.types);
+    (0, import_utils.replaceNames)(transactionData, {
+      packages: { ...cache.packages },
+      // we include the "composed" type cache too.
+      types: composedTypes
     });
-    (0, import_utils.replaceNames)(transactionData, cache);
     await next();
   };
-  async function query(client, requests) {
-    const results = { packages: {}, types: {} };
-    if (requests.length === 0) return results;
-    const gqlQuery = `{
-        ${requests.map((req) => {
-      const request = req.type === "package" ? "packageByName" : "typeByName";
-      const fields = req.type === "package" ? "address" : "repr";
-      return `${gqlQueryKey(req.id)}: ${request}(name:"${req.name}") {
-                    ${fields}
-                }`;
-    })}
-    }`;
-    const result = await client.query({
-      query: gqlQuery,
-      variables: void 0
-    });
-    if (result.errors) throw new Error(JSON.stringify({ query: gqlQuery, errors: result.errors }));
-    for (const req of requests) {
-      const key = gqlQueryKey(req.id);
-      if (!result.data || !result.data[key]) throw new Error(`No result found for: ${req.name}`);
-      const data = result.data[key];
-      if (req.type === "package") results.packages[req.name] = data.address;
-      if (req.type === "moveType") results.types[req.name] = data.repr;
-    }
+  async function resolvePackages(packages, apiUrl, pageSize2) {
+    if (packages.length === 0) return {};
+    const batches = (0, import_utils.batch)(packages, pageSize2);
+    const results = {};
+    await Promise.all(
+      batches.map(async (batch2) => {
+        const response = await fetch(`${apiUrl}/v1/resolution/bulk`, {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify({
+            names: batch2
+          })
+        });
+        if (!response.ok) {
+          const errorBody = await response.json().catch(() => ({}));
+          throw new Error(`Failed to resolve packages: ${errorBody?.message}`);
+        }
+        const data = await response.json();
+        if (!data?.resolution) return;
+        for (const pkg of Object.keys(data?.resolution)) {
+          const pkgData = data.resolution[pkg]?.package_id;
+          if (!pkgData) continue;
+          results[pkg] = pkgData;
+        }
+      })
+    );
+    return results;
+  }
+  async function resolveTypes(types, apiUrl, pageSize2) {
+    if (types.length === 0) return {};
+    const batches = (0, import_utils.batch)(types, pageSize2);
+    const results = {};
+    await Promise.all(
+      batches.map(async (batch2) => {
+        const response = await fetch(`${apiUrl}/v1/struct-definition/bulk`, {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify({
+            types: batch2
+          })
+        });
+        if (!response.ok) {
+          const errorBody = await response.json().catch(() => ({}));
+          throw new Error(`Failed to resolve types: ${errorBody?.message}`);
+        }
+        const data = await response.json();
+        if (!data?.resolution) return;
+        for (const type of Object.keys(data?.resolution)) {
+          const typeData = data.resolution[type]?.type_tag;
+          if (!typeData) continue;
+          results[type] = typeData;
+        }
+      })
+    );
     return results;
   }
 };
-const gqlQueryKey = (idx) => `key_${idx}`;
 //# sourceMappingURL=NamedPackagesPlugin.js.map

package/dist/cjs/transactions/plugins/NamedPackagesPlugin.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/transactions/plugins/NamedPackagesPlugin.ts"],
-  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { SuiGraphQLClient } from '../../graphql/client.js';\nimport type { BuildTransactionOptions } from '../json-rpc-resolver.js';\nimport type { TransactionDataBuilder } from '../TransactionData.js';\nimport type { NamedPackagesPluginCache, NameResolutionRequest } from './utils.js';\nimport { findTransactionBlockNames, listToRequests, replaceNames } from './utils.js';\n\nexport type NamedPackagesPluginOptions = {\n\t/**\n\t * The SuiGraphQLClient to use for resolving names.\n\t * The endpoint should be the GraphQL endpoint of the network you are targeting.\n\t * For non-mainnet networks, if the plugin doesn't work as expected, you need to validate that the\n\t * RPC provider has support for the `packageByName` and `typeByName` queries (using external resolver).\n\t */\n\tsuiGraphQLClient: SuiGraphQLClient;\n\t/**\n\t * The number of names to resolve in each batch request.\n\t * Needs to be calculated based on the GraphQL query limits.\n\t */\n\tpageSize?: number;\n\t/**\n\t * Local overrides for the resolution plugin. Pass this to pre-populate\n\t * the cache with known packages / types (especially useful for local or CI testing).\n\t *\n\t * \tExpected format example:\n\t *  {\n\t * \t\tpackages: {\n\t * \t\t\t'@framework/std': '0x1234',\n\t * \t\t},\n\t * \t\ttypes: {\n\t * \t\t\t'@framework/std::string::String': '0x1234::string::String',\n\t * \t\t},\n\t * \t}\n\t *\n\t */\n\toverrides?: NamedPackagesPluginCache;\n};\n\n/**\n * @experimental This plugin is in experimental phase and there might be breaking changes in the future\n *\n * Adds named resolution so that you can use .move names in your transactions.\n * e.g. `@org/app::type::Type` will be resolved to `0x1234::type::Type`.\n * This plugin will resolve all names & types in the transaction block.\n *\n * To install this plugin globally in your app, use:\n * ```\n * Transaction.registerGlobalSerializationPlugin(\"namedPackagesPlugin\", namedPackagesPlugin({ suiGraphQLClient }));\n * ```\n *\n * You can also define `overrides` to pre-populate name resolutions locally (removes the GraphQL request).\n */\nexport const namedPackagesPlugin = ({\n\tsuiGraphQLClient,\n\tpageSize = 10,\n\toverrides = { packages: {}, types: {} },\n}: NamedPackagesPluginOptions) => {\n\tconst cache = {\n\t\tpackages: { ...overrides.packages },\n\t\ttypes: { ...overrides.types },\n\t};\n\n\treturn async (\n\t\ttransactionData: TransactionDataBuilder,\n\t\t_buildOptions: BuildTransactionOptions,\n\t\tnext: () => Promise<void>,\n\t) => {\n\t\tconst names = findTransactionBlockNames(transactionData);\n\t\tconst batches = listToRequests(\n\t\t\t{\n\t\t\t\tpackages: names.packages.filter((x) => !cache.packages[x]),\n\t\t\t\ttypes: names.types.filter((x) => !cache.types[x]),\n\t\t\t},\n\t\t\tpageSize,\n\t\t);\n\n\t\t// now we need to bulk resolve all the names + types, and replace them in the transaction data.\n\t\t(await Promise.all(batches.map((batch) => query(suiGraphQLClient, batch)))).forEach((res) => {\n\t\t\tObject.assign(cache.types, res.types);\n\t\t\tObject.assign(cache.packages, res.packages);\n\t\t});\n\n\t\treplaceNames(transactionData, cache);\n\n\t\tawait next();\n\t};\n\n\tasync function query(client: SuiGraphQLClient, requests: NameResolutionRequest[]) {\n\t\tconst results: NamedPackagesPluginCache = { packages: {}, types: {} };\n\t\t// avoid making a request if there are no names to resolve.\n\t\tif (requests.length === 0) return results;\n\n\t\t// Create multiple queries for each name / type we need to resolve\n\t\t// TODO: Replace with bulk APIs when available.\n\t\tconst gqlQuery = `{\n        ${requests.map((req) => {\n\t\t\t\t\tconst request = req.type === 'package' ? 'packageByName' : 'typeByName';\n\t\t\t\t\tconst fields = req.type === 'package' ? 'address' : 'repr';\n\n\t\t\t\t\treturn `${gqlQueryKey(req.id)}: ${request}(name:\"${req.name}\") {\n                    ${fields}\n                }`;\n\t\t\t\t})}\n    }`;\n\n\t\tconst result = await client.query({\n\t\t\tquery: gqlQuery,\n\t\t\tvariables: undefined,\n\t\t});\n\n\t\tif (result.errors) throw new Error(JSON.stringify({ query: gqlQuery, errors: result.errors }));\n\n\t\t// Parse the results and create a map of `<name|type> -> <address|repr>`\n\t\tfor (const req of requests) {\n\t\t\tconst key = gqlQueryKey(req.id);\n\t\t\tif (!result.data || !result.data[key]) throw new Error(`No result found for: ${req.name}`);\n\t\t\tconst data = result.data[key] as { address?: string; repr?: string };\n\n\t\t\tif (req.type === 'package') results.packages[req.name] = data.address!;\n\t\t\tif (req.type === 'moveType') results.types[req.name] = data.repr!;\n\t\t}\n\n\t\treturn results;\n\t}\n};\n\nconst gqlQueryKey = (idx: number) => `key_${idx}`;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,mBAAwE;AA+CjE,MAAM,sBAAsB,CAAC;AAAA,EACnC;AAAA,EACA,WAAW;AAAA,EACX,YAAY,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,EAAE;AACvC,MAAkC;AACjC,QAAM,QAAQ;AAAA,IACb,UAAU,EAAE,GAAG,UAAU,SAAS;AAAA,IAClC,OAAO,EAAE,GAAG,UAAU,MAAM;AAAA,EAC7B;AAEA,SAAO,OACN,iBACA,eACA,SACI;AACJ,UAAM,YAAQ,wCAA0B,eAAe;AACvD,UAAM,cAAU;AAAA,MACf;AAAA,QACC,UAAU,MAAM,SAAS,OAAO,CAAC,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;AAAA,QACzD,OAAO,MAAM,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,MAAM,CAAC,CAAC;AAAA,MACjD;AAAA,MACA;AAAA,IACD;AAGA,KAAC,MAAM,QAAQ,IAAI,QAAQ,IAAI,CAAC,UAAU,MAAM,kBAAkB,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ;AAC5F,aAAO,OAAO,MAAM,OAAO,IAAI,KAAK;AACpC,aAAO,OAAO,MAAM,UAAU,IAAI,QAAQ;AAAA,IAC3C,CAAC;AAED,mCAAa,iBAAiB,KAAK;AAEnC,UAAM,KAAK;AAAA,EACZ;AAEA,iBAAe,MAAM,QAA0B,UAAmC;AACjF,UAAM,UAAoC,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,EAAE;AAEpE,QAAI,SAAS,WAAW,EAAG,QAAO;AAIlC,UAAM,WAAW;AAAA,UACT,SAAS,IAAI,CAAC,QAAQ;AAC3B,YAAM,UAAU,IAAI,SAAS,YAAY,kBAAkB;AAC3D,YAAM,SAAS,IAAI,SAAS,YAAY,YAAY;AAEpD,aAAO,GAAG,YAAY,IAAI,EAAE,CAAC,KAAK,OAAO,UAAU,IAAI,IAAI;AAAA,sBAC1C,MAAM;AAAA;AAAA,IAExB,CAAC,CAAC;AAAA;AAGJ,UAAM,SAAS,MAAM,OAAO,MAAM;AAAA,MACjC,OAAO;AAAA,MACP,WAAW;AAAA,IACZ,CAAC;AAED,QAAI,OAAO,OAAQ,OAAM,IAAI,MAAM,KAAK,UAAU,EAAE,OAAO,UAAU,QAAQ,OAAO,OAAO,CAAC,CAAC;AAG7F,eAAW,OAAO,UAAU;AAC3B,YAAM,MAAM,YAAY,IAAI,EAAE;AAC9B,UAAI,CAAC,OAAO,QAAQ,CAAC,OAAO,KAAK,GAAG,EAAG,OAAM,IAAI,MAAM,wBAAwB,IAAI,IAAI,EAAE;AACzF,YAAM,OAAO,OAAO,KAAK,GAAG;AAE5B,UAAI,IAAI,SAAS,UAAW,SAAQ,SAAS,IAAI,IAAI,IAAI,KAAK;AAC9D,UAAI,IAAI,SAAS,WAAY,SAAQ,MAAM,IAAI,IAAI,IAAI,KAAK;AAAA,IAC7D;AAEA,WAAO;AAAA,EACR;AACD;AAEA,MAAM,cAAc,CAAC,QAAgB,OAAO,GAAG;",
-  "names": []
+  "sourcesContent": ["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { parseStructTag } from '../../utils/sui-types.js';\nimport type { BuildTransactionOptions } from '../json-rpc-resolver.js';\nimport type { TransactionDataBuilder } from '../TransactionData.js';\nimport type { NamedPackagesPluginCache } from './utils.js';\nimport {\n\tbatch,\n\tfindNamesInTransaction,\n\tgetFirstLevelNamedTypes,\n\tpopulateNamedTypesFromCache,\n\treplaceNames,\n} from './utils.js';\n\nexport type NamedPackagesPluginOptions = {\n\t/**\n\t * The URL of the MVR API to use for resolving names.\n\t */\n\turl: string;\n\t/**\n\t * The number of names to resolve in each batch request.\n\t * Needs to be calculated based on the GraphQL query limits.\n\t */\n\tpageSize?: number;\n\t/**\n\t * Local overrides for the resolution plugin. Pass this to pre-populate\n\t * the cache with known packages / types (especially useful for local or CI testing).\n\t *\n\t * The type cache expects ONLY first-level types to ensure the cache is more composable.\n\t *\n\t * \tExpected format example:\n\t *  {\n\t * \t\tpackages: {\n\t * \t\t\t'@framework/std': '0x1234',\n\t * \t\t},\n\t * \t\ttypes: {\n\t * \t\t\t'@framework/std::string::String': '0x1234::string::String',\n\t * \t\t},\n\t * \t}\n\t *\n\t */\n\toverrides?: NamedPackagesPluginCache;\n};\n\n/**\n * @experimental This plugin is in experimental phase and there might be breaking changes in the future\n *\n * Adds named resolution so that you can use .move names in your transactions.\n * e.g. `@org/app::type::Type` will be resolved to `0x1234::type::Type`.\n * This plugin will resolve all names & types in the transaction block.\n *\n * To install this plugin globally in your app, use:\n * ```\n * Transaction.registerGlobalSerializationPlugin(\"namedPackagesPlugin\", namedPackagesPlugin({ suiGraphQLClient }));\n * ```\n *\n * You can also define `overrides` to pre-populate name resolutions locally (removes the GraphQL request).\n */\nexport const namedPackagesPlugin = ({\n\turl,\n\tpageSize = 50,\n\toverrides = { packages: {}, types: {} },\n}: NamedPackagesPluginOptions) => {\n\t// validate that types are first-level only.\n\tObject.keys(overrides.types).forEach((type) => {\n\t\tif (parseStructTag(type).typeParams.length > 0)\n\t\t\tthrow new Error(\n\t\t\t\t'Type overrides must be first-level only. If you want to supply generic types, just pass each type individually.',\n\t\t\t);\n\t});\n\n\tconst cache = overrides;\n\n\treturn async (\n\t\ttransactionData: TransactionDataBuilder,\n\t\t_buildOptions: BuildTransactionOptions,\n\t\tnext: () => Promise<void>,\n\t) => {\n\t\tconst names = findNamesInTransaction(transactionData);\n\n\t\tconst [packages, types] = await Promise.all([\n\t\t\tresolvePackages(\n\t\t\t\tnames.packages.filter((x) => !cache.packages[x]),\n\t\t\t\turl,\n\t\t\t\tpageSize,\n\t\t\t),\n\t\t\tresolveTypes(\n\t\t\t\t[...getFirstLevelNamedTypes(names.types)].filter((x) => !cache.types[x]),\n\t\t\t\turl,\n\t\t\t\tpageSize,\n\t\t\t),\n\t\t]);\n\n\t\t// save first-level mappings to cache.\n\t\tObject.assign(cache.packages, packages);\n\t\tObject.assign(cache.types, types);\n\n\t\tconst composedTypes = populateNamedTypesFromCache(names.types, cache.types);\n\n\t\t// when replacing names, we also need to replace the \"composed\" types collected above.\n\t\treplaceNames(transactionData, {\n\t\t\tpackages: { ...cache.packages },\n\t\t\t// we include the \"composed\" type cache too.\n\t\t\ttypes: composedTypes,\n\t\t});\n\n\t\tawait next();\n\t};\n\n\tasync function resolvePackages(packages: string[], apiUrl: string, pageSize: number) {\n\t\tif (packages.length === 0) return {};\n\n\t\tconst batches = batch(packages, pageSize);\n\t\tconst results: Record<string, string> = {};\n\n\t\tawait Promise.all(\n\t\t\tbatches.map(async (batch) => {\n\t\t\t\tconst response = await fetch(`${apiUrl}/v1/resolution/bulk`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { 'Content-Type': 'application/json' },\n\t\t\t\t\tbody: JSON.stringify({\n\t\t\t\t\t\tnames: batch,\n\t\t\t\t\t}),\n\t\t\t\t});\n\n\t\t\t\tif (!response.ok) {\n\t\t\t\t\tconst errorBody = await response.json().catch(() => ({}));\n\t\t\t\t\tthrow new Error(`Failed to resolve packages: ${errorBody?.message}`);\n\t\t\t\t}\n\n\t\t\t\tconst data = await response.json();\n\n\t\t\t\tif (!data?.resolution) return;\n\n\t\t\t\tfor (const pkg of Object.keys(data?.resolution)) {\n\t\t\t\t\tconst pkgData = data.resolution[pkg]?.package_id;\n\n\t\t\t\t\tif (!pkgData) continue;\n\n\t\t\t\t\tresults[pkg] = pkgData;\n\t\t\t\t}\n\t\t\t}),\n\t\t);\n\n\t\treturn results;\n\t}\n\n\tasync function resolveTypes(types: string[], apiUrl: string, pageSize: number) {\n\t\tif (types.length === 0) return {};\n\n\t\tconst batches = batch(types, pageSize);\n\t\tconst results: Record<string, string> = {};\n\n\t\tawait Promise.all(\n\t\t\tbatches.map(async (batch) => {\n\t\t\t\tconst response = await fetch(`${apiUrl}/v1/struct-definition/bulk`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { 'Content-Type': 'application/json' },\n\t\t\t\t\tbody: JSON.stringify({\n\t\t\t\t\t\ttypes: batch,\n\t\t\t\t\t}),\n\t\t\t\t});\n\n\t\t\t\tif (!response.ok) {\n\t\t\t\t\tconst errorBody = await response.json().catch(() => ({}));\n\t\t\t\t\tthrow new Error(`Failed to resolve types: ${errorBody?.message}`);\n\t\t\t\t}\n\n\t\t\t\tconst data = await response.json();\n\n\t\t\t\tif (!data?.resolution) return;\n\n\t\t\t\tfor (const type of Object.keys(data?.resolution)) {\n\t\t\t\t\tconst typeData = data.resolution[type]?.type_tag;\n\t\t\t\t\tif (!typeData) continue;\n\n\t\t\t\t\tresults[type] = typeData;\n\t\t\t\t}\n\t\t\t}),\n\t\t);\n\n\t\treturn results;\n\t}\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,uBAA+B;AAI/B,mBAMO;AA8CA,MAAM,sBAAsB,CAAC;AAAA,EACnC;AAAA,EACA,WAAW;AAAA,EACX,YAAY,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,EAAE;AACvC,MAAkC;AAEjC,SAAO,KAAK,UAAU,KAAK,EAAE,QAAQ,CAAC,SAAS;AAC9C,YAAI,iCAAe,IAAI,EAAE,WAAW,SAAS;AAC5C,YAAM,IAAI;AAAA,QACT;AAAA,MACD;AAAA,EACF,CAAC;AAED,QAAM,QAAQ;AAEd,SAAO,OACN,iBACA,eACA,SACI;AACJ,UAAM,YAAQ,qCAAuB,eAAe;AAEpD,UAAM,CAAC,UAAU,KAAK,IAAI,MAAM,QAAQ,IAAI;AAAA,MAC3C;AAAA,QACC,MAAM,SAAS,OAAO,CAAC,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;AAAA,QAC/C;AAAA,QACA;AAAA,MACD;AAAA,MACA;AAAA,QACC,CAAC,OAAG,sCAAwB,MAAM,KAAK,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,MAAM,CAAC,CAAC;AAAA,QACvE;AAAA,QACA;AAAA,MACD;AAAA,IACD,CAAC;AAGD,WAAO,OAAO,MAAM,UAAU,QAAQ;AACtC,WAAO,OAAO,MAAM,OAAO,KAAK;AAEhC,UAAM,oBAAgB,0CAA4B,MAAM,OAAO,MAAM,KAAK;AAG1E,mCAAa,iBAAiB;AAAA,MAC7B,UAAU,EAAE,GAAG,MAAM,SAAS;AAAA;AAAA,MAE9B,OAAO;AAAA,IACR,CAAC;AAED,UAAM,KAAK;AAAA,EACZ;AAEA,iBAAe,gBAAgB,UAAoB,QAAgBA,WAAkB;AACpF,QAAI,SAAS,WAAW,EAAG,QAAO,CAAC;AAEnC,UAAM,cAAU,oBAAM,UAAUA,SAAQ;AACxC,UAAM,UAAkC,CAAC;AAEzC,UAAM,QAAQ;AAAA,MACb,QAAQ,IAAI,OAAOC,WAAU;AAC5B,cAAM,WAAW,MAAM,MAAM,GAAG,MAAM,uBAAuB;AAAA,UAC5D,QAAQ;AAAA,UACR,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,UAC9C,MAAM,KAAK,UAAU;AAAA,YACpB,OAAOA;AAAA,UACR,CAAC;AAAA,QACF,CAAC;AAED,YAAI,CAAC,SAAS,IAAI;AACjB,gBAAM,YAAY,MAAM,SAAS,KAAK,EAAE,MAAM,OAAO,CAAC,EAAE;AACxD,gBAAM,IAAI,MAAM,+BAA+B,WAAW,OAAO,EAAE;AAAA,QACpE;AAEA,cAAM,OAAO,MAAM,SAAS,KAAK;AAEjC,YAAI,CAAC,MAAM,WAAY;AAEvB,mBAAW,OAAO,OAAO,KAAK,MAAM,UAAU,GAAG;AAChD,gBAAM,UAAU,KAAK,WAAW,GAAG,GAAG;AAEtC,cAAI,CAAC,QAAS;AAEd,kBAAQ,GAAG,IAAI;AAAA,QAChB;AAAA,MACD,CAAC;AAAA,IACF;AAEA,WAAO;AAAA,EACR;AAEA,iBAAe,aAAa,OAAiB,QAAgBD,WAAkB;AAC9E,QAAI,MAAM,WAAW,EAAG,QAAO,CAAC;AAEhC,UAAM,cAAU,oBAAM,OAAOA,SAAQ;AACrC,UAAM,UAAkC,CAAC;AAEzC,UAAM,QAAQ;AAAA,MACb,QAAQ,IAAI,OAAOC,WAAU;AAC5B,cAAM,WAAW,MAAM,MAAM,GAAG,MAAM,8BAA8B;AAAA,UACnE,QAAQ;AAAA,UACR,SAAS,EAAE,gBAAgB,mBAAmB;AAAA,UAC9C,MAAM,KAAK,UAAU;AAAA,YACpB,OAAOA;AAAA,UACR,CAAC;AAAA,QACF,CAAC;AAED,YAAI,CAAC,SAAS,IAAI;AACjB,gBAAM,YAAY,MAAM,SAAS,KAAK,EAAE,MAAM,OAAO,CAAC,EAAE;AACxD,gBAAM,IAAI,MAAM,4BAA4B,WAAW,OAAO,EAAE;AAAA,QACjE;AAEA,cAAM,OAAO,MAAM,SAAS,KAAK;AAEjC,YAAI,CAAC,MAAM,WAAY;AAEvB,mBAAW,QAAQ,OAAO,KAAK,MAAM,UAAU,GAAG;AACjD,gBAAM,WAAW,KAAK,WAAW,IAAI,GAAG;AACxC,cAAI,CAAC,SAAU;AAEf,kBAAQ,IAAI,IAAI;AAAA,QACjB;AAAA,MACD,CAAC;AAAA,IACF;AAEA,WAAO;AAAA,EACR;AACD;",
+  "names": ["pageSize", "batch"]
 }

package/dist/cjs/transactions/plugins/utils.d.ts

@@ -12,16 +12,20 @@ export type NameResolutionRequest = {
  * Looks up all `.move` names in a transaction block.
  * Returns a list of all the names found.
  */
-export declare const findTransactionBlockNames: (builder: TransactionDataBuilder) => {
+export declare function findNamesInTransaction(builder: TransactionDataBuilder): {
     packages: string[];
     types: string[];
 };
+/**
+ * Extracts all first-level types from a list of types.
+ * E.g. for the input `['@mvr/demo::a::A<@mvr/demo::b::B>']`,
+ * the output will be `['@mvr/demo::a::A', '@mvr/demo::b::B']`.
+ */
+export declare function getFirstLevelNamedTypes(types: string[]): Set<string>;
+export declare function populateNamedTypesFromCache(types: string[], typeCache: Record<string, string>): Record<string, string>;
 /**
  * Replace all names & types in a transaction block
  * with their resolved names/types.
  */
-export declare const replaceNames: (builder: TransactionDataBuilder, cache: NamedPackagesPluginCache) => void;
-export declare const listToRequests: (names: {
-    packages: string[];
-    types: string[];
-}, batchSize: number) => NameResolutionRequest[][];
+export declare function replaceNames(builder: TransactionDataBuilder, cache: NamedPackagesPluginCache): void;
+export declare function batch<T>(arr: T[], size: number): T[][];

package/dist/cjs/transactions/plugins/utils.js

@@ -18,14 +18,17 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var utils_exports = {};
 __export(utils_exports, {
-  findTransactionBlockNames: () => findTransactionBlockNames,
-  listToRequests: () => listToRequests,
+  batch: () => batch,
+  findNamesInTransaction: () => findNamesInTransaction,
+  getFirstLevelNamedTypes: () => getFirstLevelNamedTypes,
+  populateNamedTypesFromCache: () => populateNamedTypesFromCache,
   replaceNames: () => replaceNames
 });
 module.exports = __toCommonJS(utils_exports);
 var import_move_registry = require("../../utils/move-registry.js");
+var import_sui_types = require("../../utils/sui-types.js");
 const NAME_SEPARATOR = "/";
-const findTransactionBlockNames = (builder) => {
+function findNamesInTransaction(builder) {
   const packages = /* @__PURE__ */ new Set();
   const types = /* @__PURE__ */ new Set();
   for (const command of builder.commands) {
@@ -39,7 +42,7 @@ const findTransactionBlockNames = (builder) => {
     const tx = command.MoveCall;
     if (!tx) continue;
     const pkg = tx.package.split("::")[0];
-    if (pkg.includes(NAME_SEPARATOR)) {
+    if (hasMvrName(pkg)) {
       if (!(0, import_move_registry.isValidNamedPackage)(pkg)) throw new Error(`Invalid package name: ${pkg}`);
       packages.add(pkg);
     }
@@ -51,21 +54,46 @@ const findTransactionBlockNames = (builder) => {
     packages: [...packages],
     types: [...types]
   };
-};
-function getNamesFromTypeList(types) {
-  const names = /* @__PURE__ */ new Set();
+}
+function getFirstLevelNamedTypes(types) {
+  const results = /* @__PURE__ */ new Set();
   for (const type of types) {
-    if (type.includes(NAME_SEPARATOR)) {
-      if (!(0, import_move_registry.isValidNamedType)(type)) throw new Error(`Invalid type with names: ${type}`);
-      names.add(type);
-    }
+    findMvrNames(type).forEach((name) => results.add(name));
+  }
+  return results;
+}
+function findMvrNames(type) {
+  const types = /* @__PURE__ */ new Set();
+  if (typeof type === "string" && !hasMvrName(type)) return types;
+  let tag = isStructTag(type) ? type : (0, import_sui_types.parseStructTag)(type);
+  if (hasMvrName(tag.address)) types.add(`${tag.address}::${tag.module}::${tag.name}`);
+  for (const param of tag.typeParams) {
+    findMvrNames(param).forEach((name) => types.add(name));
   }
-  return [...names];
+  return types;
+}
+function populateNamedTypesFromCache(types, typeCache) {
+  const composedTypes = {};
+  types.forEach((type) => {
+    const normalized = (0, import_sui_types.normalizeStructTag)(findAndReplaceCachedTypes(type, typeCache));
+    composedTypes[type] = normalized;
+  });
+  return composedTypes;
+}
+function findAndReplaceCachedTypes(tag, typeCache) {
+  const type = isStructTag(tag) ? tag : (0, import_sui_types.parseStructTag)(tag);
+  let typeTag = `${type.address}::${type.module}::${type.name}`;
+  const cacheHit = typeCache[typeTag];
+  return {
+    ...type,
+    address: cacheHit ? cacheHit.split("::")[0] : type.address,
+    typeParams: type.typeParams.map((param) => findAndReplaceCachedTypes(param, typeCache))
+  };
 }
-const replaceNames = (builder, cache) => {
+function replaceNames(builder, cache) {
   for (const command of builder.commands) {
     if (command.MakeMoveVec?.type) {
-      if (!command.MakeMoveVec.type.includes(NAME_SEPARATOR)) continue;
+      if (!hasMvrName(command.MakeMoveVec.type)) continue;
       if (!cache.types[command.MakeMoveVec.type])
         throw new Error(`No resolution found for type: ${command.MakeMoveVec.type}`);
       command.MakeMoveVec.type = cache.types[command.MakeMoveVec.type];
@@ -74,44 +102,43 @@ const replaceNames = (builder, cache) => {
     if (!tx) continue;
     const nameParts = tx.package.split("::");
     const name = nameParts[0];
-    if (name.includes(NAME_SEPARATOR) && !cache.packages[name])
+    if (hasMvrName(name) && !cache.packages[name])
       throw new Error(`No address found for package: ${name}`);
-    if (name.includes(NAME_SEPARATOR)) {
+    if (hasMvrName(name)) {
       nameParts[0] = cache.packages[name];
       tx.package = nameParts.join("::");
     }
     const types = tx.typeArguments;
     if (!types) continue;
     for (let i = 0; i < types.length; i++) {
-      if (!types[i].includes(NAME_SEPARATOR)) continue;
+      if (!hasMvrName(types[i])) continue;
       if (!cache.types[types[i]]) throw new Error(`No resolution found for type: ${types[i]}`);
       types[i] = cache.types[types[i]];
     }
     tx.typeArguments = types;
   }
-};
-const listToRequests = (names, batchSize) => {
-  const results = [];
-  const uniqueNames = deduplicate(names.packages);
-  const uniqueTypes = deduplicate(names.types);
-  for (const [idx, name] of uniqueNames.entries()) {
-    results.push({ id: idx, type: "package", name });
-  }
-  for (const [idx, type] of uniqueTypes.entries()) {
-    results.push({
-      id: idx + uniqueNames.length,
-      type: "moveType",
-      name: type
-    });
-  }
-  return batch(results, batchSize);
-};
-const deduplicate = (arr) => [...new Set(arr)];
-const batch = (arr, size) => {
+}
+function batch(arr, size) {
   const batches = [];
   for (let i = 0; i < arr.length; i += size) {
     batches.push(arr.slice(i, i + size));
   }
   return batches;
-};
+}
+function getNamesFromTypeList(types) {
+  const names = /* @__PURE__ */ new Set();
+  for (const type of types) {
+    if (hasMvrName(type)) {
+      if (!(0, import_move_registry.isValidNamedType)(type)) throw new Error(`Invalid type with names: ${type}`);
+      names.add(type);
+    }
+  }
+  return names;
+}
+function hasMvrName(nameOrType) {
+  return nameOrType.includes(NAME_SEPARATOR) || nameOrType.includes("@") || nameOrType.includes(".sui");
+}
+function isStructTag(type) {
+  return typeof type === "object" && "address" in type && "module" in type && "name" in type && "typeParams" in type;
+}
 //# sourceMappingURL=utils.js.map