@mysten/sui 1.28.1 → 1.29.0

package/src/experimental/transports/jsonRPC.ts

@@ -18,6 +18,7 @@ import { normalizeStructTag } from '../../utils/sui-types.js';
 import { Experimental_CoreClient } from '../core.js';
 import { ObjectError } from '../errors.js';
 import type { Experimental_SuiClientTypes } from '../types.js';
+import { parseTransactionEffects } from './utils.js';
 
 export class JSONRpcTransport extends Experimental_CoreClient {
 	#jsonRpcClient: SuiClient;
@@ -39,6 +40,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 					showType: true,
 					showBcs: true,
 				},
+				signal: options.signal,
 			});
 
 			for (const [idx, object] of objects.entries()) {
@@ -64,6 +66,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 				showType: true,
 				showBcs: true,
 			},
+			signal: options.signal,
 		});
 
 		return {
@@ -83,6 +86,9 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 		const coins = await this.#jsonRpcClient.getCoins({
 			owner: options.address,
 			coinType: options.coinType,
+			limit: options.limit,
+			cursor: options.cursor,
+			signal: options.signal,
 		});
 
 		return {
@@ -114,6 +120,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 		const balance = await this.#jsonRpcClient.getBalance({
 			owner: options.address,
 			coinType: options.coinType,
+			signal: options.signal,
 		});
 
 		return {
@@ -126,6 +133,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 	async getAllBalances(options: Experimental_SuiClientTypes.GetAllBalancesOptions) {
 		const balances = await this.#jsonRpcClient.getAllBalances({
 			owner: options.address,
+			signal: options.signal,
 		});
 
 		return {
@@ -146,6 +154,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 				showRawEffects: true,
 				showEvents: true,
 			},
+			signal: options.signal,
 		});
 
 		return {
@@ -162,6 +171,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 				showObjectChanges: true,
 				showRawInput: true,
 			},
+			signal: options.signal,
 		});
 
 		return {
@@ -172,6 +182,7 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 		const tx = Transaction.from(options.transaction);
 		const result = await this.#jsonRpcClient.dryRunTransactionBlock({
 			transactionBlock: options.transaction,
+			signal: options.signal,
 		});
 
 		return {
@@ -186,8 +197,10 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 			},
 		};
 	}
-	async getReferenceGasPrice() {
-		const referenceGasPrice = await this.#jsonRpcClient.getReferenceGasPrice();
+	async getReferenceGasPrice(options?: Experimental_SuiClientTypes.GetReferenceGasPriceOptions) {
+		const referenceGasPrice = await this.#jsonRpcClient.getReferenceGasPrice({
+			signal: options?.signal,
+		});
 		return {
 			referenceGasPrice: String(referenceGasPrice),
 		};
@@ -201,20 +214,34 @@ export class JSONRpcTransport extends Experimental_CoreClient {
 		});
 
 		return {
-			dynamicFields: dynamicFields.data.map((dynamicField) => ({
-				id: dynamicField.objectId,
-				version: dynamicField.version,
-				digest: dynamicField.digest,
-				type: dynamicField.objectType,
-				name: {
-					type: dynamicField.name.type,
-					bcs: fromBase64(dynamicField.bcsName),
-				},
-			})),
+			dynamicFields: dynamicFields.data.map((dynamicField) => {
+				return {
+					id: dynamicField.objectId,
+					type: dynamicField.objectType,
+					name: {
+						type: dynamicField.name.type,
+						bcs: fromBase64(dynamicField.bcsName),
+					},
+				};
+			}),
 			hasNextPage: dynamicFields.hasNextPage,
 			cursor: dynamicFields.nextCursor,
 		};
 	}
