@mysten/sui 2.6.0 → 2.8.0

package/src/graphql/queries/objects.graphql

@@ -10,6 +10,7 @@ query getOwnedObjects(
 	$includePreviousTransaction: Boolean = false
 	$includeObjectBcs: Boolean = false
 	$includeJson: Boolean = false
+	$includeDisplay: Boolean = false
 ) {
 	address(address: $owner) {
 		objects(first: $limit, after: $cursor, filter: $filter) {
@@ -30,6 +31,7 @@ query multiGetObjects(
 	$includePreviousTransaction: Boolean = false
 	$includeObjectBcs: Boolean = false
 	$includeJson: Boolean = false
+	$includeDisplay: Boolean = false
 ) {
 	multiGetObjects(keys: $objectKeys) {
 		...OBJECT_FIELDS
@@ -45,6 +47,10 @@ fragment OBJECT_FIELDS on Object {
 		contents {
 			bcs @include(if: $includeContent)
 			json @include(if: $includeJson)
+			display @include(if: $includeDisplay) {
+				output
+				errors
+			}
 			type {
 				repr
 			}
@@ -69,6 +75,10 @@ fragment MOVE_OBJECT_FIELDS on MoveObject {
 	contents {
 		bcs @include(if: $includeContent)
 		json @include(if: $includeJson)
+		display @include(if: $includeDisplay) {
+			output
+			errors
+		}
 		type {
 			repr
 		}

package/src/graphql/queries/verifyZkLoginSignature.graphql

@@ -11,6 +11,5 @@ query verifyZkLoginSignature(
 		author: $author
 	) {
 		success
-		error
 	}
 }

package/src/grpc/core.ts

@@ -74,6 +74,9 @@ export class GrpcCoreClient extends CoreClient {
 		if (options.include?.json) {
 			paths.push('json');
 		}
+		if (options.include?.display) {
+			paths.push('display');
+		}
 
 		for (const batch of batches) {
 			const response = await this.#client.ledgerService.batchGetObjects({
@@ -110,6 +113,11 @@ export class GrpcCoreClient extends CoreClient {
 							: null
 						: undefined;
 
+					const displayData = mapDisplayProto(
+						options.include?.display,
+						object.result.object.display,
+					);
+
 					return {
 						objectId: object.result.object.objectId!,
 						version: object.result.object.version?.toString()!,
@@ -121,6 +129,7 @@ export class GrpcCoreClient extends CoreClient {
 							undefined) as SuiClientTypes.Object<Include>['previousTransaction'],
 						objectBcs: objectBcs as SuiClientTypes.Object<Include>['objectBcs'],
 						json: jsonContent as SuiClientTypes.Object<Include>['json'],
+						display: displayData as SuiClientTypes.Object<Include>['display'],
 					};
 				}),
 			);
@@ -146,6 +155,9 @@ export class GrpcCoreClient extends CoreClient {
 		if (options.include?.json) {
 			paths.push('json');
 		}
+		if (options.include?.display) {
+			paths.push('display');
+		}
 
 		const response = await this.#client.stateService.listOwnedObjects({
 			owner: options.owner,
@@ -175,6 +187,10 @@ export class GrpcCoreClient extends CoreClient {
 						? (Value.toJson(object.json) as Record<string, unknown>)
 						: null
 					: undefined) as SuiClientTypes.Object<Include>['json'],
+				display: mapDisplayProto(
+					options.include?.display,
+					object.display,
+				) as SuiClientTypes.Object<Include>['display'],
 			}),
 		);
 
@@ -752,6 +768,24 @@ export class GrpcCoreClient extends CoreClient {
 	}
 }
 
+function mapDisplayProto(
+	include: boolean | undefined,
+	display: { output?: Value; errors?: Value } | undefined,
+): SuiClientTypes.Display | null | undefined {
+	if (!include) return undefined;
+	if (display === undefined) return null;
+	return {
+		output:
+			display.output !== undefined
+				? (Value.toJson(display.output) as Record<string, string> | null)
+				: null,
+		errors:
+			display.errors !== undefined
+				? (Value.toJson(display.errors) as Record<string, string> | null)
+				: null,
+	};
+}
+
 function mapOwner(owner: Owner | null | undefined): SuiClientTypes.ObjectOwner | null {
 	if (!owner) {
 		return null;

package/src/grpc/proto/sui/rpc/v2/object.ts

@@ -107,6 +107,13 @@ export interface Object {
 	 * @generated from protobuf field: optional uint64 balance = 101;
 	 */
 	balance?: bigint;
+	/**
+	 * JSON rendering of the object based on an on-chain template.
+	 * This will not be set if the value's type does not have an associated `Display` template.
+	 *
+	 * @generated from protobuf field: optional sui.rpc.v2.Display display = 102;
+	 */
+	display?: Display;
 }
 /**
  * Set of Objects
@@ -121,6 +128,29 @@ export interface ObjectSet {
 	 */
 	objects: Object[];
 }
+/**
+ * A rendered JSON blob based on an on-chain template.
+ *
+ * @generated from protobuf message sui.rpc.v2.Display
+ */
+export interface Display {
+	/**
+	 * Output for all successfully substituted display fields. Unsuccessful
+	 * fields will be `null`, and will be accompanied by a field in `errors`,
+	 * explaining the error.
+	 *
+	 * @generated from protobuf field: optional google.protobuf.Value output = 1;
+	 */
+	output?: Value;
+	/**
+	 * If any fields failed to render, this will contain a mapping from failed
+	 * field names to error messages. If all fields succeed, this will either be
+	 * `null` or not set.
+	 *
+	 * @generated from protobuf field: optional google.protobuf.Value errors = 2;
+	 */
+	errors?: Value;
+}
 // @generated message type with reflection information, may provide speed optimized methods
 class Object$Type extends MessageType<Object> {
 	constructor() {
@@ -165,6 +195,7 @@ class Object$Type extends MessageType<Object> {
 				T: 4 /*ScalarType.UINT64*/,
 				L: 0 /*LongType.BIGINT*/,
 			},
+			{ no: 102, name: 'display', kind: 'message', T: () => Display },
 		]);
 	}
 }
@@ -184,3 +215,16 @@ class ObjectSet$Type extends MessageType<ObjectSet> {
  * @generated MessageType for protobuf message sui.rpc.v2.ObjectSet
  */
 export const ObjectSet = new ObjectSet$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class Display$Type extends MessageType<Display> {
+	constructor() {
+		super('sui.rpc.v2.Display', [
+			{ no: 1, name: 'output', kind: 'message', T: () => Value },
+			{ no: 2, name: 'errors', kind: 'message', T: () => Value },
+		]);
+	}
+}
+/**
+ * @generated MessageType for protobuf message sui.rpc.v2.Display
+ */
+export const Display = new Display$Type();

package/src/grpc/proto/sui/rpc/v2/transaction_execution_service.ts

@@ -111,6 +111,14 @@ export interface SimulateTransactionResponse {
 	 * @generated from protobuf field: repeated sui.rpc.v2.CommandResult command_outputs = 2;
 	 */
 	commandOutputs: CommandResult[];
+	/**
+	 * A suggested gas price to use, that is above RGP, in order to provide a
+	 * better chance of the transaction being included in the presence of
+	 * congested objects.
+	 *
+	 * @generated from protobuf field: optional uint64 suggested_gas_price = 3;
+	 */
+	suggestedGasPrice?: bigint;
 }
 /**
  * An intermediate result/output from the execution of a single command
@@ -214,6 +222,14 @@ class SimulateTransactionResponse$Type extends MessageType<SimulateTransactionRe
 				repeat: 1 /*RepeatType.PACKED*/,
 				T: () => CommandResult,
 			},
+			{
+				no: 3,
+				name: 'suggested_gas_price',
+				kind: 'scalar',
+				opt: true,
+				T: 4 /*ScalarType.UINT64*/,
+				L: 0 /*LongType.BIGINT*/,
+			},
 		]);
 	}
 }

