@mysten/docs 0.1.43 → 0.1.45

package/dist/sui/migrations/sui-2.0/kiosk.md

@@ -1,16 +1,17 @@
 # @mysten/kiosk
 
-> Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction.
+> Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
 
 This package now exports a client extension that integrates with Sui clients.
 
-> **Note:** The Kiosk SDK requires `SuiJsonRpcClient` or `SuiGraphQLClient`. It does not work with
-> `SuiGrpcClient` because it uses event queries that are not available in gRPC.
+> **Note:** The Kiosk SDK accepts `SuiGrpcClient`, `SuiGraphQLClient`, and other clients that implement
+> `ClientWithCoreApi`. Use `SuiGrpcClient` for new Kiosk code. The gRPC object API returns Display
+> v2 metadata; use GraphQL or JSON-RPC for object types that still rely on legacy Display metadata.
 
 ```diff
 - import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';
 - import { KioskClient, Network } from '@mysten/kiosk';
-+ import { SuiJsonRpcClient, getJsonRpcFullnodeUrl } from '@mysten/sui/jsonRpc'; // or SuiGraphQLClient
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 + import { kiosk } from '@mysten/kiosk';
 
 - const suiClient = new SuiClient({ url: getFullnodeUrl('mainnet') });
@@ -18,8 +19,8 @@ This package now exports a client extension that integrates with Sui clients.
 -   client: suiClient,
 -   network: Network.MAINNET,
 - });
-+ const client = new SuiJsonRpcClient({
-+   url: getJsonRpcFullnodeUrl('mainnet'),
++ const client = new SuiGrpcClient({
++   baseUrl: 'https://fullnode.mainnet.sui.io:443',
 +   network: 'mainnet',
 + }).$extend(kiosk());
 
@@ -100,14 +101,14 @@ The low-level helper functions have been removed in favor of the `KioskTransacti
 ```diff
 - import { createKiosk, shareKiosk, placeAndList } from '@mysten/kiosk';
 + import { kiosk, KioskTransaction } from '@mysten/kiosk';
-+ import { SuiJsonRpcClient, getJsonRpcFullnodeUrl } from '@mysten/sui/jsonRpc';
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 
 - const [kiosk, cap] = createKiosk(tx);
 - shareKiosk(tx, kiosk);
 - placeAndList(tx, itemType, kiosk, cap, item, price);
 
-+ const client = new SuiJsonRpcClient({
-+   url: getJsonRpcFullnodeUrl('mainnet'),
++ const client = new SuiGrpcClient({
++   baseUrl: 'https://fullnode.mainnet.sui.io:443',
 +   network: 'mainnet',
 + }).$extend(kiosk());
 +

package/dist/sui/migrations/sui-2.0/sdk-maintainers.md

@@ -1,6 +1,6 @@
 # SDK Maintainers
 
-> Migration guide for SDK maintainers and library authors upgrading to 2.0.
+> Migration guide for SDK maintainers and library authors upgrading to 2.0
 
 # Upgrading SDKs to @mysten/sui@2.0.0
 
@@ -10,8 +10,8 @@ For comprehensive SDK development patterns, see the [Building SDKs guide](/sui/s
 
 ## Use `ClientWithCoreApi`
 
-Accept `ClientWithCoreApi` instead of `SuiClient` to support all 3 Sui clients (JSON-RPC, GraphQL,
-gRPC):
+Accept `ClientWithCoreApi` instead of `SuiClient` so applications can pass a `SuiGrpcClient`,
+`SuiGraphQLClient`, or a legacy `SuiJsonRpcClient` during migration:
 
 ```diff
 - import { SuiClient } from '@mysten/sui/client';
@@ -24,7 +24,9 @@ gRPC):
 
 ## Access data through `client.core` methods
 
-All data access methods are namespaced under `client.core`:
+SDKs should access shared client methods through `client.core`. Application code can use the same
+methods at the top level of its concrete client, but `client.core` is the stable contract for
+libraries that should work across transports:
 
 ```diff
 - const result = await this.client.getObject({ objectId });
@@ -34,13 +36,17 @@ All data access methods are namespaced under `client.core`:
 + const result = await this.client.core.listOwnedObjects({ owner });
 ```
 
