@mysten/sui 1.2.0 → 1.3.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.2.0",
+  "version": "1.3.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -98,41 +98,41 @@
     "access": "public"
   },
   "devDependencies": {
-    "@0no-co/graphqlsp": "^1.7.1",
-    "@graphql-codegen/add": "^5.0.2",
+    "@0no-co/graphqlsp": "^1.12.11",
+    "@graphql-codegen/add": "^5.0.3",
     "@graphql-codegen/cli": "^5.0.2",
-    "@graphql-codegen/typed-document-node": "^5.0.4",
-    "@graphql-codegen/typescript": "4.0.4",
-    "@graphql-codegen/typescript-operations": "^4.1.2",
+    "@graphql-codegen/typed-document-node": "^5.0.9",
+    "@graphql-codegen/typescript": "4.0.9",
+    "@graphql-codegen/typescript-operations": "^4.2.3",
     "@iarna/toml": "^2.2.5",
-    "@types/node": "^20.4.2",
-    "@types/tmp": "^0.2.3",
-    "@types/ws": "^8.5.9",
+    "@types/node": "^20.14.10",
+    "@types/tmp": "^0.2.6",
+    "@types/ws": "^8.5.10",
     "cross-env": "^7.0.3",
     "graphql-config": "^5.0.3",
-    "msw": "^1.2.2",
-    "tmp": "^0.2.1",
-    "ts-retry-promise": "^0.7.0",
-    "typescript": "^5.3.3",
-    "vite": "^4.4.4",
-    "vitest": "^1.6.0",
-    "wait-on": "^7.0.1",
-    "ws": "^8.14.2",
+    "msw": "^2.3.1",
+    "tmp": "^0.2.3",
+    "ts-retry-promise": "^0.8.1",
+    "typescript": "^5.5.3",
+    "vite": "^5.3.3",
+    "vitest": "^2.0.1",
+    "wait-on": "^7.2.0",
+    "ws": "^8.18.0",
     "@mysten/build-scripts": "^0.0.0"
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@noble/curves": "^1.1.0",
-    "@noble/hashes": "^1.3.1",
-    "@scure/bip32": "^1.3.1",
-    "@scure/bip39": "^1.2.1",
+    "@noble/curves": "^1.4.2",
+    "@noble/hashes": "^1.4.0",
+    "@scure/bip32": "^1.4.0",
+    "@scure/bip39": "^1.3.0",
     "@suchipi/femver": "^1.0.0",
     "bech32": "^2.0.0",
-    "gql.tada": "^1.7.0",
-    "graphql": "^16.8.1",
+    "gql.tada": "^1.8.2",
+    "graphql": "^16.9.0",
     "tweetnacl": "^1.0.3",
-    "valibot": "^0.25.0",
-    "@mysten/bcs": "1.0.2"
+    "valibot": "^0.36.0",
+    "@mysten/bcs": "1.0.3"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
@@ -145,7 +145,7 @@
     "test:unit": "vitest run unit __tests__",
     "test:e2e": "wait-on http://127.0.0.1:9123 -l --timeout 180000 && vitest run e2e",
     "test:e2e:nowait": "vitest run e2e",
-    "prepare:e2e": "docker-compose down && docker-compose up -d && cargo build --bin sui-test-validator --bin sui --profile dev && cross-env RUST_LOG=warn,sui=error,anemo_tower=warn,consensus=off cargo run --bin sui-test-validator -- --with-indexer --pg-port 5435 --pg-db-name sui_indexer_v2 --graphql-host 127.0.0.1 --graphql-port 9125",
+    "prepare:e2e": "docker-compose down && docker-compose up -d && cargo build --bin sui --features indexer --profile dev && cross-env RUST_LOG=warn,sui=error,anemo_tower=warn,consensus=off ../../target/debug/sui start --with-faucet --force-regenesis --with-indexer --pg-port 5435 --pg-db-name sui_indexer_v2 --with-graphql",
     "size": "size-limit",
     "analyze": "size-limit --why",
     "prettier:check": "prettier -c --ignore-unknown .",

package/src/bcs/bcs.ts

@@ -164,10 +164,10 @@ export const Command = bcs.enum('Command', {
 				val === null
 					? {
 							None: true,
-					  }
+						}
 					: {
 							Some: val,
-					  },
+						},
 			output: (val) => val.Some ?? null,
 		}),
 		elements: bcs.vector(Argument),

