@mysten/sui 1.9.0 → 1.11.0

package/src/transactions/data/v1.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fromB64, toB64 } from '@mysten/bcs';
+import { fromBase64, toBase64 } from '@mysten/bcs';
 import type { GenericSchema, InferInput, InferOutput } from 'valibot';
 import {
 	array,
@@ -236,7 +236,7 @@ export function serializeV1TransactionData(
 					kind: 'Input',
 					index,
 					value: {
-						Pure: Array.from(fromB64(input.Pure.bytes)),
+						Pure: Array.from(fromBase64(input.Pure.bytes)),
 					},
 					type: 'pure',
 				};
@@ -313,7 +313,7 @@ export function serializeV1TransactionData(
 			if (command.Publish) {
 				return {
 					kind: 'Publish',
-					modules: command.Publish.modules.map((mod) => Array.from(fromB64(mod))),
+					modules: command.Publish.modules.map((mod) => Array.from(fromBase64(mod))),
 					dependencies: command.Publish.dependencies,
 				};
 			}
@@ -337,7 +337,7 @@ export function serializeV1TransactionData(
 			if (command.Upgrade) {
 				return {
 					kind: 'Upgrade',
-					modules: command.Upgrade.modules.map((mod) => Array.from(fromB64(mod))),
+					modules: command.Upgrade.modules.map((mod) => Array.from(fromBase64(mod))),
 					dependencies: command.Upgrade.dependencies,
 					packageId: command.Upgrade.package,
 					ticket: convertTransactionArgument(command.Upgrade.ticket, inputs),
@@ -434,7 +434,7 @@ export function transactionDataFromV1(data: SerializedTransactionDataV1): Transa
 
 					return {
 						Pure: {
-							bytes: toB64(new Uint8Array(value.Pure)),
+							bytes: toBase64(new Uint8Array(value.Pure)),
 						},
 					};
 				}
@@ -491,7 +491,7 @@ export function transactionDataFromV1(data: SerializedTransactionDataV1): Transa
 				case 'Publish': {
 					return {
 						Publish: {
-							modules: transaction.modules.map((mod) => toB64(Uint8Array.from(mod))),
+							modules: transaction.modules.map((mod) => toBase64(Uint8Array.from(mod))),
 							dependencies: transaction.dependencies,
 						},
 					};
@@ -515,7 +515,7 @@ export function transactionDataFromV1(data: SerializedTransactionDataV1): Transa
 				case 'Upgrade': {
 					return {
 						Upgrade: {
-							modules: transaction.modules.map((mod) => toB64(Uint8Array.from(mod))),
+							modules: transaction.modules.map((mod) => toBase64(Uint8Array.from(mod))),
 							dependencies: transaction.dependencies,
 							package: transaction.packageId,
 							ticket: parseV1TransactionArgument(transaction.ticket),

package/src/transactions/executor/parallel.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { toB64 } from '@mysten/bcs';
+import { toBase64 } from '@mysten/bcs';
 
 import { bcs } from '../../bcs/index.js';
 import type { SuiObjectRef } from '../../bcs/types.js';
@@ -266,7 +266,7 @@ export class ParallelTransactionExecutor {
 
 			return {
 				digest: results.digest,
-				effects: toB64(effectsBytes),
+				effects: toBase64(effectsBytes),
 				data: results,
 			};
 		} catch (error) {

package/src/transactions/executor/serial.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { toB64 } from '@mysten/bcs';
+import { toBase64 } from '@mysten/bcs';
 
 import { bcs } from '../../bcs/index.js';
 import type { SuiClient, SuiTransactionBlockResponseOptions } from '../../client/index.js';
@@ -109,7 +109,7 @@ export class SerialTransactionExecutor {
 
 			return {
 				digest: results.digest,
-				effects: toB64(effectsBytes),
+				effects: toBase64(effectsBytes),
 				data: results,
 			};
 		});

package/src/transactions/plugins/NamedPackagesPlugin.ts

@@ -27,10 +27,10 @@ export type NamedPackagesPluginOptions = {
 	 * 	Expected format example:
 	 *  {
 	 * 		packages: {
-	 * 			'std@framework': '0x1234',
+	 * 			'@framework/std': '0x1234',
 	 * 		},
 	 * 		types: {
-	 * 			'std@framework::string::String': '0x1234::string::String',
+	 * 			'@framework/std::string::String': '0x1234::string::String',
 	 * 		},
 	 * 	}
 	 *
@@ -42,7 +42,7 @@ export type NamedPackagesPluginOptions = {
  * @experimental This plugin is in experimental phase and there might be breaking changes in the future
  *
  * Adds named resolution so that you can use .move names in your transactions.
- * e.g. `app@org::type::Type` will be resolved to `0x1234::type::Type`.
+ * e.g. `@org/app::type::Type` will be resolved to `0x1234::type::Type`.
  * This plugin will resolve all names & types in the transaction block.
  *
  * To install this plugin globally in your app, use:

package/src/transactions/plugins/utils.ts

@@ -9,7 +9,7 @@ export type NamedPackagesPluginCache = {
 	types: Record<string, string>;
 };
 
-const NAME_SEPARATOR = '@';
+const NAME_SEPARATOR = '/';
 
 export type NameResolutionRequest = {
 	id: number;
@@ -28,6 +28,12 @@ export const findTransactionBlockNames = (
 	const types: Set<string> = new Set();
 
 	for (const command of builder.commands) {
+		if (command.MakeMoveVec?.type) {
+			getNamesFromTypeList([command.MakeMoveVec.type]).forEach((type) => {
+				types.add(type);
+			});
+			continue;
+		}
 		if (!('MoveCall' in command)) continue;
 		const tx = command.MoveCall;
 
@@ -39,12 +45,9 @@ export const findTransactionBlockNames = (
 			packages.add(pkg);
 		}
 
-		for (const type of tx.typeArguments ?? []) {
-			if (type.includes(NAME_SEPARATOR)) {
-				if (!isValidNamedType(type)) throw new Error(`Invalid type with names: ${type}`);
-				types.add(type);
-			}
-		}
+		getNamesFromTypeList(tx.typeArguments ?? []).forEach((type) => {
+			types.add(type);
+		});
 	}
 
 	return {
@@ -53,12 +56,35 @@ export const findTransactionBlockNames = (
 	};
 };
 
+/**
+ * Returns a list of unique types that include a name
+ * from the given list.
+ *  */
+function getNamesFromTypeList(types: string[]) {
+	const names = new Set<string>();
+	for (const type of types) {
+		if (type.includes(NAME_SEPARATOR)) {
+			if (!isValidNamedType(type)) throw new Error(`Invalid type with names: ${type}`);
+			names.add(type);
+		}
+	}
+	return [...names];
+}
+
 /**
  * Replace all names & types in a transaction block
  * with their resolved names/types.
  */
 export const replaceNames = (builder: TransactionDataBuilder, cache: NamedPackagesPluginCache) => {
 	for (const command of builder.commands) {
+		// Replacements for `MakeMoveVec` commands (that can include types)
+		if (command.MakeMoveVec?.type) {
+			if (!command.MakeMoveVec.type.includes(NAME_SEPARATOR)) 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];
+		}
+		// Replacements for `MoveCall` commands (that can include packages & types)
 		const tx = command.MoveCall;
 		if (!tx) continue;
 

package/src/utils/index.ts

@@ -13,7 +13,18 @@ export {
 	SUI_ADDRESS_LENGTH,
 } from './sui-types.js';
 
-export { fromB64, toB64, fromHEX, toHEX } from '@mysten/bcs';
+export {
+	fromB64,
+	toB64,
+	fromHEX,
+	toHex,
+	toHEX,
+	fromHex,
+	fromBase64,
+	toBase64,
+	fromBase58,
+	toBase58,
+} from '@mysten/bcs';
 export { isValidSuiNSName, normalizeSuiNSName } from './suins.js';
 
 export {

package/src/utils/move-registry.ts

@@ -1,11 +1,31 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { isValidSuiNSName } from './suins.js';
+
 /** The pattern to find an optionally versioned name */
-const NAME_PATTERN = /^([a-z0-9]+(?:-[a-z0-9]+)*)@([a-z0-9]+(?:-[a-z0-9]+)*)(?:\/v(\d+))?$/;
+const NAME_PATTERN = /^([a-z0-9]+(?:-[a-z0-9]+)*)$/;
+/** The pattern for a valid version number */
+const VERSION_REGEX = /^\d+$/;
+/** The maximum size for an app */
+const MAX_APP_SIZE = 64;
+/** The separator for the name */
+const NAME_SEPARATOR = '/';
 
 export const isValidNamedPackage = (name: string): boolean => {
-	return NAME_PATTERN.test(name);
+	const parts = name.split(NAME_SEPARATOR);
+	// The name has to have 2 parts (without-version), or 3 parts (with version).
+	if (parts.length < 2 || parts.length > 3) return false;
+
+	const [org, app, version] = parts; // split by {org} {app} {optional version}
+
+	// If the version exists, it must be a number.
+	if (version !== undefined && !VERSION_REGEX.test(version)) return false;
+	// Check if the org is a valid SuiNS name.
+	if (!isValidSuiNSName(org)) return false;
+
+	// Check if the app is a valid name.
+	return NAME_PATTERN.test(app) && app.length < MAX_APP_SIZE;
 };
 
 /**
@@ -16,9 +36,8 @@ export const isValidNamedType = (type: string): boolean => {
 	// split our type by all possible type delimeters.
 	const splitType = type.split(/::|<|>|,/);
 	for (const t of splitType) {
-		if (t.includes('@') && !isValidNamedPackage(t)) return false;
+		if (t.includes(NAME_SEPARATOR) && !isValidNamedPackage(t)) return false;
 	}
-	// TODO: Add `isValidStructTag` check once
-	// it's generally introduced.
+	// TODO: Add `isValidStructTag` check once it's introduced.
 	return true;
 };

package/src/utils/sui-types.ts

@@ -1,14 +1,14 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fromB58, splitGenericParameters } from '@mysten/bcs';
+import { fromBase58, splitGenericParameters } from '@mysten/bcs';
 
 const TX_DIGEST_LENGTH = 32;
 
 /** Returns whether the tx digest is valid based on the serialization format */
 export function isValidTransactionDigest(value: string): value is string {
 	try {
-		const buffer = fromB58(value);
+		const buffer = fromBase58(value);
 		return buffer.length === TX_DIGEST_LENGTH;
 	} catch (e) {
 		return false;

package/src/verify/verify.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fromB64 } from '@mysten/bcs';
+import { fromBase64 } from '@mysten/bcs';
 
 import type { PublicKey, SignatureFlag, SignatureScheme } from '../cryptography/index.js';
 import { parseSerializedSignature, SIGNATURE_FLAG_TO_SCHEME } from '../cryptography/index.js';
@@ -107,7 +107,7 @@ export function publicKeyFromSuiBytes(
 	publicKey: string | Uint8Array,
 	options: { client?: SuiGraphQLClient } = {},
 ) {
-	const bytes = typeof publicKey === 'string' ? fromB64(publicKey) : publicKey;
+	const bytes = typeof publicKey === 'string' ? fromBase64(publicKey) : publicKey;
 
 	const signatureScheme = SIGNATURE_FLAG_TO_SCHEME[bytes[0] as SignatureFlag];
 

package/src/version.ts

@@ -3,5 +3,5 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '1.9.0';
-export const TARGETED_RPC_VERSION = '1.34.0';
+export const PACKAGE_VERSION = '1.11.0';
+export const TARGETED_RPC_VERSION = '1.35.0';

package/src/zklogin/publickey.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fromB64, toB64 } from '@mysten/bcs';
+import { fromBase64, toBase64 } from '@mysten/bcs';
 
 import { PublicKey } from '../cryptography/publickey.js';
 import type { PublicKeyInitData } from '../cryptography/publickey.js';
@@ -29,7 +29,7 @@ export class ZkLoginPublicIdentifier extends PublicKey {
 		this.#client = client;
 
 		if (typeof value === 'string') {
-			this.#data = fromB64(value);
+			this.#data = fromBase64(value);
 		} else if (value instanceof Uint8Array) {
 			this.#data = value;
 		} else {
@@ -74,7 +74,7 @@ export class ZkLoginPublicIdentifier extends PublicKey {
 
 		return graphqlVerifyZkLoginSignature({
 			address: address,
-			bytes: toB64(message),
+			bytes: toBase64(message),
 			signature: parsedSignature.serializedSignature,
 			intentScope: 'PERSONAL_MESSAGE',
 			client: this.#client,
@@ -89,7 +89,7 @@ export class ZkLoginPublicIdentifier extends PublicKey {
 		const address = new ZkLoginPublicIdentifier(parsedSignature.publicKey).toSuiAddress();
 		return graphqlVerifyZkLoginSignature({
 			address: address,
-			bytes: toB64(transaction),
+			bytes: toBase64(transaction),
 			signature: parsedSignature.serializedSignature,
 			intentScope: 'TRANSACTION_DATA',
 			client: this.#client,
@@ -164,7 +164,7 @@ async function graphqlVerifyZkLoginSignature({
 }
 
 export function parseSerializedZkLoginSignature(signature: Uint8Array | string) {
-	const bytes = typeof signature === 'string' ? fromB64(signature) : signature;
+	const bytes = typeof signature === 'string' ? fromBase64(signature) : signature;
 
 	if (bytes[0] !== SIGNATURE_SCHEME_TO_FLAG.ZkLogin) {
 		throw new Error('Invalid signature scheme');
@@ -176,7 +176,7 @@ export function parseSerializedZkLoginSignature(signature: Uint8Array | string)
 	const iss = extractClaimValue<string>(issBase64Details, 'iss');
 	const publicIdentifer = toZkLoginPublicIdentifier(BigInt(addressSeed), iss);
 	return {
-		serializedSignature: toB64(bytes),
+		serializedSignature: toBase64(bytes),
 		signatureScheme: 'ZkLogin' as const,
 		zkLogin: {
 			inputs,

package/src/zklogin/signature.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fromB64, toB64 } from '@mysten/bcs';
+import { fromBase64, toBase64 } from '@mysten/bcs';
 
 import { SIGNATURE_SCHEME_TO_FLAG } from '../cryptography/signature-scheme.js';
 import type { ZkLoginSignature } from './bcs.js';
@@ -17,7 +17,8 @@ function getZkLoginSignatureBytes({ inputs, maxEpoch, userSignature }: ZkLoginSi
 			{
 				inputs,
 				maxEpoch,
-				userSignature: typeof userSignature === 'string' ? fromB64(userSignature) : userSignature,
+				userSignature:
+					typeof userSignature === 'string' ? fromBase64(userSignature) : userSignature,
 			},
 			{ maxSize: 2048 },
 		)
@@ -29,9 +30,9 @@ export function getZkLoginSignature({ inputs, maxEpoch, userSignature }: ZkLogin
 	const signatureBytes = new Uint8Array(bytes.length + 1);
 	signatureBytes.set([SIGNATURE_SCHEME_TO_FLAG.ZkLogin]);
 	signatureBytes.set(bytes, 1);
-	return toB64(signatureBytes);
+	return toBase64(signatureBytes);
 }
 
 export function parseZkLoginSignature(signature: string | Uint8Array) {
-	return zkLoginSignature.parse(typeof signature === 'string' ? fromB64(signature) : signature);
+	return zkLoginSignature.parse(typeof signature === 'string' ? fromBase64(signature) : signature);
 }