@mysten/sui 1.23.0 → 1.25.0

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API(Work in Progress)",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "1.23.0",
+  "version": "1.25.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [

package/src/client/types/generated.ts

@@ -99,11 +99,18 @@ export type CompressedSignature =
 	  }
 	| {
 			ZkLogin: string;
+	  }
+	| {
+			Passkey: string;
 	  };
 /** Uses an enum to allow for future expansion of the ConsensusDeterminedVersionAssignments. */
-export type ConsensusDeterminedVersionAssignments = {
-	CancelledTransactions: [string, [string, string][]][];
-};
+export type ConsensusDeterminedVersionAssignments =
+	| {
+			CancelledTransactions: [string, [string, string][]][];
+	  }
+	| {
+			CancelledTransactionsV2: [string, [[string, string], string][]][];
+	  };
 export type SuiParsedData =
 	| {
 			dataType: 'moveObject';
@@ -166,6 +173,7 @@ export interface DryRunTransactionBlockResponse {
 	balanceChanges: BalanceChange[];
 	effects: TransactionEffects;
 	events: SuiEvent[];
+	executionErrorSource?: string | null;
 	input: TransactionBlockData;
 	objectChanges: SuiObjectChange[];
 }
@@ -437,8 +445,8 @@ export interface MultiSig {
 	sigs: CompressedSignature[];
 }
 /**
- * Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys necessary
- * for authenticating a MultiSigLegacy.
+ * Deprecated, use [struct MultiSig] instead. The struct that contains signatures and public keys
+ * necessary for authenticating a MultiSigLegacy.
  */
 export interface MultiSigLegacy {
 	/** A bitmap that indicates the position of which public key the signature should be authenticated with. */
@@ -956,6 +964,7 @@ export type SuiEndOfEpochTransactionKind =
 	| 'AuthenticatorStateCreate'
 	| 'RandomnessStateCreate'
 	| 'CoinDenyListStateCreate'
+	| 'StoreExecutionTimeObservations'
 	| {
 			ChangeEpoch: SuiChangeEpoch;
 	  }
@@ -1466,6 +1475,16 @@ export type SuiTransactionBlockKind =
 			kind: 'ConsensusCommitPrologueV3';
 			round: string;
 			sub_dag_index?: string | null;
+	  }
+	| {
+			additional_state_digest: string;
+			commit_timestamp_ms: string;
+			consensus_commit_digest: string;
+			consensus_determined_version_assignments: ConsensusDeterminedVersionAssignments;
+			epoch: string;
+			kind: 'ConsensusCommitPrologueV4';
+			round: string;
+			sub_dag_index?: string | null;
 	  };
 export interface SuiTransactionBlockResponse {
 	balanceChanges?: BalanceChange[] | null;
@@ -1594,9 +1613,16 @@ export interface ZkLoginInputs {
 	issBase64Details: Claim;
 	proofPoints: ZkLoginProof;
 }
+export type ZkLoginIntentScope = 'TransactionData' | 'PersonalMessage';
 /** The struct for zk login proof. */
 export interface ZkLoginProof {
 	a: string[];
 	b: string[][];
 	c: string[];
 }
+export interface ZkLoginVerifyResult {
+	/** The errors field captures any verification error */
+	errors: string[];
+	/** The boolean result of the verification. If true, errors should be empty. */
+	success: boolean;
+}

package/src/client/types/params.ts

@@ -180,6 +180,20 @@ export interface TryMultiGetPastObjectsParams {
 	/** options for specifying the content to be returned */
 	options?: RpcTypes.SuiObjectDataOptions | null | undefined;
 }
+/** Verify a zklogin signature for the given bytes, intent scope and author. */
+export interface VerifyZkLoginSignatureParams {
+	/**
+	 * The Base64 string of bcs bytes for raw transaction data or personal message indicated by
+	 * intent_scope.
+	 */
+	bytes: string;
+	/** The Base64 string of the zklogin signature to verify. */
+	signature: string;
+	/** The intent scope, either transaction data or personal message. Used to parse bytes. */
+	intentScope: RpcTypes.ZkLoginIntentScope;
+	/** The author of the signature. */
+	author: string;
+}
 /** Return the total coin balance for all coin type, owned by the address owner. */
 export interface GetAllBalancesParams {
 	/** the owner's Sui address */

package/src/graphql/generated/latest/schema.graphql

@@ -1046,7 +1046,7 @@ type EndOfEpochTransaction {
 	transactions(first: Int, before: String, last: Int, after: String): EndOfEpochTransactionKindConnection!
 }
 
-union EndOfEpochTransactionKind = ChangeEpochTransaction | AuthenticatorStateCreateTransaction | AuthenticatorStateExpireTransaction | RandomnessStateCreateTransaction | CoinDenyListStateCreateTransaction | BridgeStateCreateTransaction | BridgeCommitteeInitTransaction
+union EndOfEpochTransactionKind = ChangeEpochTransaction | AuthenticatorStateCreateTransaction | AuthenticatorStateExpireTransaction | RandomnessStateCreateTransaction | CoinDenyListStateCreateTransaction | BridgeStateCreateTransaction | BridgeCommitteeInitTransaction | StoreExecutionTimeObservationsTransaction
 
 type EndOfEpochTransactionKindConnection {
 	"""
@@ -2879,7 +2879,7 @@ objects are ones whose
 
 - Type matches the `type` filter,
 - AND, whose owner matches the `owner` filter,
-- AND, whose ID is in `objectIds` OR whose ID and version is in `objectKeys`.
+- AND, whose ID is in `objectIds`.
 """
 input ObjectFilter {
 	"""
@@ -2898,10 +2898,6 @@ input ObjectFilter {
 	Filter for live objects by their IDs.
 	"""
 	objectIds: [SuiAddress!]
-	"""
-	Filter for live or potentially historical objects by their ID and version.
-	"""
-	objectKeys: [ObjectKey!]
 }
 
 input ObjectKey {
@@ -3325,6 +3321,10 @@ type Query {
 	"""
 	transactionBlock(digest: String!): TransactionBlock
 	"""
+	Fetch a list of objects by their IDs and versions.
+	"""
+	multiGetObjects(keys: [ObjectKey!]!): [Object]!
+	"""
 	The coin objects that exist in the network.
 	
 	The type field is a string of the inner type of the coin by which to filter (e.g.
@@ -3599,6 +3599,10 @@ type ServiceConfig {
 	"""
 	maxTransactionIds: Int!
 	"""
+	Maximum number of keys that can be passed to a `multiGetObjects` query.
+	"""
+	maxMultiGetObjectsKeys: Int!
+	"""
 	Maximum number of candidates to scan when gathering a page of results.
 	"""
 	maxScanLimit: Int!
@@ -3970,6 +3974,13 @@ type StorageFund {
 	nonRefundableBalance: BigInt
 }
 
+type StoreExecutionTimeObservationsTransaction {
+	"""
+	A workaround to define an empty variant of a GraphQL union.
+	"""
+	_: Boolean
+}
+
 
 """
 String containing 32B hex-encoded address, with a leading "0x". Leading zeroes can be omitted on input but will always appear in outputs (SuiAddress in output is guaranteed to be 66 characters long).

package/src/graphql/generated/latest/tada-env.ts

@@ -3319,6 +3319,10 @@ const introspection = {
           {
             "kind": "OBJECT",
             "name": "RandomnessStateCreateTransaction"
+          },
+          {
+            "kind": "OBJECT",
+            "name": "StoreExecutionTimeObservationsTransaction"
           }
         ]
       },
@@ -8788,19 +8792,6 @@ const introspection = {
                 }
               }
             }
-          },
-          {
-            "name": "objectKeys",
-            "type": {
-              "kind": "LIST",
-              "ofType": {
-                "kind": "NON_NULL",
-                "ofType": {
-                  "kind": "INPUT_OBJECT",
-                  "name": "ObjectKey"
-                }
-              }
-            }
           }
         ],
         "isOneOf": false
@@ -10199,6 +10190,38 @@ const introspection = {
             ],
             "isDeprecated": false
           },
+          {
+            "name": "multiGetObjects",
+            "type": {
+              "kind": "NON_NULL",
+              "ofType": {
+                "kind": "LIST",
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "Object"
+                }
+              }
+            },
+            "args": [
+              {
+                "name": "keys",
+                "type": {
+                  "kind": "NON_NULL",
+                  "ofType": {
+                    "kind": "LIST",
+                    "ofType": {
+                      "kind": "NON_NULL",
+                      "ofType": {
+                        "kind": "INPUT_OBJECT",
+                        "name": "ObjectKey"
+                      }
+                    }
+                  }
+                }
+              }
+            ],
+            "isDeprecated": false
+          },
           {
             "name": "object",
             "type": {
@@ -10937,6 +10960,18 @@ const introspection = {
             "args": [],
             "isDeprecated": false
           },
+          {
+            "name": "maxMultiGetObjectsKeys",
+            "type": {
+              "kind": "NON_NULL",
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Int"
+              }
+            },
+            "args": [],
+            "isDeprecated": false
+          },
           {
             "name": "maxOutputNodes",
             "type": {
@@ -12085,6 +12120,22 @@ const introspection = {
         ],
         "interfaces": []
       },
+      {
+        "kind": "OBJECT",
+        "name": "StoreExecutionTimeObservationsTransaction",
+        "fields": [
+          {
+            "name": "_",
+            "type": {
+              "kind": "SCALAR",
+              "name": "Boolean"
+            },
+            "args": [],
+            "isDeprecated": false
+          }
+        ],
+        "interfaces": []
+      },
       {
         "kind": "SCALAR",
         "name": "String"

package/src/transactions/plugins/NamedPackagesPlugin.ts

@@ -1,20 +1,23 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { SuiGraphQLClient } from '../../graphql/client.js';
+import { parseStructTag } from '../../utils/sui-types.js';
 import type { BuildTransactionOptions } from '../json-rpc-resolver.js';
 import type { TransactionDataBuilder } from '../TransactionData.js';
-import type { NamedPackagesPluginCache, NameResolutionRequest } from './utils.js';
-import { findTransactionBlockNames, listToRequests, replaceNames } from './utils.js';
+import type { NamedPackagesPluginCache } from './utils.js';
+import {
+	batch,
+	findNamesInTransaction,
+	getFirstLevelNamedTypes,
+	populateNamedTypesFromCache,
+	replaceNames,
+} 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.
@@ -24,6 +27,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: {
@@ -53,77 +58,128 @@ export type NamedPackagesPluginOptions = {
  * You can also define `overrides` to pre-populate name resolutions locally (removes the GraphQL request).
  */
 export const namedPackagesPlugin = ({
-	suiGraphQLClient,
-	pageSize = 10,
+	url,
+	pageSize = 50,
 	overrides = { packages: {}, types: {} },
 }: NamedPackagesPluginOptions) => {
-	const cache = {
-		packages: { ...overrides.packages },
-		types: { ...overrides.types },
-	};
+	// validate that types are first-level only.
+	Object.keys(overrides.types).forEach((type) => {
+		if (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: TransactionDataBuilder,
 		_buildOptions: BuildTransactionOptions,
 		next: () => Promise<void>,
 	) => {
-		const names = findTransactionBlockNames(transactionData);
-		const batches = listToRequests(
-			{
-				packages: names.packages.filter((x) => !cache.packages[x]),
-				types: names.types.filter((x) => !cache.types[x]),
-			},
-			pageSize,
-		);
-
-		// now we need to bulk resolve all the names + types, and replace them in the transaction data.
-		(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 = findNamesInTransaction(transactionData);
+
+		const [packages, types] = await Promise.all([
+			resolvePackages(
+				names.packages.filter((x) => !cache.packages[x]),
+				url,
+				pageSize,
+			),
+			resolveTypes(
+				[...getFirstLevelNamedTypes(names.types)].filter((x) => !cache.types[x]),
+				url,
+				pageSize,
+			),
+		]);
+
+		// save first-level mappings to cache.
+		Object.assign(cache.packages, packages);
+		Object.assign(cache.types, types);
+
+		const composedTypes = populateNamedTypesFromCache(names.types, cache.types);
+
+		// when replacing names, we also need to replace the "composed" types collected above.
+		replaceNames(transactionData, {
+			packages: { ...cache.packages },
+			// we include the "composed" type cache too.
+			types: composedTypes,
 		});
 
-		replaceNames(transactionData, cache);
-
 		await next();
 	};
 
-	async function query(client: SuiGraphQLClient, requests: NameResolutionRequest[]) {
-		const results: NamedPackagesPluginCache = { packages: {}, types: {} };
-		// avoid making a request if there are no names to resolve.
-		if (requests.length === 0) return results;
-
-		// Create multiple queries for each name / type we need to resolve
-		// TODO: Replace with bulk APIs when available.
-		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: undefined,
-		});
+	async function resolvePackages(packages: string[], apiUrl: string, pageSize: number) {
+		if (packages.length === 0) return {};
+
+		const batches = batch(packages, pageSize);
+		const results: Record<string, string> = {};
+
+		await Promise.all(
+			batches.map(async (batch) => {
+				const response = await fetch(`${apiUrl}/v1/resolution/bulk`, {
+					method: 'POST',
+					headers: { 'Content-Type': 'application/json' },
+					body: JSON.stringify({
+						names: batch,
+					}),
+				});
+
+				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 (result.errors) throw new Error(JSON.stringify({ query: gqlQuery, errors: result.errors }));
+					if (!pkgData) continue;
 
-		// Parse the results and create a map of `<name|type> -> <address|repr>`
-		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] as { address?: string; repr?: string };
+					results[pkg] = pkgData;
+				}
+			}),
+		);
+
+		return results;
+	}
+
+	async function resolveTypes(types: string[], apiUrl: string, pageSize: number) {
+		if (types.length === 0) return {};
+
+		const batches = batch(types, pageSize);
+		const results: Record<string, string> = {};
+
+		await Promise.all(
+			batches.map(async (batch) => {
+				const response = await fetch(`${apiUrl}/v1/struct-definition/bulk`, {
+					method: 'POST',
+					headers: { 'Content-Type': 'application/json' },
+					body: JSON.stringify({
+						types: batch,
+					}),
+				});
 
-			if (req.type === 'package') results.packages[req.name] = data.address!;
-			if (req.type === 'moveType') results.types[req.name] = data.repr!;
-		}
+				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: number) => `key_${idx}`;