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;