-| v1.x Method                      | v2.0 Method                       |
-| -------------------------------- | --------------------------------- |
-| `client.getObject()`             | `client.core.getObject()`         |
-| `client.getOwnedObjects()`       | `client.core.listOwnedObjects()`  |
-| `client.getDynamicFieldObject()` | `client.core.getDynamicField()`   |
-| `client.getDynamicFields()`      | `client.core.listDynamicFields()` |
-| `client.multiGetObjects()`       | `client.core.getObjects()`        |
+| v1.x Method                      | v2.0 Method                                                              |
+| -------------------------------- | ------------------------------------------------------------------------ |
+| `client.getObject()`             | `client.core.getObject()`                                                |
+| `client.getOwnedObjects()`       | `client.core.listOwnedObjects()`                                         |
+| `client.getDynamicFieldObject()` | `client.core.getDynamicField()` or `client.core.getDynamicObjectField()` |
+| `client.getDynamicFields()`      | `client.core.listDynamicFields()`                                        |
+| `client.multiGetObjects()`       | `client.core.getObjects()`                                               |
+
+Use `getDynamicField()` for regular dynamic fields and when you need the field entry or BCS-encoded
+value. Use `getDynamicObjectField()` only for dynamic object fields when you want the referenced
+child object returned directly.
 
 See the [Core API documentation](/sui/clients/core) for all available methods.
 

package/dist/sui/migrations/sui-2.0/sui.md

@@ -1,51 +1,63 @@
 # @mysten/sui
 
-> Migrate @mysten/sui from 1.x to 2.0 with new client APIs and BCS changes.
+> Migrate @mysten/sui from 1.x to 2.0 with gRPC clients, Core API, and BCS changes
 
 ## Removal of `SuiClient` exports
 
-The `@mysten/sui/client` export path has been removed. All JSON-RPC client functionality is now
-exported from `@mysten/sui/jsonRpc`.
+The old `SuiClient` export has been removed from `@mysten/sui/client`. For application code, migrate
+to [`SuiGrpcClient`](/sui/clients/grpc) and use top-level methods such as `client.getObject()`,
+`client.listCoins()`, and `client.signAndExecuteTransaction()`.
+
+Legacy JSON-RPC functionality moved to `@mysten/sui/jsonRpc`, but JSON-RPC APIs are deprecated in
+the Sui TypeScript SDK. Use the JSON-RPC exports only when maintaining code that still needs the old
+JSON-RPC method names or response shapes during migration.
 
 **Removed exports:**
 
-- `SuiClient` (use `SuiJsonRpcClient` instead)
-- `SuiClientOptions` (use `SuiJsonRpcClientOptions` instead)
-- `isSuiClient` (use `isSuiJsonRpcClient` instead)
-- `SuiTransport` (use `JsonRpcTransport` instead)
+- `SuiClient` (use `SuiGrpcClient`; legacy JSON-RPC code can use `SuiJsonRpcClient`)
+- `SuiClientOptions` (use `SuiGrpcClientOptions`; legacy JSON-RPC code can use
+  `SuiJsonRpcClientOptions`)
+- `isSuiClient` (use `isSuiGrpcClient`, `isSuiGraphQLClient`, or legacy `isSuiJsonRpcClient`)
+- `SuiTransport` (legacy JSON-RPC code can use `JsonRpcTransport`)
 - `SuiTransportRequestOptions` (use `JsonRpcTransportRequestOptions` instead)
-- `SuiTransportSubscribeOptions` (use `JsonRpcTransportSubscribeOptions` instead)
+- `SuiTransportSubscribeOptions` (removed; use the gRPC subscription service for streaming APIs)
 - `SuiHTTPTransportOptions` (use `JsonRpcHTTPTransportOptions` instead)
 - `SuiHTTPTransport` (use `JsonRpcHTTPTransport` instead)
