@mysten/sui 2.9.1 → 2.10.0

package/src/client/types.ts

@@ -404,6 +404,8 @@ export namespace SuiClientTypes {
 		Include extends TransactionInclude = {},
 	> extends GetTransactionOptions<Include> {
 		timeout?: number;
+		/** Absolute times (ms from start) to poll, e.g. [0, 300, 600, 1500]. After exhausted, repeats the last interval. */
+		pollSchedule?: number[];
 		result?: never;
 	}
 
@@ -413,6 +415,8 @@ export namespace SuiClientTypes {
 		result: TransactionResult<any>;
 		include?: Include & TransactionInclude;
 		timeout?: number;
+		/** Absolute times (ms from start) to poll, e.g. [0, 300, 600, 1500]. After exhausted, repeats the last interval. */
+		pollSchedule?: number[];
 		digest?: never;
 	}
 
@@ -464,6 +468,22 @@ export namespace SuiClientTypes {
 		systemState: SystemStateInfo;
 	}
 
+	export interface GetProtocolConfigOptions extends CoreClientMethodOptions {}
+
+	export interface TransportMethods {
+		getProtocolConfig?: (options?: GetProtocolConfigOptions) => Promise<GetProtocolConfigResponse>;
+	}
+
+	export interface GetProtocolConfigResponse {
+		protocolConfig: ProtocolConfig;
+	}
+
+	export interface ProtocolConfig {
+		protocolVersion: string;
+		featureFlags: Record<string, boolean>;
+		attributes: Record<string, string | null>;
+	}
+
 	export interface GetChainIdentifierOptions extends CoreClientMethodOptions {}
 
 	export interface TransportMethods {

package/src/graphql/core.ts

@@ -24,6 +24,7 @@ import {
 	GetCoinsDocument,
 	GetCurrentSystemStateDocument,
 	GetMoveFunctionDocument,
+	GetProtocolConfigDocument,
 	GetOwnedObjectsDocument,
 	GetReferenceGasPriceDocument,
 	GetTransactionBlockDocument,
@@ -453,6 +454,32 @@ export class GraphQLCoreClient extends CoreClient {
 		};
 	}
 
+	async getProtocolConfig(): Promise<SuiClientTypes.GetProtocolConfigResponse> {
+		const result = await this.#graphqlQuery(
+			{
+				query: GetProtocolConfigDocument,
+			},
+			(result) => result.epoch?.protocolConfigs,
+		);
+
+		const featureFlags: Record<string, boolean> = {};
+		for (const flag of result?.featureFlags ?? []) {
+			featureFlags[flag.key] = flag.value;
+		}
+		const attributes: Record<string, string | null> = {};
+		for (const config of result?.configs ?? []) {
+			attributes[config.key] = config.value ?? null;
+		}
+
+		return {
+			protocolConfig: {
+				protocolVersion: result?.protocolVersion?.toString() ?? (null as never),
+				featureFlags,
+				attributes,
+			},
+		};
+	}
+
 	async getCurrentSystemState(): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {
 		const result = await this.#graphqlQuery(
 			{

package/src/graphql/generated/queries.ts

@@ -4868,6 +4868,11 @@ export type GetMoveFunctionQueryVariables = Exact<{
 
 export type GetMoveFunctionQuery = { __typename?: 'Query', package?: { __typename?: 'MovePackage', module?: { __typename?: 'MoveModule', function?: { __typename?: 'MoveFunction', name: string, visibility?: MoveVisibility | null, isEntry?: boolean | null, typeParameters?: Array<{ __typename?: 'MoveFunctionTypeParameter', constraints: Array<MoveAbility> }> | null, parameters?: Array<{ __typename?: 'OpenMoveType', signature: OpenMoveTypeSignature }> | null, return?: Array<{ __typename?: 'OpenMoveType', signature: OpenMoveTypeSignature }> | null } | null } | null } | null };
 
+export type GetProtocolConfigQueryVariables = Exact<{ [key: string]: never; }>;
+
+
+export type GetProtocolConfigQuery = { __typename?: 'Query', epoch?: { __typename?: 'Epoch', protocolConfigs?: { __typename?: 'ProtocolConfigs', protocolVersion: number, featureFlags: Array<{ __typename?: 'FeatureFlag', key: string, value: boolean }>, configs: Array<{ __typename?: 'ProtocolConfig', key: string, value?: string | null }> } | null } | null };
+
 export type GetReferenceGasPriceQueryVariables = Exact<{ [key: string]: never; }>;
 
 
@@ -5402,6 +5407,23 @@ export const GetMoveFunctionDocument = new TypedDocumentString(`
   }
 }
     `) as unknown as TypedDocumentString<GetMoveFunctionQuery, GetMoveFunctionQueryVariables>;
+export const GetProtocolConfigDocument = new TypedDocumentString(`
+    query getProtocolConfig {
+  epoch {
+    protocolConfigs {
+      protocolVersion
+      featureFlags {
+        key
+        value
+      }
+      configs {
+        key
+        value
+      }
+    }
+  }
+}
+    `) as unknown as TypedDocumentString<GetProtocolConfigQuery, GetProtocolConfigQueryVariables>;
 export const GetReferenceGasPriceDocument = new TypedDocumentString(`
     query getReferenceGasPrice {
   epoch {

package/src/graphql/queries/getProtocolConfig.graphql

@@ -0,0 +1,18 @@
+# Copyright (c) Mysten Labs, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+query getProtocolConfig {
+	epoch {
+		protocolConfigs {
+			protocolVersion
+			featureFlags {
+				key
+				value
+			}
+			configs {
+				key
+				value
+			}
+		}
+	}
+}

package/src/grpc/core.ts

@@ -492,6 +492,33 @@ export class GrpcCoreClient extends CoreClient {
 		};
 	}
 
+	async getProtocolConfig(): Promise<SuiClientTypes.GetProtocolConfigResponse> {
+		const response = await this.#client.ledgerService.getEpoch({
+			readMask: { paths: ['protocol_config'] },
+		});
+
+		const protocolConfig = response.response.epoch?.protocolConfig;
+		if (!protocolConfig) {
+			throw new Error('Protocol config not found in response');
+		}
+
+		const featureFlags: Record<string, boolean> = { ...protocolConfig.featureFlags };
+		const attributes: Record<string, string | null> = {};
+		if (protocolConfig.attributes) {
+			for (const [key, value] of Object.entries(protocolConfig.attributes)) {
+				attributes[key] = value ?? null;
+			}
+		}
+
+		return {
+			protocolConfig: {
+				protocolVersion: protocolConfig.protocolVersion?.toString() ?? (null as never),
+				featureFlags,
+				attributes,
+			},
+		};
+	}
+
 	async getCurrentSystemState(): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {
 		const response = await this.#client.ledgerService.getEpoch({
 			readMask: {

package/src/jsonRpc/core.ts

@@ -457,6 +457,40 @@ export class JSONRpcCoreClient extends CoreClient {
 		};
 	}
 
+	async getProtocolConfig(
+		options?: SuiClientTypes.GetProtocolConfigOptions,
+	): Promise<SuiClientTypes.GetProtocolConfigResponse> {
+		const result = await this.#jsonRpcClient.getProtocolConfig({ signal: options?.signal });
+
+		const attributes: Record<string, string | null> = {};
+		for (const [key, value] of Object.entries(result.attributes)) {
+			if (value === null) {
+				attributes[key] = null;
+			} else if ('u16' in value) {
+				attributes[key] = value.u16;
+			} else if ('u32' in value) {
+				attributes[key] = value.u32;
+			} else if ('u64' in value) {
+				attributes[key] = value.u64;
+			} else if ('f64' in value) {
+				attributes[key] = value.f64;
+			} else if ('bool' in value) {
+				attributes[key] = value.bool;
+			} else {
+				const entries = Object.entries(value);
+				attributes[key] = entries.length === 1 ? String(entries[0][1]) : JSON.stringify(value);
+			}
+		}
+
+		return {
+			protocolConfig: {
+				protocolVersion: result.protocolVersion,
+				featureFlags: { ...result.featureFlags },
+				attributes,
+			},
+		};
+	}
+
 	async getCurrentSystemState(
 		options?: SuiClientTypes.GetCurrentSystemStateOptions,
 	): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {

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.9.1';
+export const PACKAGE_VERSION = '2.10.0';
 export const TARGETED_RPC_VERSION = '1.69.0';