+
+	async verifyZkLoginSignature(options: Experimental_SuiClientTypes.VerifyZkLoginSignatureOptions) {
+		const result = await this.#jsonRpcClient.verifyZkLoginSignature({
+			bytes: options.bytes,
+			signature: options.signature,
+			intentScope: options.intentScope,
+			author: options.author,
+		});
+
+		return {
+			success: result.success,
+			errors: result.errors,
+		};
+	}
 }
 
 function parseObject(object: SuiObjectData): Experimental_SuiClientTypes.ObjectResponse {
@@ -280,134 +307,22 @@ function parseTransaction(
 	transaction: SuiTransactionBlockResponse,
 ): Experimental_SuiClientTypes.TransactionResponse {
 	const parsedTx = bcs.SenderSignedData.parse(fromBase64(transaction.rawTransaction!))[0];
-
-	return {
-		digest: transaction.digest,
-		effects: parseTransactionEffects({
-			effects: new Uint8Array(transaction.rawEffects!),
-			objectChanges: transaction.objectChanges ?? null,
-		}),
-		bcs: bcs.TransactionData.serialize(parsedTx.intentMessage.value).toBytes(),
-		signatures: parsedTx.txSignatures,
-	};
-}
-
-function parseTransactionEffects({
-	effects,
-	epoch,
-	objectChanges,
-}: {
-	effects: Uint8Array;
-	objectChanges: SuiObjectChange[] | null;
-	epoch?: string | null;
-}): Experimental_SuiClientTypes.TransactionEffects {
-	const parsed = bcs.TransactionEffects.parse(effects);
 	const objectTypes: Record<string, string> = {};
 
-	objectChanges?.forEach((change) => {
+	transaction.objectChanges?.forEach((change) => {
 		if (change.type !== 'published') {
 			objectTypes[change.objectId] = change.objectType;
 		}
 	});
 
-	switch (parsed.$kind) {
-		case 'V1':
-			return parseTransactionEffectsV1({ bytes: effects, effects: parsed.V1, epoch, objectTypes });
-		case 'V2':
-			return parseTransactionEffectsV2({ bytes: effects, effects: parsed.V2, epoch, objectTypes });
-		default:
-			throw new Error(
-				`Unknown transaction effects version: ${(parsed as { $kind: string }).$kind}`,
-			);
-	}
-}
-
-function parseTransactionEffectsV1(_: {
-	bytes: Uint8Array;
-	effects: NonNullable<(typeof bcs.TransactionEffects.$inferType)['V1']>;
-	epoch?: string | null;
-	objectTypes: Record<string, string>;
-}): Experimental_SuiClientTypes.TransactionEffects {
-	throw new Error('V1 effects are not supported yet');
-}
-
-function parseTransactionEffectsV2({
-	bytes,
-	effects,
-	epoch,
-	objectTypes,
-}: {
-	bytes: Uint8Array;
-	effects: NonNullable<(typeof bcs.TransactionEffects.$inferType)['V2']>;
-	epoch?: string | null;
-	objectTypes: Record<string, string>;
-}): Experimental_SuiClientTypes.TransactionEffects {
-	const changedObjects = effects.changedObjects.map(
-		([id, change]): Experimental_SuiClientTypes.ChangedObject => {
-			return {
-				id,
-				inputState: change.inputState.$kind === 'Exist' ? 'Exists' : 'DoesNotExist',
-				inputVersion: change.inputState.Exist?.[0][0] ?? null,
-				inputDigest: change.inputState.Exist?.[0][1] ?? null,
-				inputOwner: change.inputState.Exist?.[1] ?? null,
-				outputState:
-					change.outputState.$kind === 'NotExist' ? 'DoesNotExist' : change.outputState.$kind,
-				outputVersion:
-					change.outputState.$kind === 'PackageWrite'
-						? change.outputState.PackageWrite?.[0]
-						: change.outputState.ObjectWrite
-							? effects.lamportVersion
-							: null,
-				outputDigest:
-					change.outputState.$kind === 'PackageWrite'
-						? change.outputState.PackageWrite?.[1]
-						: (change.outputState.ObjectWrite?.[0] ?? null),
-				outputOwner: change.outputState.ObjectWrite ? change.outputState.ObjectWrite[1] : null,
-				idOperation: change.idOperation.$kind,
-				objectType: objectTypes[id] ?? null,
-			};
-		},
-	);
-
 	return {
-		bcs: bytes,
-		digest: effects.transactionDigest,
-		version: 2,
-		status:
-			effects.status.$kind === 'Success'
-				? {
-						success: true,
-						error: null,
-					}
-				: {
-						success: false,
-						// TODO: add command
-						error: effects.status.Failed.error.$kind,
-					},
-		epoch: epoch ?? null,
-		gasUsed: effects.gasUsed,
-		transactionDigest: effects.transactionDigest,
-		gasObject:
-			effects.gasObjectIndex === null ? null : (changedObjects[effects.gasObjectIndex] ?? null),
-		eventsDigest: effects.eventsDigest,
-		dependencies: effects.dependencies,
-		lamportVersion: effects.lamportVersion,
-		changedObjects,
-		unchangedSharedObjects: effects.unchangedSharedObjects.map(
-			([objectId, object]): Experimental_SuiClientTypes.UnchangedSharedObject => {
-				return {
-					kind: object.$kind,
-					objectId: objectId,
-					version:
-						object.$kind === 'ReadOnlyRoot'
-							? object.ReadOnlyRoot[0]
-							: (object[object.$kind] as string | null),
-					digest: object.$kind === 'ReadOnlyRoot' ? object.ReadOnlyRoot[1] : null,
-					objectType: objectTypes[objectId] ?? null,
-				};
-			},
-		),
-		auxiliaryDataDigest: effects.auxDataDigest,
+		digest: transaction.digest,
+		effects: parseTransactionEffects({
+			effects: new Uint8Array(transaction.rawEffects!),
+			objectTypes,
+		}),
+		bcs: bcs.TransactionData.serialize(parsedTx.intentMessage.value).toBytes(),
+		signatures: parsedTx.txSignatures,
 	};
 }
 

package/src/experimental/transports/utils.ts

@@ -0,0 +1,117 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { bcs } from '../../bcs/index.js';
+import type { Experimental_SuiClientTypes } from '../types.js';
+
+export function parseTransactionEffects({
+	effects,
+	epoch,
+	objectTypes,
+}: {
+	effects: Uint8Array;
+	objectTypes: Record<string, string>;
+	epoch?: string | null;
+}): Experimental_SuiClientTypes.TransactionEffects {
+	const parsed = bcs.TransactionEffects.parse(effects);
+
+	switch (parsed.$kind) {
+		case 'V1':
+			return parseTransactionEffectsV1({ bytes: effects, effects: parsed.V1, epoch, objectTypes });
+		case 'V2':
+			return parseTransactionEffectsV2({ bytes: effects, effects: parsed.V2, epoch, objectTypes });
+		default:
+			throw new Error(
+				`Unknown transaction effects version: ${(parsed as { $kind: string }).$kind}`,
+			);
+	}
+}
+
+function parseTransactionEffectsV1(_: {
+	bytes: Uint8Array;
+	effects: NonNullable<(typeof bcs.TransactionEffects.$inferType)['V1']>;
+	epoch?: string | null;
+	objectTypes: Record<string, string>;
+}): Experimental_SuiClientTypes.TransactionEffects {
+	throw new Error('V1 effects are not supported yet');
+}
+
+function parseTransactionEffectsV2({
+	bytes,
+	effects,
+	epoch,
+	objectTypes,
+}: {
+	bytes: Uint8Array;
+	effects: NonNullable<(typeof bcs.TransactionEffects.$inferType)['V2']>;
+	epoch?: string | null;
+	objectTypes: Record<string, string>;
+}): Experimental_SuiClientTypes.TransactionEffects {
+	const changedObjects = effects.changedObjects.map(
+		([id, change]): Experimental_SuiClientTypes.ChangedObject => {
+			return {
+				id,
+				inputState: change.inputState.$kind === 'Exist' ? 'Exists' : 'DoesNotExist',
+				inputVersion: change.inputState.Exist?.[0][0] ?? null,
+				inputDigest: change.inputState.Exist?.[0][1] ?? null,
+				inputOwner: change.inputState.Exist?.[1] ?? null,
+				outputState:
+					change.outputState.$kind === 'NotExist' ? 'DoesNotExist' : change.outputState.$kind,
+				outputVersion:
+					change.outputState.$kind === 'PackageWrite'
+						? change.outputState.PackageWrite?.[0]
+						: change.outputState.ObjectWrite
+							? effects.lamportVersion
+							: null,
+				outputDigest:
+					change.outputState.$kind === 'PackageWrite'
+						? change.outputState.PackageWrite?.[1]
+						: (change.outputState.ObjectWrite?.[0] ?? null),
+				outputOwner: change.outputState.ObjectWrite ? change.outputState.ObjectWrite[1] : null,
+				idOperation: change.idOperation.$kind,
+				objectType: objectTypes[id] ?? null,
+			};
+		},
+	);
+
+	return {
+		bcs: bytes,
+		digest: effects.transactionDigest,
+		version: 2,
+		status:
+			effects.status.$kind === 'Success'
+				? {
+						success: true,
+						error: null,
+					}
+				: {
+						success: false,
+						// TODO: add command
+						error: effects.status.Failed.error.$kind,
+					},
+		epoch: epoch ?? null,
+		gasUsed: effects.gasUsed,
+		transactionDigest: effects.transactionDigest,
+		gasObject:
+			effects.gasObjectIndex === null ? null : (changedObjects[effects.gasObjectIndex] ?? null),
+		eventsDigest: effects.eventsDigest,
+		dependencies: effects.dependencies,
+		lamportVersion: effects.lamportVersion,
+		changedObjects,
+		unchangedSharedObjects: effects.unchangedSharedObjects.map(
+			([objectId, object]): Experimental_SuiClientTypes.UnchangedSharedObject => {
+				return {
+					kind: object.$kind,
+					objectId: objectId,
+					version:
+						object.$kind === 'ReadOnlyRoot'
+							? object.ReadOnlyRoot[0]
+							: (object[object.$kind] as string | null),
+					digest: object.$kind === 'ReadOnlyRoot' ? object.ReadOnlyRoot[1] : null,
+					objectType: objectTypes[objectId] ?? null,
+				};
+			},
+		),
+		auxiliaryDataDigest: effects.auxDataDigest,
+	};
+}

package/src/experimental/types.ts

@@ -55,6 +55,10 @@ export namespace Experimental_SuiClientTypes {
 		objectIds: string[];
 	}
 
+	export interface GetObjectOptions extends CoreClientMethodOptions {
+		objectId: string;
+	}
+
 	export interface GetOwnedObjectsOptions extends CoreClientMethodOptions {
 		address: string;
 		limit?: number;
@@ -65,6 +69,8 @@ export namespace Experimental_SuiClientTypes {
 	export interface GetCoinsOptions extends CoreClientMethodOptions {
 		address: string;
 		coinType: string;
+		limit?: number;
+		cursor?: string | null;
 	}
 
 	export interface GetDynamicFieldsOptions extends CoreClientMethodOptions {
@@ -82,6 +88,10 @@ export namespace Experimental_SuiClientTypes {
 		objects: (ObjectResponse | Error)[];
 	}
 
+	export interface GetObjectResponse {
+		object: ObjectResponse;
+	}
+
 	export interface GetOwnedObjectsResponse {
 		objects: ObjectResponse[];
 		hasNextPage: boolean;
@@ -111,11 +121,9 @@ export namespace Experimental_SuiClientTypes {
 		hasNextPage: boolean;
 		cursor: string | null;
 		dynamicFields: {
-			name: DynamicFieldName;
 			id: string;
-			version: string;
-			digest: string;
 			type: string;
+			name: DynamicFieldName;
 		}[];
 	}
 
@@ -182,11 +190,11 @@ export namespace Experimental_SuiClientTypes {
 	export interface TransactionResponse {
 		digest: string;
 		signatures: string[];
+		effects: TransactionEffects;
 		// TODO: Return parsed data:
-		// We need structured representations of effects, events, and transaction data
+		// We need structured representations events, and transaction data
 		bcs: Uint8Array;
-		effects: TransactionEffects;
-		events?: Uint8Array;
+		// events?: Uint8Array;
 	}
 
 	export interface GetTransactionOptions extends CoreClientMethodOptions {
@@ -214,14 +222,37 @@ export namespace Experimental_SuiClientTypes {
 		transaction: TransactionResponse;
 	}
 
+	export interface GetReferenceGasPriceOptions extends CoreClientMethodOptions {}
+
 	export interface TransportMethods {
-		getReferenceGasPrice?: () => Promise<GetReferenceGasPriceResponse>;
+		getReferenceGasPrice?: (
+			options?: GetReferenceGasPriceOptions,
+		) => Promise<GetReferenceGasPriceResponse>;
 	}
 
 	export interface GetReferenceGasPriceResponse {
 		referenceGasPrice: string;
 	}
 
+	/** ZkLogin methods */
+	export interface VerifyZkLoginSignatureOptions extends CoreClientMethodOptions {
+		bytes: string;
+		signature: string;
+		intentScope: 'TransactionData' | 'PersonalMessage';
+		author: string;
+	}
+
+	export interface ZkLoginVerifyResponse {
+		success: boolean;
+		errors: string[];
+	}
+
+	export interface TransportMethods {
+		verifyZkLoginSignature?: (
+			options: VerifyZkLoginSignatureOptions,
+		) => Promise<ZkLoginVerifyResponse>;
+	}
+
 	/** ObjectOwner types */
 
 	export interface AddressOwner {

package/src/faucet/faucet.ts

@@ -31,7 +31,7 @@ type BatchStatusFaucetResponse = {
 
 type FaucetResponseV2 = {
 	status: 'Success' | FaucetFailure;
-	coin_sent: FaucetCoinInfo | null;
+	coins_sent: FaucetCoinInfo[] | null;
 };
 
 type FaucetFailure = {

package/src/graphql/client.ts

@@ -5,6 +5,10 @@ import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import type { TadaDocumentNode } from 'gql.tada';
 import type { DocumentNode } from 'graphql';
 import { print } from 'graphql';
+import { Experimental_BaseClient } from '../experimental/index.js';
+import type { Experimental_SuiClientTypes } from '../experimental/index.js';
+import { GraphQLTransport } from '../experimental/transports/graphql.js';
+import type { TypedDocumentString } from './generated/queries.js';
 
 export type GraphQLDocument<
 	Result = Record<string, unknown>,
@@ -12,6 +16,7 @@ export type GraphQLDocument<
 > =
 	| string
 	| DocumentNode
+	| TypedDocumentString<Result, Variables>
 	| TypedDocumentNode<Result, Variables>
 	| TadaDocumentNode<Result, Variables>;
 
@@ -22,6 +27,7 @@ export type GraphQLQueryOptions<
 	query: GraphQLDocument<Result, Variables>;
 	operationName?: string;
 	extensions?: Record<string, unknown>;
+	signal?: AbortSignal;
 } & (Variables extends { [key: string]: never }
 	? { variables?: Variables }
 	: {
@@ -45,23 +51,31 @@ export interface SuiGraphQLClientOptions<Queries extends Record<string, GraphQLD
 	fetch?: typeof fetch;
 	headers?: Record<string, string>;
 	queries?: Queries;
+	network?: Experimental_SuiClientTypes.Network;
 }
 
 export class SuiGraphQLRequestError extends Error {}
 
-// eslint-disable-next-line @typescript-eslint/ban-types
-export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> = {}> {
+export class SuiGraphQLClient<
+	// eslint-disable-next-line @typescript-eslint/ban-types
+	Queries extends Record<string, GraphQLDocument> = {},
+> extends Experimental_BaseClient {
 	#url: string;
 	#queries: Queries;
 	#headers: Record<string, string>;
 	#fetch: typeof fetch;
+	core: GraphQLTransport = new GraphQLTransport(this);
 
 	constructor({
 		url,
 		fetch: fetchFn = fetch,
 		headers = {},
 		queries = {} as Queries,
+		network = 'unknown',
 	}: SuiGraphQLClientOptions<Queries>) {
+		super({
+			network,
+		});
 		this.#url = url;
 		this.#queries = queries;
 		this.#headers = headers;
@@ -78,11 +92,15 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 				...this.#headers,
 			},
 			body: JSON.stringify({
-				query: typeof options.query === 'string' ? String(options.query) : print(options.query),
+				query:
+					typeof options.query === 'string' || options.query instanceof String
+						? String(options.query)
+						: print(options.query),
 				variables: options.variables,
 				extensions: options.extensions,
 				operationName: options.operationName,
 			}),
+			signal: options.signal,
 		});
 
 		if (!res.ok) {