-- `getFullnodeUrl` (use `getJsonRpcFullnodeUrl` instead)
+- `getFullnodeUrl` (pass the full node URL to `SuiGrpcClient.baseUrl`; legacy JSON-RPC code can use
+  `getJsonRpcFullnodeUrl`)
 - All JSON-RPC types (now exported from `@mysten/sui/jsonRpc`)
 
 **Migration:**
 
 ```diff
 - import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';
-+ import { SuiJsonRpcClient, getJsonRpcFullnodeUrl } from '@mysten/sui/jsonRpc';
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 
 - const client = new SuiClient({
 -   url: getFullnodeUrl('devnet'),
-+ const client = new SuiJsonRpcClient({
-+   url: getJsonRpcFullnodeUrl('devnet'),
++ const client = new SuiGrpcClient({
++   baseUrl: 'https://fullnode.devnet.sui.io:443',
     network: 'devnet',
   });
 ```
 
 ## Network parameter required
 
-When creating a new `SuiGraphQLClient` or `SuiJsonRpcClient`, you must now provide a `network`
-parameter:
+When creating a new `SuiGrpcClient`, `SuiGraphQLClient`, or legacy `SuiJsonRpcClient`, provide a
+`network` parameter:
 
 ```ts
-const client = new SuiGraphQLClient({
+const grpcClient = new SuiGrpcClient({
+	baseUrl: 'https://...',
+	network: 'mainnet', // Required
+});
+
+const graphqlClient = new SuiGraphQLClient({
 	url: 'https://...',
 	network: 'mainnet', // Required
 });
 
-const client = new SuiJsonRpcClient({
+const jsonRpcClient = new SuiJsonRpcClient({
 	url: 'https://...',
 	network: 'mainnet', // Required
 });
@@ -66,11 +78,12 @@ objects.
 + effects.status.Failure.error
 ```
 
-**Core API** (gRPC and GraphQL responses): Uses a simplified structure with a `success` boolean:
+**Core API and top-level client methods** (gRPC and GraphQL responses): Use a simplified structure
+with a `success` boolean:
 
 ```typescript
-// Core API returns this structure
-const result = await client.core.getTransaction({ digest, include: { effects: true } });
+// Top-level gRPC and GraphQL methods return this structure.
+const result = await client.getTransaction({ digest, include: { effects: true } });
 const tx = result.Transaction ?? result.FailedTransaction;
 
 if (tx.effects.status.success) {
@@ -223,7 +236,7 @@ resolution is now built directly into the core client.
 **How it works now:**
 
 MVR name resolution happens automatically during transaction building. The SDK detects `.move` names
-(like `@org/package::module::Type`) and resolves them using the client's MVR resolver.
+like `@org/package::module::Type` and resolves them using the client's MVR resolver.
 
 **Migration:**
 
@@ -238,11 +251,10 @@ MVR name resolution happens automatically during transaction building. The SDK d
 -   })
 - );
 
-+ import { SuiJsonRpcClient } from '@mysten/sui/jsonRpc';
-+ import type { NamedPackagesOverrides } from '@mysten/sui/client';
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 +
-+ const client = new SuiJsonRpcClient({
-+   url: 'https://fullnode.mainnet.sui.io:443',
++ const client = new SuiGrpcClient({
++   baseUrl: 'https://fullnode.mainnet.sui.io:443',
 +   network: 'mainnet',
 +   mvr: {
 +     overrides: myOverrides,
@@ -264,7 +276,8 @@ requiring `SuiJsonRpcClient` specifically.
 **Breaking changes:**
 
 - Constructor `client` parameter type changed from `SuiJsonRpcClient` to `ClientWithCoreApi`
-- Return type of `executeTransaction()`: `data` property renamed to `result`
+- Return type of `executeTransaction()` changed from the legacy `{ digest, effects, data }` wrapper
+  to a Core API `TransactionResult` discriminated union returned directly
 - The second parameter changed from JSON-RPC options to core API include options
 
 **Migration:**
@@ -272,7 +285,12 @@ requiring `SuiJsonRpcClient` specifically.
 ```diff
 
 - import { SuiJsonRpcClient } from '@mysten/sui/jsonRpc';