package/src/client/client.ts

@@ -118,13 +118,11 @@ type NetworkOrTransport =
 			url?: never;
 	  };
 
-const SUI_CLIENT_BRAND = Symbol.for('@mysten/SuiClient');
+const SUI_CLIENT_BRAND = Symbol.for('@mysten/SuiClient') as never;
 
 export function isSuiClient(client: unknown): client is SuiClient {
 	return (
-		typeof client === 'object' &&
-		client !== null &&
-		(client as { [SUI_CLIENT_BRAND]: unknown })[SUI_CLIENT_BRAND] === true
+		typeof client === 'object' && client !== null && (client as any)[SUI_CLIENT_BRAND] === true
 	);
 }
 
@@ -525,6 +523,8 @@ export class SuiClient {
 
 	/**
 	 * Subscribe to get notifications whenever an event matching the filter occurs
+	 *
+	 * @deprecated
 	 */
 	async subscribeEvent(
 		input: SubscribeEventParams & {
@@ -540,6 +540,9 @@ export class SuiClient {
 		});
 	}
 
+	/**
+	 * @deprecated
+	 */
 	async subscribeTransaction(
 		input: SubscribeTransactionParams & {
 			/** function to run when we receive a notification of a new event matching the filter */

package/src/graphql/client.ts

@@ -26,7 +26,7 @@ export type GraphQLQueryOptions<
 	? { variables?: Variables }
 	: {
 			variables: Variables;
-	  });
+		});
 
 export type GraphQLQueryResult<Result = Record<string, unknown>> = {
 	data?: Result;

package/src/transactions/Arguments.ts

@@ -0,0 +1,23 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Inputs } from './Inputs.js';
+import { createPure } from './pure.js';
+import type { Transaction, TransactionObjectInput } from './Transaction.js';
+
+export const Arguments = {
+	pure: createPure((value) => (tx: Transaction) => tx.pure(value)),
+	object: (value: TransactionObjectInput) => (tx: Transaction) => tx.object(value),
+	sharedObjectRef:
+		(...args: Parameters<(typeof Inputs)['SharedObjectRef']>) =>
+		(tx: Transaction) =>
+			tx.sharedObjectRef(...args),
+	objectRef:
+		(...args: Parameters<(typeof Inputs)['ObjectRef']>) =>
+		(tx: Transaction) =>
+			tx.objectRef(...args),
+	receivingRef:
+		(...args: Parameters<(typeof Inputs)['ReceivingRef']>) =>
+		(tx: Transaction) =>
+			tx.receivingRef(...args),
+};

package/src/transactions/Commands.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { toB64 } from '@mysten/bcs';
-import type { Input } from 'valibot';
+import type { InferInput } from 'valibot';
 import { parse } from 'valibot';
 
 import { normalizeSuiObjectId } from '../utils/sui-types.js';
@@ -11,8 +11,8 @@ import type { CallArg, Command } from './data/internal.js';
 import type { Transaction } from './Transaction.js';
 
 export type TransactionArgument =
-	| Input<typeof Argument>
-	| ((tx: Transaction) => Input<typeof Argument>);
+	| InferInput<typeof Argument>
+	| ((tx: Transaction) => InferInput<typeof Argument>);
 export type TransactionInput = CallArg;
 
 // Keep in sync with constants in
