Migrate suins to sdk-v2

Author: hayes-mysten

.changeset/suins-client-with-core-api.md

@@ -0,0 +1,31 @@
+---
+'@mysten/suins': major
+---
+
+Update SuinsClient to use ClientWithCoreApi for transport-agnostic client support (JSON-RPC, GraphQL, gRPC).
+
+**Breaking changes:**
+
+- `SuinsClient` now requires a client implementing `ClientWithCoreApi` instead of `SuiClient`
+- Package ID extraction now correctly uses `upgrade_cap.package` from state objects instead of object type
+
+**Migration:**
+
+```diff
+- import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';
++ import { SuiJsonRpcClient, getJsonRpcFullnodeUrl } from '@mysten/sui/jsonRpc';
+  import { SuinsClient } from '@mysten/suins';
+
+- const suiClient = new SuiClient({ url: getFullnodeUrl('mainnet') });
++ const suiClient = new SuiJsonRpcClient({
++   url: getJsonRpcFullnodeUrl('mainnet'),
++   network: 'mainnet',
++ });
+
+  const suinsClient = new SuinsClient({
+    client: suiClient,
+    network: 'mainnet',
+  });
+```
+
+This change allows SuinsClient to work with any Sui client implementation (JSON-RPC, GraphQL, or gRPC).

packages/docs/content/sui/migrations/sui-2.0.mdx

@@ -387,3 +387,51 @@ If you were using the plugin with `@mysten/mvr-static`:
 
 The client will now automatically resolve `.move` names in transactions using the configured
 overrides or by querying the MVR API if no override is provided.
+
+## @mysten/suins: ClientWithCoreApi Support
+
+The `@mysten/suins` package now uses the transport-agnostic `ClientWithCoreApi` interface, allowing
+it to work with any Sui client implementation (JSON-RPC, GraphQL, or gRPC).
+
+**Breaking changes:**
+
+- `SuinsClient` now requires a client implementing `ClientWithCoreApi` instead of `SuiClient`
+- Internal package ID resolution now correctly extracts `upgrade_cap.package` from state objects
+
+**Migration:**
+
+Update your imports and client initialization:
+
+```diff
+- import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';
++ import { SuiJsonRpcClient, getJsonRpcFullnodeUrl } from '@mysten/sui/jsonRpc';
+  import { SuinsClient } from '@mysten/suins';
+
+- const suiClient = new SuiClient({ url: getFullnodeUrl('mainnet') });
++ const suiClient = new SuiJsonRpcClient({
++   url: getJsonRpcFullnodeUrl('mainnet'),
++   network: 'mainnet',
++ });
+
+  const suinsClient = new SuinsClient({
+    client: suiClient,
+    network: 'mainnet',
+  });
+```
+
+You can also use GraphQL or gRPC clients:
+
+```ts
+import { SuiGraphQLClient } from '@mysten/sui/graphql';
+import { SuinsClient } from '@mysten/suins';
+
+const graphqlClient = new SuiGraphQLClient({
+	url: 'https://sui-mainnet.mystenlabs.com/graphql',
+	network: 'mainnet',
+});
+
+const suinsClient = new SuinsClient({
+	client: graphqlClient,
+	network: 'mainnet',
+});
+```

packages/sui/src/client/core.ts

@@ -8,6 +8,7 @@ import { normalizeStructTag, parseStructTag, SUI_ADDRESS_LENGTH } from '../utils
 import { BaseClient } from './client.js';
 import type { ClientWithExtensions, SuiClientTypes } from './types.js';
 import { MvrClient } from './mvr.js';
+import { bcs } from '../bcs/index.js';
 
 export type ClientWithCoreApi = ClientWithExtensions<{
 	core: CoreClient;
@@ -163,6 +164,34 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		};
 	}
 