-+ // Works with any client: SuiJsonRpcClient, SuiGrpcClient, or SuiGraphQLClient
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
+
++ const client = new SuiGrpcClient({
++   baseUrl: 'https://fullnode.devnet.sui.io:443',
++   network: 'devnet',
++ });
 
 const executor = new SerialTransactionExecutor({
 -   client: jsonRpcClient,
@@ -282,10 +300,10 @@ const executor = new SerialTransactionExecutor({
 
 const result = await executor.executeTransaction(tx);
 
-// Accessing the transaction result (changed)
+// Accessing the transaction result now returned directly
 - console.log(result.data.effects?.status.status);
-+ const tx = result.Transaction ?? result.FailedTransaction;
-+ console.log(tx.effects.status.success);
++ const transaction = result.Transaction ?? result.FailedTransaction;
++ console.log(transaction.effects.status.success);
 ```
 
 Include options have also changed:

package/dist/sui/migrations/sui-2.0/suins.md

@@ -1,13 +1,13 @@
 # @mysten/suins
 
-> Migrate @mysten/suins to 2.0 with client extension pattern.
+> Migrate @mysten/suins to 2.0 with client extension pattern
 
 This package now exports a client extension that integrates with Sui clients.
 
 ```diff
 - import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';
 - import { SuinsClient } from '@mysten/suins';
-+ import { SuiGrpcClient } from '@mysten/sui/grpc'; // or SuiJsonRpcClient, SuiGraphQLClient
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 + import { suins } from '@mysten/suins';
 
 - const suiClient = new SuiClient({ url: getFullnodeUrl('mainnet') });

package/dist/sui/migrations/sui-2.0/walrus.md

@@ -1,6 +1,6 @@
 # @mysten/walrus
 
-> Migrate @mysten/walrus to 2.0 with required client parameter and updated API.
+> Migrate @mysten/walrus to 2.0 with required client parameter and updated API
 
 ## Breaking changes
 
@@ -17,7 +17,7 @@ If you were creating `WalrusClient` directly:
 
 ```diff
 - import { WalrusClient } from '@mysten/walrus';
-+ import { SuiGrpcClient } from '@mysten/sui/grpc'; // or SuiJsonRpcClient, SuiGraphQLClient
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 + import { walrus } from '@mysten/walrus';
 
 - const walrusClient = new WalrusClient({
@@ -30,7 +30,7 @@ If you were creating `WalrusClient` directly:
 + }).$extend(walrus());
 
 - await walrusClient.getBlob(blobId);
-+ await client.walrus.getBlob(blobId);
++ await client.walrus.getBlob({ blobId });
 ```
 
 If you were passing `network` to `walrus()`, remove it:

package/dist/sui/migrations/sui-2.0/zksend.md

@@ -1,9 +1,9 @@
 # @mysten/zksend
 
-> Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API.
+> Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API
 
-This package now exports a client extension that integrates with Sui clients, enabling compatibility
-with gRPC, GraphQL, and JSON RPC transports.
+This package now exports a client extension that integrates with Sui clients through the Core API.
+Use `SuiGrpcClient` for most applications.
 
 ## Breaking changes
 
@@ -23,7 +23,7 @@ Update your code to use the client extension:
 ```diff
 - import { ZkSendLinkBuilder, ZkSendLink } from '@mysten/zksend';
 + import { zksend } from '@mysten/zksend';
-+ import { SuiGrpcClient } from '@mysten/sui/grpc'; // or SuiJsonRpcClient, SuiGraphQLClient
++ import { SuiGrpcClient } from '@mysten/sui/grpc';
 
 + const client = new SuiGrpcClient({
 +   baseUrl: 'https://fullnode.testnet.sui.io:443',
@@ -84,12 +84,13 @@ const linkBuilder = client.zksend.linkBuilder({
 });
 
 // Add assets to the link
-linkBuilder.addSui(1_000_000_000n); // 1 SUI
+linkBuilder.addClaimableMist(1_000_000_000n); // 1 SUI
 
-// Create the transaction
-const { tx, link } = await linkBuilder.build();
+// Create the transaction and get the claim URL
+const tx = await linkBuilder.createSendTransaction();
+const linkUrl = linkBuilder.getLink();
 
 // Later, load an existing link
 const existingLink = await client.zksend.loadLinkFromUrl(linkUrl);
-const assets = await existingLink.getAssets();
+const assets = existingLink.assets;
 ```

package/dist/sui/sdk-building.md

@@ -1,14 +1,16 @@
 # Building SDKs
 
-> Build custom SDKs on top of the Sui TypeScript SDK.
+> Build custom SDKs on top of the Sui TypeScript SDK
 
 This guide covers recommended patterns for building TypeScript SDKs that integrate with the Sui SDK.
-Following these patterns ensures your SDK integrates seamlessly with the ecosystem, works across
-different transports (JSON-RPC, GraphQL, gRPC), and composes well with other SDKs.
+Following these patterns ensures your SDK integrates seamlessly with the ecosystem, works with
+`SuiGrpcClient` and `SuiGraphQLClient` through the shared Core API, and composes well with other
+SDKs. Legacy JSON-RPC clients can also be supported during migration because they implement the same
+Core API contract.
 
 All SDKs should depend on [`ClientWithCoreApi`](./clients/core), which is the transport-agnostic
-interface implemented by all Sui clients. This ensures your SDK works with any client the user
-chooses.
+interface implemented by Sui clients. This lets application code choose one concrete client and use
+top-level methods, while SDK internals use `client.core` for portable reads, writes, and queries.
 
 ## Package setup
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mysten/docs",
-  "version": "0.1.43",
+  "version": "0.1.45",
   "description": "LLM-friendly documentation for the Sui TypeScript SDK ecosystem",
   "license": "Apache-2.0",
   "repository": {
@@ -28,28 +28,28 @@
     "next": "^16.2.12",
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
-    "@mysten/aws-kms-signer": "0.3.9",
     "@mysten/bcs": "2.1.0",
-    "@mysten/dapp-kit-core": "1.6.12",
-    "@mysten/dapp-kit": "1.1.12",
-    "@mysten/dapp-kit-react": "2.1.14",
-    "@mysten/enoki-connect": "1.1.12",
-    "@mysten/deepbook-v3": "1.6.2",
-    "@mysten/kiosk": "1.3.12",
-    "@mysten/gcp-kms-signer": "0.2.12",
-    "@mysten/ledger-signer": "0.2.12",
-    "@mysten/enoki": "1.2.10",
-    "@mysten/seal": "1.3.7",
-    "@mysten/signers": "1.1.12",
-    "@mysten/slush-wallet": "1.1.12",
-    "@mysten/payment-kit": "0.2.12",
-    "@mysten/sui": "2.23.1",
-    "@mysten/suins": "1.2.12",
+    "@mysten/aws-kms-signer": "0.3.11",
+    "@mysten/dapp-kit": "1.1.14",
+    "@mysten/dapp-kit-react": "2.1.16",
+    "@mysten/dapp-kit-core": "1.6.14",
+    "@mysten/deepbook-v3": "1.6.4",
+    "@mysten/gcp-kms-signer": "0.2.14",
+    "@mysten/enoki-connect": "1.1.14",
+    "@mysten/kiosk": "1.4.0",
+    "@mysten/enoki": "1.2.12",
+    "@mysten/payment-kit": "0.2.14",
+    "@mysten/seal": "1.4.0",
+    "@mysten/ledger-signer": "0.2.14",
+    "@mysten/signers": "1.1.14",
+    "@mysten/sui": "2.24.0",
+    "@mysten/slush-wallet": "1.1.14",
+    "@mysten/suins": "1.2.14",
     "@mysten/utils": "0.4.0",
-    "@mysten/wallet-standard": "0.21.12",
-    "@mysten/webcrypto-signer": "0.2.12",
-    "@mysten/zksend": "1.2.12",
-    "@mysten/walrus": "1.2.12"
+    "@mysten/wallet-standard": "0.21.14",
+    "@mysten/walrus": "1.2.14",
+    "@mysten/zksend": "1.2.14",
+    "@mysten/webcrypto-signer": "0.2.14"
   },
   "devDependencies": {
     "@tailwindcss/postcss": "^4.3.1",