package/src/jsonRpc/core.ts

@@ -131,6 +131,7 @@ export class JSONRpcCoreClient extends CoreClient {
 						options.include?.previousTransaction || options.include?.objectBcs ? true : false,
 					showStorageRebate: options.include?.objectBcs ?? false,
 					showContent: options.include?.json ?? false,
+					showDisplay: options.include?.display ?? false,
 				},
 				signal: options.signal,
 			});
@@ -175,6 +176,7 @@ export class JSONRpcCoreClient extends CoreClient {
 					options.include?.previousTransaction || options.include?.objectBcs ? true : false,
 				showStorageRebate: options.include?.objectBcs ?? false,
 				showContent: options.include?.json ?? false,
+				showDisplay: options.include?.display ?? false,
 			},
 			filter,
 			signal: options.signal,
@@ -687,6 +689,12 @@ function parseObject<Include extends SuiClientTypes.ObjectInclude = {}>(
 				? null
 				: undefined;
 
+	const displayData = include?.display
+		? object.display?.data != null
+			? { output: object.display.data as Record<string, string>, errors: null }
+			: null
+		: undefined;
+
 	return {
 		objectId: object.objectId,
 		version: object.version,
@@ -701,6 +709,7 @@ function parseObject<Include extends SuiClientTypes.ObjectInclude = {}>(
 			: undefined) as SuiClientTypes.Object<Include>['previousTransaction'],
 		objectBcs: objectBcs as SuiClientTypes.Object<Include>['objectBcs'],
 		json: jsonContent as SuiClientTypes.Object<Include>['json'],
+		display: displayData as SuiClientTypes.Object<Include>['display'],
 	};
 }
 