+	async getDynamicObjectField<Include extends SuiClientTypes.ObjectInclude = object>(
+		options: SuiClientTypes.GetDynamicObjectFieldOptions<Include>,
+	): Promise<SuiClientTypes.GetDynamicObjectFieldResponse<Include>> {
+		const resolvedNameType = (
+			await this.core.mvr.resolveType({
+				type: options.name.type,
+			})
+		).type;
+		const wrappedType = `0x2::dynamic_object_field::Wrapper<${resolvedNameType}>`;
+
+		const { dynamicField } = await this.getDynamicField({
+			parentId: options.parentId,
+			name: {
+				type: wrappedType,
+				bcs: options.name.bcs,
+			},
+			signal: options.signal,
+		});
+
+		const { object } = await this.getObject({
+			objectId: bcs.Address.parse(dynamicField.value.bcs),
+			signal: options.signal,
+			include: options.include,
+		});
+
+		return { object };
+	}
+
 	async waitForTransaction<Include extends SuiClientTypes.TransactionInclude = object>({
 		signal,
 		timeout = 60 * 1000,

packages/sui/src/client/types.ts

@@ -166,6 +166,18 @@ export namespace SuiClientTypes {
 		};
 	}
 
+	export interface GetDynamicObjectFieldOptions<
+		Include extends ObjectInclude = {},
+	> extends CoreClientMethodOptions {
+		parentId: string;
+		name: DynamicFieldName;
+		include?: Include;
+	}
+
+	export interface GetDynamicObjectFieldResponse<out Include extends ObjectInclude = {}> {
+		object: Object<Include>;
+	}
+
 	export interface DynamicFieldName {
 		type: string;
 		bcs: Uint8Array;

packages/suins/package.json

@@ -27,6 +27,7 @@
 		"src"
 	],
 	"scripts": {
+		"codegen": "sui-ts-codegen generate && pnpm lint:fix",
 		"clean": "rm -rf tsconfig.tsbuildinfo ./dist",
 		"build": "build-package",
 		"prettier:check": "prettier -c --ignore-unknown .",
@@ -47,6 +48,7 @@
 	},
 	"devDependencies": {
 		"@mysten/build-scripts": "workspace:*",
+		"@mysten/codegen": "workspace:*",
 		"@types/tmp": "^0.2.6",
 		"ts-retry-promise": "^0.8.1",
 		"typescript": "^5.9.3",

packages/suins/src/contracts/pyth/batch_price_attestation.ts

@@ -0,0 +1,102 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+import * as price_info from './price_info.js';
+const $moduleName =
+	'0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837::batch_price_attestation';
+export const Header = new MoveStruct({
+	name: `${$moduleName}::Header`,
+	fields: {
+		magic: bcs.u64(),
+		version_major: bcs.u64(),
+		version_minor: bcs.u64(),
+		header_size: bcs.u64(),
+		payload_id: bcs.u8(),
+	},
+});
+export const BatchPriceAttestation = new MoveStruct({
+	name: `${$moduleName}::BatchPriceAttestation`,
+	fields: {
+		header: Header,
+		attestation_size: bcs.u64(),
+		attestation_count: bcs.u64(),
+		price_infos: bcs.vector(price_info.PriceInfo),
+	},
+});
+export interface DestroyOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>];
+}
+export function destroy(options: DestroyOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		`${packageAddress}::batch_price_attestation::BatchPriceAttestation`,
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'batch_price_attestation',
+			function: 'destroy',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}
+export interface GetAttestationCountOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>];
+}
+export function getAttestationCount(options: GetAttestationCountOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		`${packageAddress}::batch_price_attestation::BatchPriceAttestation`,
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'batch_price_attestation',
+			function: 'get_attestation_count',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}
+export interface GetPriceInfoOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>, RawTransactionArgument<number | bigint>];
+}
+export function getPriceInfo(options: GetPriceInfoOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		`${packageAddress}::batch_price_attestation::BatchPriceAttestation`,
+		'u64',
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'batch_price_attestation',
+			function: 'get_price_info',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}
+export interface DeserializeOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<number[]>];
+}
+export function deserialize(options: DeserializeOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		'vector<u8>',
+		'0x0000000000000000000000000000000000000000000000000000000000000002::clock::Clock',
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'batch_price_attestation',
+			function: 'deserialize',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}

packages/suins/src/contracts/pyth/contract_upgrade.ts

@@ -0,0 +1,60 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+import * as bytes32 from './deps/0xf47329f4344f3bf0f8e436e2f7b485466cff300f12a166563995d3888c296a94/bytes32.js';
+const $moduleName =
+	'0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837::contract_upgrade';
+export const ContractUpgraded = new MoveStruct({
+	name: `${$moduleName}::ContractUpgraded`,
+	fields: {
+		old_contract: bcs.Address,
+		new_contract: bcs.Address,
+	},
+});
+export const UpgradeContract = new MoveStruct({
+	name: `${$moduleName}::UpgradeContract`,
+	fields: {
+		digest: bytes32.Bytes32,
+	},
+});
+export interface AuthorizeUpgradeOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>, RawTransactionArgument<string>];
+}
+export function authorizeUpgrade(options: AuthorizeUpgradeOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		`${packageAddress}::state::State`,
+		`${packageAddress}::governance::WormholeVAAVerificationReceipt`,
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'contract_upgrade',
+			function: 'authorize_upgrade',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}
+export interface CommitUpgradeOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>, RawTransactionArgument<string>];
+}
+export function commitUpgrade(options: CommitUpgradeOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		`${packageAddress}::state::State`,
+		'0x0000000000000000000000000000000000000000000000000000000000000002::package::UpgradeReceipt',
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'contract_upgrade',
+			function: 'commit_upgrade',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}

packages/suins/src/contracts/pyth/data_source.ts

@@ -0,0 +1,67 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+import * as external_address from './deps/0xf47329f4344f3bf0f8e436e2f7b485466cff300f12a166563995d3888c296a94/external_address.js';
+const $moduleName =
+	'0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837::data_source';
+export const DataSource = new MoveStruct({
+	name: `${$moduleName}::DataSource`,
+	fields: {
+		emitter_chain: bcs.u64(),
+		emitter_address: external_address.ExternalAddress,
+	},
+});
+export interface ContainsOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>, RawTransactionArgument<string>];
+}
+export function contains(options: ContainsOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [
+		'0x0000000000000000000000000000000000000000000000000000000000000002::object::UID',
+		`${packageAddress}::data_source::DataSource`,
+	] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'data_source',
+			function: 'contains',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}
+export interface EmitterChainOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>];
+}
+export function emitterChain(options: EmitterChainOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [`${packageAddress}::data_source::DataSource`] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'data_source',
+			function: 'emitter_chain',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}
+export interface EmitterAddressOptions {
+	package?: string;
+	arguments: [RawTransactionArgument<string>];
+}
+export function emitterAddress(options: EmitterAddressOptions) {
+	const packageAddress =
+		options.package ?? '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837';
+	const argumentsTypes = [`${packageAddress}::data_source::DataSource`] satisfies string[];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'data_source',
+			function: 'emitter_address',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes),
+		});
+}