@mysten/sui 2.0.1 → 2.2.0

package/dist/zklogin/bcs.d.mts

@@ -1,31 +1,31 @@
-import * as _mysten_bcs810 from "@mysten/bcs";
+import * as _mysten_bcs1118 from "@mysten/bcs";
 import { InferBcsInput } from "@mysten/bcs";
 
 //#region src/zklogin/bcs.d.ts
-declare const zkLoginSignature: _mysten_bcs810.BcsStruct<{
-  inputs: _mysten_bcs810.BcsStruct<{
-    proofPoints: _mysten_bcs810.BcsStruct<{
-      a: _mysten_bcs810.BcsType<string[], Iterable<string> & {
+declare const zkLoginSignature: _mysten_bcs1118.BcsStruct<{
+  inputs: _mysten_bcs1118.BcsStruct<{
+    proofPoints: _mysten_bcs1118.BcsStruct<{
+      a: _mysten_bcs1118.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
-      b: _mysten_bcs810.BcsType<string[][], Iterable<Iterable<string> & {
+      b: _mysten_bcs1118.BcsType<string[][], Iterable<Iterable<string> & {
         length: number;
       }> & {
         length: number;
       }, string>;
-      c: _mysten_bcs810.BcsType<string[], Iterable<string> & {
+      c: _mysten_bcs1118.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
     }, string>;
-    issBase64Details: _mysten_bcs810.BcsStruct<{
-      value: _mysten_bcs810.BcsType<string, string, "string">;
-      indexMod4: _mysten_bcs810.BcsType<number, number, "u8">;
+    issBase64Details: _mysten_bcs1118.BcsStruct<{
+      value: _mysten_bcs1118.BcsType<string, string, "string">;
+      indexMod4: _mysten_bcs1118.BcsType<number, number, "u8">;
     }, string>;
-    headerBase64: _mysten_bcs810.BcsType<string, string, "string">;
-    addressSeed: _mysten_bcs810.BcsType<string, string, "string">;
+    headerBase64: _mysten_bcs1118.BcsType<string, string, "string">;
+    addressSeed: _mysten_bcs1118.BcsType<string, string, "string">;
   }, string>;
-  maxEpoch: _mysten_bcs810.BcsType<string, string | number | bigint, "u64">;
-  userSignature: _mysten_bcs810.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
+  maxEpoch: _mysten_bcs1118.BcsType<string, string | number | bigint, "u64">;
+  userSignature: _mysten_bcs1118.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
 }, string>;
 type ZkLoginSignature = InferBcsInput<typeof zkLoginSignature>;
 type ZkLoginSignatureInputs = ZkLoginSignature['inputs'];

package/dist/zklogin/bcs.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"bcs.d.mts","names":[],"sources":["../../src/zklogin/bcs.ts"],"sourcesContent":[],"mappings":";;;;cAMa,iCAAgB;;;MAAhB,CAAA,wBAgBX,CAAA,MAAA,EAAA,UAAA,CAAA,MAAA,CAAA,GAAA;;;;;;;;;;;;;;;;;;;;eAhB2B,wBAAA,WAAA,gBAAA,CAAA,UAAA,CAAA,MAAA,CAAA,EAAA,YAAA,CAAA;CAAA,EAAA,MAAA,CAAA;AAkBjB,KAAA,gBAAA,GAAmB,aAAqB,CAAA,OAAA,gBAAR,CAAA;AAChC,KAAA,sBAAA,GAAyB,gBAAA,CAAA,QAAgB,CAAA"}
+{"version":3,"file":"bcs.d.mts","names":[],"sources":["../../src/zklogin/bcs.ts"],"sourcesContent":[],"mappings":";;;;cAMa,kCAAgB;;;MAAhB,CAAA,yBAgBX,CAAA,MAAA,EAAA,UAAA,CAAA,MAAA,CAAA,GAAA;;;;;;;;;;;;;;;;;;;;eAhB2B,yBAAA,WAAA,gBAAA,CAAA,UAAA,CAAA,MAAA,CAAA,EAAA,YAAA,CAAA;CAAA,EAAA,MAAA,CAAA;AAkBjB,KAAA,gBAAA,GAAmB,aAAqB,CAAA,OAAA,gBAAR,CAAA;AAChC,KAAA,sBAAA,GAAyB,gBAAA,CAAA,QAAgB,CAAA"}

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -151,8 +151,8 @@
     "graphql": "^16.12.0",
     "poseidon-lite": "0.2.1",
     "valibot": "^1.2.0",
-    "@mysten/bcs": "^2.0.1",
-    "@mysten/utils": "^0.3.0"
+    "@mysten/utils": "^0.3.0",
+    "@mysten/bcs": "^2.0.1"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",

package/src/client/client.ts

@@ -26,14 +26,29 @@ export abstract class BaseClient {
 	$extend<const Registrations extends SuiClientRegistration<this>[]>(
 		...registrations: Registrations
 	) {
-		return Object.create(
-			this,
-			Object.fromEntries(
-				registrations.map((registration) => {
-					return [registration.name, { value: registration.register(this) }];
-				}),
-			),
-		) as ClientWithExtensions<
+		const extensions: Record<string, unknown> = Object.fromEntries(
+			registrations.map((registration) => {
+				return [registration.name, registration.register(this)];
+			}),
+		);
+
+		const methodCache = new Map<string | symbol, Function>();
+
+		return new Proxy(this, {
+			get(target, prop) {
+				if (typeof prop === 'string' && prop in extensions) {
+					return extensions[prop];
+				}
+				const value = Reflect.get(target, prop, target);
+				if (typeof value === 'function') {
+					if (!methodCache.has(prop)) {
+						methodCache.set(prop, value.bind(target));
+					}
+					return methodCache.get(prop);
+				}
+				return value;
+			},
+		}) as ClientWithExtensions<
 			Simplify<
 				UnionToIntersection<
 					{

package/src/client/core.ts

@@ -76,6 +76,10 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		options: SuiClientTypes.ListBalancesOptions,
 	): Promise<SuiClientTypes.ListBalancesResponse>;
 
+	abstract getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse>;
+
 	abstract getTransaction<Include extends SuiClientTypes.TransactionInclude = object>(
 		options: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>>;

package/src/client/types.ts

@@ -235,6 +235,28 @@ export namespace SuiClientTypes {
 		cursor: string | null;
 	}
 
+	/** Coin metadata methods */
+	export interface TransportMethods {
+		getCoinMetadata: (options: GetCoinMetadataOptions) => Promise<GetCoinMetadataResponse>;
+	}
+
+	export interface GetCoinMetadataOptions extends CoreClientMethodOptions {
+		coinType: string;
+	}
+
+	export interface CoinMetadata {
+		id: string | null;
+		decimals: number;
+		name: string;
+		symbol: string;
+		description: string;
+		iconUrl: string | null;
+	}
+
+	export interface GetCoinMetadataResponse {
+		coinMetadata: CoinMetadata | null;
+	}
+
 	/** Transaction methods */
 	export interface TransportMethods {
 		getTransaction: <Include extends TransactionInclude = {}>(

package/src/graphql/client.ts

@@ -180,6 +180,12 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 		return this.core.listBalances(input);
 	}
 
+	getCoinMetadata(
+		input: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		return this.core.getCoinMetadata(input);
+	}
+
 	getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		input: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {

package/src/graphql/core.ts

@@ -20,6 +20,7 @@ import {
 	GetAllBalancesDocument,
 	GetBalanceDocument,
 	GetChainIdentifierDocument,
+	GetCoinMetadataDocument,
 	GetCoinsDocument,
 	GetCurrentSystemStateDocument,
 	GetDynamicFieldsDocument,
@@ -269,6 +270,36 @@ export class GraphQLCoreClient extends CoreClient {
 			},
 		};
 	}
+	async getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+
+		const { data, errors } = await this.#graphqlClient.query({
+			query: GetCoinMetadataDocument,
+			variables: {
+				coinType,
+			},
+		});
+
+		handleGraphQLErrors(errors);
+
+		if (!data?.coinMetadata) {
+			return { coinMetadata: null };
+		}
+
+		return {
+			coinMetadata: {
+				id: data.coinMetadata.address!,
+				decimals: data.coinMetadata.decimals!,
+				name: data.coinMetadata.name!,
+				symbol: data.coinMetadata.symbol!,
+				description: data.coinMetadata.description!,
+				iconUrl: data.coinMetadata.iconUrl ?? null,
+			},
+		};
+	}
+
 	async listBalances(
 		options: SuiClientTypes.ListBalancesOptions,
 	): Promise<SuiClientTypes.ListBalancesResponse> {

package/src/graphql/generated/queries.ts

@@ -3587,7 +3587,7 @@ export type Query = {
    * If the address is fetched by name and the name does not resolve to an address (e.g. the name does not exist or has expired), `null` is returned.
    */
   address?: Maybe<Address>;
-  /** First four bytes of the network's genesis checkpoint digest (uniquely identifies the network), hex-encoded. */
+  /** The network's genesis checkpoint digest (uniquely identifies the network), Base58-encoded. */
   chainIdentifier: Scalars['String']['output'];
   /**
    * Fetch a checkpoint by its sequence number, or the latest checkpoint if no sequence number is provided.
@@ -4612,6 +4612,13 @@ export type GetChainIdentifierQueryVariables = Exact<{ [key: string]: never; }>;
 
 export type GetChainIdentifierQuery = { __typename?: 'Query', checkpoint?: { __typename?: 'Checkpoint', digest?: string | null } | null };
 
+export type GetCoinMetadataQueryVariables = Exact<{
+  coinType: Scalars['String']['input'];
+}>;
+
+
+export type GetCoinMetadataQuery = { __typename?: 'Query', coinMetadata?: { __typename?: 'CoinMetadata', address: string, decimals?: number | null, name?: string | null, symbol?: string | null, description?: string | null, iconUrl?: string | null } | null };
+
 export type GetCoinsQueryVariables = Exact<{
   owner: Scalars['SuiAddress']['input'];
   first?: InputMaybe<Scalars['Int']['input']>;
@@ -5042,6 +5049,18 @@ export const GetChainIdentifierDocument = new TypedDocumentString(`
   }
 }
     `) as unknown as TypedDocumentString<GetChainIdentifierQuery, GetChainIdentifierQueryVariables>;
+export const GetCoinMetadataDocument = new TypedDocumentString(`
+    query getCoinMetadata($coinType: String!) {
+  coinMetadata(coinType: $coinType) {
+    address
+    decimals
+    name
+    symbol
+    description
+    iconUrl
+  }
+}
+    `) as unknown as TypedDocumentString<GetCoinMetadataQuery, GetCoinMetadataQueryVariables>;
 export const GetCoinsDocument = new TypedDocumentString(`
     query getCoins($owner: SuiAddress!, $first: Int, $cursor: String, $type: String = "0x2::coin::Coin<0x2::sui::SUI>") {
   address(address: $owner) {

package/src/graphql/queries/getCoinMetadata.graphql

@@ -0,0 +1,13 @@
+# Copyright (c) Mysten Labs, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+query getCoinMetadata($coinType: String!) {
+	coinMetadata(coinType: $coinType) {
+		address
+		decimals
+		name
+		symbol
+		description
+		iconUrl
+	}
+}

package/src/grpc/client.ts

@@ -108,6 +108,12 @@ export class SuiGrpcClient extends BaseClient implements SuiClientTypes.Transpor
 		return this.core.listBalances(input);
 	}
 
+	getCoinMetadata(
+		input: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		return this.core.getCoinMetadata(input);
+	}
+
 	getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		input: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {

package/src/grpc/core.ts

@@ -235,6 +235,36 @@ export class GrpcCoreClient extends CoreClient {
 		};
 	}
 
+	async getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+
+		let response;
+		try {
+			({ response } = await this.#client.stateService.getCoinInfo({
+				coinType,
+			}));
+		} catch {
+			return { coinMetadata: null };
+		}
+
+		if (!response.metadata) {
+			return { coinMetadata: null };
+		}
+
+		return {
+			coinMetadata: {
+				id: response.metadata.id ?? null,
+				decimals: response.metadata.decimals ?? 0,
+				name: response.metadata.name ?? '',
+				symbol: response.metadata.symbol ?? '',
+				description: response.metadata.description ?? '',
+				iconUrl: response.metadata.iconUrl ?? null,
+			},
+		};
+	}
+
 	async listBalances(
 		options: SuiClientTypes.ListBalancesOptions,
 	): Promise<SuiClientTypes.ListBalancesResponse> {

package/src/jsonRpc/core.ts

@@ -239,6 +239,32 @@ export class JSONRpcCoreClient extends CoreClient {
 			},
 		};
 	}
+	async getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+
+		const result = await this.#jsonRpcClient.getCoinMetadata({
+			coinType,
+			signal: options.signal,
+		});
+
+		if (!result) {
+			return { coinMetadata: null };
+		}
+
+		return {
+			coinMetadata: {
+				id: result.id ?? null,
+				decimals: result.decimals,
+				name: result.name,
+				symbol: result.symbol,
+				description: result.description,
+				iconUrl: result.iconUrl ?? null,
+			},
+		};
+	}
+
 	async listBalances(options: SuiClientTypes.ListBalancesOptions) {
 		const balances = await this.#jsonRpcClient.getAllBalances({
 			owner: options.owner,

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.0.1';
-export const TARGETED_RPC_VERSION = '1.65.0';
+export const PACKAGE_VERSION = '2.2.0';
+export const TARGETED_RPC_VERSION = '1.66.0';