@@ -62,8 +62,8 @@ export const Commands = {
 	},
 
 	TransferObjects(
-		objects: Input<typeof Argument>[],
-		address: Input<typeof Argument>,
+		objects: InferInput<typeof Argument>[],
+		address: InferInput<typeof Argument>,
 	): TransactionShape<'TransferObjects'> {
 		return {
 			$kind: 'TransferObjects',
@@ -74,8 +74,8 @@ export const Commands = {
 		};
 	},
 	SplitCoins(
-		coin: Input<typeof Argument>,
-		amounts: Input<typeof Argument>[],
+		coin: InferInput<typeof Argument>,
+		amounts: InferInput<typeof Argument>[],
 	): TransactionShape<'SplitCoins'> {
 		return {
 			$kind: 'SplitCoins',
@@ -86,8 +86,8 @@ export const Commands = {
 		};
 	},
 	MergeCoins(
-		destination: Input<typeof Argument>,
-		sources: Input<typeof Argument>[],
+		destination: InferInput<typeof Argument>,
+		sources: InferInput<typeof Argument>[],
 	): TransactionShape<'MergeCoins'> {
 		return {
 			$kind: 'MergeCoins',
@@ -123,7 +123,7 @@ export const Commands = {
 		modules: number[][] | string[];
 		dependencies: string[];
 		package: string;
-		ticket: Input<typeof Argument>;
+		ticket: InferInput<typeof Argument>;
 	}): TransactionShape<'Upgrade'> {
 		return {
 			$kind: 'Upgrade',
@@ -142,7 +142,7 @@ export const Commands = {
 		elements,
 	}: {
 		type?: string;
-		elements: Input<typeof Argument>[];
+		elements: InferInput<typeof Argument>[];
 	}): TransactionShape<'MakeMoveVec'> {
 		return {
 			$kind: 'MakeMoveVec',
@@ -158,7 +158,7 @@ export const Commands = {
 		data = {},
 	}: {
 		name: string;
-		inputs?: Record<string, Input<typeof Argument> | Input<typeof Argument>[]>;
+		inputs?: Record<string, InferInput<typeof Argument> | InferInput<typeof Argument>[]>;
 		data?: Record<string, unknown>;
 	}): TransactionShape<'$Intent'> {
 		return {

package/src/transactions/Transaction.ts

@@ -3,7 +3,7 @@
 
 import type { SerializedBcs } from '@mysten/bcs';
 import { fromB64, isSerializedBcs } from '@mysten/bcs';
-import type { Input } from 'valibot';
+import type { InferInput } from 'valibot';
 import { is, parse } from 'valibot';
 
 import type { SuiClient } from '../client/index.js';
@@ -27,8 +27,8 @@ import { TransactionDataBuilder } from './TransactionData.js';
 import { getIdFromCallArg } from './utils.js';
 
 export type TransactionObjectArgument =
-	| Exclude<Input<typeof Argument>, { Input: unknown; type?: 'pure' }>
-	| ((tx: Transaction) => Exclude<Input<typeof Argument>, { Input: unknown; type?: 'pure' }>);
+	| Exclude<InferInput<typeof Argument>, { Input: unknown; type?: 'pure' }>
+	| ((tx: Transaction) => Exclude<InferInput<typeof Argument>, { Input: unknown; type?: 'pure' }>);
 
 export type TransactionResult = Extract<Argument, { Result: unknown }> &
 	Extract<Argument, { NestedResult: unknown }>[];
@@ -86,7 +86,7 @@ function createTransactionResult(index: number) {
 	}) as TransactionResult;
 }
 
-const TRANSACTION_BRAND = Symbol.for('@mysten/transaction');
+const TRANSACTION_BRAND = Symbol.for('@mysten/transaction') as never;
 
 interface SignOptions extends BuildTransactionOptions {
 	signer: Signer;
@@ -170,7 +170,7 @@ export class Transaction {
 			this.#data.sender = sender;
 		}
 	}
-	setExpiration(expiration?: Input<typeof TransactionExpiration> | null) {
+	setExpiration(expiration?: InferInput<typeof TransactionExpiration> | null) {
 		this.#data.expiration = expiration ? parse(TransactionExpiration, expiration) : null;
 	}
 	setGasPrice(price: number | bigint) {
@@ -205,10 +205,10 @@ export class Transaction {
 	}
 
 	// Temporary workaround for the wallet interface accidentally serializing transactions via postMessage
-	get pure(): ReturnType<typeof createPure> {
+	get pure(): ReturnType<typeof createPure<Argument>> {
 		Object.defineProperty(this, 'pure', {
 			enumerable: false,
-			value: createPure((value): Argument => {
+			value: createPure<Argument>((value): Argument => {
 				if (isSerializedBcs(value)) {
 					return this.#data.addInput('pure', {
 						$kind: 'Pure',
@@ -224,8 +224,8 @@ export class Transaction {
 					is(NormalizedCallArg, value)
 						? parse(NormalizedCallArg, value)
 						: value instanceof Uint8Array
-						? Inputs.Pure(value)
-						: { $kind: 'UnresolvedPure', UnresolvedPure: { value } },
+							? Inputs.Pure(value)
+							: { $kind: 'UnresolvedPure', UnresolvedPure: { value } },
 				);
 			}),
 		});
@@ -272,9 +272,9 @@ export class Transaction {
 						? {
 								$kind: 'UnresolvedObject',
 								UnresolvedObject: { objectId: normalizeSuiAddress(value) },
-						  }
+							}
 						: value,
-			  );
+				);
 	}
 
 	/**
@@ -302,13 +302,14 @@ export class Transaction {
 	}
 
 	/** Add a transaction to the transaction */
-	add(command: Command | ((tx: Transaction) => TransactionResult)): TransactionResult {
+	add<T = TransactionResult>(command: Command | ((tx: Transaction) => T)): T {
 		if (typeof command === 'function') {
 			return command(this);
 		}
 
 		const index = this.#data.commands.push(command);
-		return createTransactionResult(index - 1);
+
+		return createTransactionResult(index - 1) as T;
 	}
 
 	#normalizeTransactionArgument(arg: TransactionArgument | SerializedBcs<any>) {

package/src/transactions/TransactionData.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { toB58 } from '@mysten/bcs';
-import type { Input } from 'valibot';
+import type { InferInput } from 'valibot';
 import { parse } from 'valibot';
 
 import { bcs } from '../bcs/index.js';
@@ -68,7 +68,9 @@ export class TransactionDataBuilder implements TransactionData {
 	}
 
 	static restore(
-		data: Input<typeof SerializedTransactionDataV2> | Input<typeof SerializedTransactionDataV1>,
+		data:
+			| InferInput<typeof SerializedTransactionDataV2>
+			| InferInput<typeof SerializedTransactionDataV1>,
 	) {
 		if (data.version === 2) {
 			return new TransactionDataBuilder(parse(TransactionData, data));

package/src/transactions/data/internal.ts

@@ -2,20 +2,21 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { EnumInputShape, EnumOutputShape } from '@mysten/bcs';
-import type { BaseSchema, Input, Output } from 'valibot';
+import type { GenericSchema, InferInput, InferOutput } from 'valibot';
 import {
 	array,
 	boolean,
-	custom,
+	check,
 	integer,
+	lazy,
 	literal,
 	nullable,
 	nullish,
 	number,
 	object,
 	optional,
+	pipe,
 	record,
-	recursive,
 	string,
 	transform,
 	tuple,
@@ -27,45 +28,49 @@ import { isValidSuiAddress, normalizeSuiAddress } from '../../utils/sui-types.js
 
 type Merge<T> = T extends object ? { [K in keyof T]: T[K] } : never;
 
-type EnumSchema<T extends Record<string, BaseSchema<any>>> = BaseSchema<
+type EnumSchema<T extends Record<string, GenericSchema<any>>> = GenericSchema<
 	EnumInputShape<
 		Merge<{
-			[K in keyof T]: Input<T[K]>;
+			[K in keyof T]: InferInput<T[K]>;
 		}>
 	>,
 	EnumOutputShape<
 		Merge<{
-			[K in keyof T]: Output<T[K]>;
+			[K in keyof T]: InferOutput<T[K]>;
 		}>
 	>
 >;
 
-export function safeEnum<T extends Record<string, BaseSchema<any>>>(options: T): EnumSchema<T> {
+export function safeEnum<T extends Record<string, GenericSchema<any>>>(options: T): EnumSchema<T> {
 	const unionOptions = Object.entries(options).map(([key, value]) => object({ [key]: value }));
 
-	return transform(union(unionOptions), (value) => ({
-		...value,
-		$kind: Object.keys(value)[0] as keyof typeof value,
-	})) as EnumSchema<T>;
+	return pipe(
+		union(unionOptions),
+		transform((value) => ({
+			...value,
+			$kind: Object.keys(value)[0] as keyof typeof value,
+		})),
+	) as EnumSchema<T>;
 }
 
-export const SuiAddress = transform(string(), (value) => normalizeSuiAddress(value), [
-	custom(isValidSuiAddress),
-]);
+export const SuiAddress = pipe(
+	string(),
+	transform((value) => normalizeSuiAddress(value)),
+	check(isValidSuiAddress),
+);
 export const ObjectID = SuiAddress;
 export const BCSBytes = string();
-export const JsonU64 = union(
-	[string(), number([integer()])],
-	[
-		custom((val) => {
-			try {
-				BigInt(val);
-				return BigInt(val) >= 0 && BigInt(val) <= 18446744073709551615n;
-			} catch {
-				return false;
-			}
-		}, 'Invalid u64'),
-	],
+export const JsonU64 = pipe(
+	union([string(), pipe(number(), integer())]),
+
+	check((val) => {
+		try {
+			BigInt(val);
+			return BigInt(val) >= 0 && BigInt(val) <= 18446744073709551615n;
+		} catch {
+			return false;
+		}
+	}, 'Invalid u64'),
 );
 // https://github.com/MystenLabs/sui/blob/df41d5fa8127634ff4285671a01ead00e519f806/crates/sui-types/src/base_types.rs#L138
 // Implemented as a tuple in rust
@@ -74,23 +79,23 @@ export const ObjectRef = object({
 	version: JsonU64,
 	digest: string(),
 });
-export type ObjectRef = Output<typeof ObjectRef>;
+export type ObjectRef = InferOutput<typeof ObjectRef>;
 
 // https://github.com/MystenLabs/sui/blob/df41d5fa8127634ff4285671a01ead00e519f806/crates/sui-types/src/transaction.rs#L690-L702
-export const Argument = transform(
+export const Argument = pipe(
 	union([
 		object({ GasCoin: literal(true) }),
-		object({ Input: number([integer()]), type: optional(literal('pure')) }),
-		object({ Input: number([integer()]), type: optional(literal('object')) }),
-		object({ Result: number([integer()]) }),
-		object({ NestedResult: tuple([number([integer()]), number([integer()])]) }),
+		object({ Input: pipe(number(), integer()), type: optional(literal('pure')) }),
+		object({ Input: pipe(number(), integer()), type: optional(literal('object')) }),
+		object({ Result: pipe(number(), integer()) }),
+		object({ NestedResult: tuple([pipe(number(), integer()), pipe(number(), integer())]) }),
 	]),
-	(value) => ({
+	transform((value) => ({
 		...value,
 		$kind: Object.keys(value)[0] as keyof typeof value,
-	}),
+	})),
 	// Defined manually to add `type?: 'pure' | 'object'` to Input
-) as BaseSchema<
+) as GenericSchema<
 	// Input
 	| { GasCoin: true }
 	| { Input: number; type?: 'pure' | 'object' }
@@ -104,7 +109,7 @@ export const Argument = transform(
 	| { $kind: 'NestedResult'; NestedResult: [number, number] }
 >;
 
-export type Argument = Output<typeof Argument>;
+export type Argument = InferOutput<typeof Argument>;
 
 // https://github.com/MystenLabs/sui/blob/df41d5fa8127634ff4285671a01ead00e519f806/crates/sui-types/src/transaction.rs#L1387-L1392
 export const GasData = object({
@@ -113,7 +118,7 @@ export const GasData = object({
 	owner: nullable(SuiAddress),
 	payment: nullable(array(ObjectRef)),
 });
-export type GasData = Output<typeof GasData>;
+export type GasData = InferOutput<typeof GasData>;
 
 // https://github.com/MystenLabs/sui/blob/df41d5fa8127634ff4285671a01ead00e519f806/external-crates/move/crates/move-core-types/src/language_storage.rs#L140-L147
 export const StructTag = object({
@@ -123,7 +128,7 @@ export const StructTag = object({
 	// type_params in rust, should be updated to use camelCase
 	typeParams: array(string()),
 });
-export type StructTag = Output<typeof StructTag>;
+export type StructTag = InferOutput<typeof StructTag>;
 
 // https://github.com/MystenLabs/sui/blob/cea8742e810142a8145fd83c4c142d61e561004a/crates/sui-graphql-rpc/schema/current_progress_schema.graphql#L1614-L1627
 export type OpenMoveTypeSignatureBody =
@@ -146,7 +151,7 @@ export type OpenMoveTypeSignatureBody =
 	  }
 	| { typeParameter: number };
 
-export const OpenMoveTypeSignatureBody: BaseSchema<OpenMoveTypeSignatureBody> = union([
+export const OpenMoveTypeSignatureBody: GenericSchema<OpenMoveTypeSignatureBody> = union([
 	literal('address'),
 	literal('bool'),
 	literal('u8'),
@@ -155,16 +160,16 @@ export const OpenMoveTypeSignatureBody: BaseSchema<OpenMoveTypeSignatureBody> =
 	literal('u64'),
 	literal('u128'),
 	literal('u256'),
-	object({ vector: recursive(() => OpenMoveTypeSignatureBody) }),
+	object({ vector: lazy(() => OpenMoveTypeSignatureBody) }),
 	object({
 		datatype: object({
 			package: string(),
 			module: string(),
 			type: string(),
-			typeParameters: array(recursive(() => OpenMoveTypeSignatureBody)),
+			typeParameters: array(lazy(() => OpenMoveTypeSignatureBody)),
 		}),
 	}),
-	object({ typeParameter: number([integer()]) }),
+	object({ typeParameter: pipe(number(), integer()) }),
 ]);
 
 // https://github.com/MystenLabs/sui/blob/cea8742e810142a8145fd83c4c142d61e561004a/crates/sui-graphql-rpc/schema/current_progress_schema.graphql#L1609-L1612
@@ -172,7 +177,7 @@ export const OpenMoveTypeSignature = object({
 	ref: nullable(union([literal('&'), literal('&mut')])),
 	body: OpenMoveTypeSignatureBody,
 });
-export type OpenMoveTypeSignature = Output<typeof OpenMoveTypeSignature>;
+export type OpenMoveTypeSignature = InferOutput<typeof OpenMoveTypeSignature>;
 
 // https://github.com/MystenLabs/sui/blob/df41d5fa8127634ff4285671a01ead00e519f806/crates/sui-types/src/transaction.rs#L707-L718
 const ProgrammableMoveCall = object({
@@ -184,7 +189,7 @@ const ProgrammableMoveCall = object({
 	arguments: array(Argument),
 	_argumentTypes: optional(nullable(array(OpenMoveTypeSignature))),
 });
-export type ProgrammableMoveCall = Output<typeof ProgrammableMoveCall>;
+export type ProgrammableMoveCall = InferOutput<typeof ProgrammableMoveCall>;
 
 export const $Intent = object({
 	name: string(),
@@ -294,7 +299,7 @@ const CallArg = safeEnum({
 		initialSharedVersion: optional(nullable(JsonU64)),
 	}),
 });
-export type CallArg = Output<typeof CallArg>;
+export type CallArg = InferOutput<typeof CallArg>;
 
 export const NormalizedCallArg = safeEnum({
 	Object: ObjectArg,
@@ -308,7 +313,7 @@ export const TransactionExpiration = safeEnum({
 	Epoch: JsonU64,
 });
 
-export type TransactionExpiration = Output<typeof TransactionExpiration>;
+export type TransactionExpiration = InferOutput<typeof TransactionExpiration>;
 
 export const TransactionData = object({
 	version: literal(2),
@@ -318,4 +323,4 @@ export const TransactionData = object({
 	inputs: array(CallArg),
 	commands: array(Command),
 });
-export type TransactionData = Output<typeof TransactionData>;
+export type TransactionData = InferOutput<typeof TransactionData>;