package/src/keypairs/passkey/keypair.ts

@@ -39,7 +39,7 @@ export type BrowserPasswordProviderOptions = Pick<
 
 export interface PasskeyProvider {
 	create(): Promise<RegistrationCredential>;
-	get(challenge: Uint8Array): Promise<AuthenticationCredential>;
+	get(challenge: Uint8Array, credentialId?: Uint8Array): Promise<AuthenticationCredential>;
 }
 
 // Default browser implementation
@@ -80,12 +80,15 @@ export class BrowserPasskeyProvider implements PasskeyProvider {
 		})) as RegistrationCredential;
 	}
 
-	async get(challenge: Uint8Array): Promise<AuthenticationCredential> {
+	async get(challenge: Uint8Array, credentialId?: Uint8Array): Promise<AuthenticationCredential> {
 		return (await navigator.credentials.get({
 			publicKey: {
 				challenge: challenge as BufferSource,
 				userVerification: this.#options.authenticatorSelection?.userVerification || 'required',
 				timeout: this.#options.timeout ?? 60000,
+				...(credentialId && {
+					allowCredentials: [{ type: 'public-key' as const, id: credentialId as BufferSource }],
+				}),
 			},
 		})) as AuthenticationCredential;
 	}
@@ -98,6 +101,7 @@ export class BrowserPasskeyProvider implements PasskeyProvider {
 export class PasskeyKeypair extends Signer {
 	private publicKey: Uint8Array;
 	private provider: PasskeyProvider;
+	private credentialId?: Uint8Array;
 
 	/**
 	 * Get the key scheme of passkey,
@@ -120,10 +124,20 @@ export class PasskeyKeypair extends Signer {
 	 * If there are existing passkey wallet, use `signAndRecover` to identify the correct
 	 * public key and then initialize the instance. See usage in `signAndRecover`.
 	 */
-	constructor(publicKey: Uint8Array, provider: PasskeyProvider) {
+	constructor(publicKey: Uint8Array, provider: PasskeyProvider, credentialId?: Uint8Array) {
 		super();
 		this.publicKey = publicKey;
 		this.provider = provider;
+		this.credentialId = credentialId;
+	}
+
+	/**
+	 * Return the credential ID for this passkey, if available.
+	 * The credential ID is captured when creating a new passkey via `getPasskeyInstance`
+	 * and can be used to constrain which credential the browser selects during signing.
+	 */
+	getCredentialId(): Uint8Array | undefined {
+		return this.credentialId;
 	}
 
 	/**
@@ -145,7 +159,7 @@ export class PasskeyKeypair extends Signer {
 			const pubkeyUncompressed = parseDerSPKI(new Uint8Array(derSPKI));
 			const pubkey = secp256r1.Point.fromBytes(pubkeyUncompressed);
 			const pubkeyCompressed = pubkey.toBytes(true);
-			return new PasskeyKeypair(pubkeyCompressed, provider);
+			return new PasskeyKeypair(pubkeyCompressed, provider, new Uint8Array(credential.rawId));
 		}
 	}
 
@@ -162,7 +176,7 @@ export class PasskeyKeypair extends Signer {
 	 */
 	async sign(data: Uint8Array) {
 		// asks the passkey to sign over challenge as the data.
-		const credential = await this.provider.get(data);
+		const credential = await this.provider.get(data, this.credentialId);
 
 		// parse authenticatorData (as bytes), clientDataJSON (decoded as string).
 		const authenticatorData = new Uint8Array(credential.response.authenticatorData);
@@ -245,7 +259,7 @@ export class PasskeyKeypair extends Signer {
 	 * const testMessage2 = new TextEncoder().encode('Hello world 2!');
 	 * const possiblePks2 = await PasskeyKeypair.signAndRecover(provider, testMessage2);
 	 * const commonPk = findCommonPublicKey(possiblePks, possiblePks2);
-	 * const signer = new PasskeyKeypair(provider, commonPk.toRawBytes());
+	 * const signer = new PasskeyKeypair(commonPk.toRawBytes(), provider);
 	 * ```
 	 *
 	 * @param provider - the passkey provider.

package/src/version.ts

@@ -3,5 +3,5 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '2.6.0';
-export const TARGETED_RPC_VERSION = '1.68.0';
+export const PACKAGE_VERSION = '2.8.0';
+export const TARGETED_RPC_VERSION = '1.69.0';