@mysten/docs 0.1.17 → 0.1.19

package/dist/sui/migrations/sui-2.0/json-rpc-migration.md

@@ -1,6 +1,6 @@
 # Migrating from JSON-RPC
 
-> Migrate from JSON-RPC to the new Core API
+> Migrate from JSON-RPC to the new Core API using SuiGrpcClient or SuiGraphQLClient.
 
 This guide covers migrating from `SuiJsonRpcClient` to the new client APIs. The JSON-RPC API is
 being deprecated in favor of `SuiGrpcClient` and `SuiGraphQLClient`.
@@ -8,14 +8,14 @@ being deprecated in favor of `SuiGrpcClient` and `SuiGraphQLClient`.
 > **Note:** We recommend using `SuiGrpcClient` for most operations and `SuiGraphQLClient` for complex queries
 > like filtering transactions and events.
 
-## Choosing a Client
+## Choosing a client
 
 | Client             | Best For                                                        |
 | ------------------ | --------------------------------------------------------------- |
 | `SuiGrpcClient`    | Most operations, SDK integrations, real-time data               |
 | `SuiGraphQLClient` | Complex queries, filtering transactions/events, historical data |
 
-## Quick Migration to gRPC
+## Quick migration to gRPC
 
 For most use cases, migrate to `SuiGrpcClient`:
 
@@ -35,13 +35,13 @@ For most use cases, migrate to `SuiGrpcClient`:
 
 Both clients use the same full node URLs, so you can use the same endpoint when migrating.
 
-## Core API Methods
+## Core API methods
 
 The gRPC client should work with almost all mysten SDKs as a drop in replacement for the JSON-RPC
 client. When using the client directly, the methods and data returned will not be exactly the same
 as what was available in JSON-RPC.
 
-## Methods Replaced by Core API
+## Methods replaced by core API
 
 These JSON-RPC methods have direct replacements in the core API:
 
@@ -88,28 +88,28 @@ These JSON-RPC methods have direct replacements in the core API:
 + });
 ```
 
-## Methods Replaced by gRPC Services
+## Methods replaced by gRPC services
 
 These JSON-RPC methods can be replaced by calling gRPC service clients directly:
 
-| JSON-RPC Method                     | gRPC Service Replacement          |
-| ----------------------------------- | --------------------------------- |
-| `getCheckpoint`                     | `ledgerService.getCheckpoint`     |
-| `getCheckpoints`                    | `ledgerService.listCheckpoints`   |
-| `getLatestCheckpointSequenceNumber` | `ledgerService.getCheckpoint`     |
-| `getEpochs`                         | `ledgerService.listEpochs`        |
-| `getCurrentEpoch`                   | `ledgerService.getEpoch`          |
-| `getLatestSuiSystemState`           | `ledgerService.getSystemState`    |
-| `getCommitteeInfo`                  | `ledgerService.getCommittee`      |
-| `getValidatorsApy`                  | `ledgerService.getValidators`     |
-| `getProtocolConfig`                 | `ledgerService.getProtocolConfig` |
-| `getNormalizedMoveModule`           | `movePackageService.getModule`    |
-| `getNormalizedMoveModulesByPackage` | `movePackageService.getPackage`   |
-| `getNormalizedMoveStruct`           | `movePackageService.getStruct`    |
-| `resolveNameServiceAddress`         | `nameService.lookupName`          |
-| `resolveNameServiceNames`           | `nameService.reverseLookupName`   |
-
-### Example: Using gRPC Service Clients
+| JSON-RPC Method                     | gRPC Service Replacement                                        |
+| ----------------------------------- | --------------------------------------------------------------- |
+| `getCheckpoint`                     | `ledgerService.getCheckpoint`                                   |
+| `getCheckpoints`                    | `ledgerService.listCheckpoints`                                 |
+| `getLatestCheckpointSequenceNumber` | `ledgerService.getCheckpoint`                                   |
+| `getEpochs`                         | `ledgerService.listEpochs`                                      |
+| `getCurrentEpoch`                   | `ledgerService.getEpoch`                                        |
+| `getLatestSuiSystemState`           | `ledgerService.getSystemState`                                  |
+| `getCommitteeInfo`                  | `ledgerService.getCommittee`                                    |
+| `getValidatorsApy`                  | `ledgerService.getValidators`                                   |
+| `getProtocolConfig`                 | `ledgerService.getProtocolConfig`                               |
+| `getNormalizedMoveModule`           | `movePackageService.getPackage` (response includes all modules) |
+| `getNormalizedMoveModulesByPackage` | `movePackageService.getPackage`                                 |
+| `getNormalizedMoveStruct`           | `movePackageService.getDatatype`                                |
+| `resolveNameServiceAddress`         | `nameService.lookupName`                                        |
+| `resolveNameServiceNames`           | `nameService.reverseLookupName`                                 |
+
+### Example: using gRPC service clients
 
 ```typescript
 
@@ -126,10 +126,16 @@ const { response } = await client.ledgerService.getCheckpoint({
 // Get current epoch
 const { response: epoch } = await client.ledgerService.getEpoch({});
 
-// Get Move module information
-const { response: module } = await client.movePackageService.getModule({
+// Get Move package information (includes all modules)
+const { response: pkg } = await client.movePackageService.getPackage({
+	packageId: '0x2',
+});
+
+// Get a specific Move datatype (struct or enum)
+const { response: datatype } = await client.movePackageService.getDatatype({
 	packageId: '0x2',
 	moduleName: 'coin',
+	name: 'Coin',
 });
 
 // Resolve SuiNS name
@@ -138,7 +144,7 @@ const { response: address } = await client.nameService.lookupName({
 });
 ```
 
-## Methods Requiring GraphQL
+## Methods requiring GraphQL
 
 Some JSON-RPC methods don't have gRPC equivalents and require using `SuiGraphQLClient` instead:
 
@@ -156,7 +162,7 @@ Some JSON-RPC methods don't have gRPC equivalents and require using `SuiGraphQLC
 | `getAddressMetrics`         | Use indexer                        |
 | `getMoveCallMetrics`        | Use indexer                        |
 
-### Setting Up GraphQL Client
+### Setting up GraphQL client
 
 ```typescript
 
@@ -166,7 +172,7 @@ const graphqlClient = new SuiGraphQLClient({
 });
 ```
 
-### Querying Transactions
+### Querying transactions
 
 Replace `queryTransactionBlocks` with a GraphQL query:
 
@@ -202,14 +208,14 @@ const result = await graphqlClient.query({
 
 **Available transaction filters:**
 
-- `sentAddress` - Filter by sender address
-- `affectedAddress` - Filter by any address involved in the transaction
-- `affectedObject` - Filter by object ID that was affected
-- `function` - Filter by Move function called (e.g., `0x2::coin::transfer`)
-- `kind` - Filter by transaction kind (`SYSTEM` or `PROGRAMMABLE`)
+- `sentAddress`: Filter by sender address
+- `affectedAddress`: Filter by any address involved in the transaction
+- `affectedObject`: Filter by object ID that was affected
+- `function`: Filter by Move function called (for example, `0x2::coin::transfer`)
+- `kind`: Filter by transaction kind (`SYSTEM` or `PROGRAMMABLE`)
 - `atCheckpoint` / `beforeCheckpoint` / `afterCheckpoint` - Filter by checkpoint
 
-### Querying Events
+### Querying events
 
 Replace `queryEvents` with a GraphQL query:
 
@@ -249,12 +255,12 @@ const result = await graphqlClient.query({
 
 **Available event filters:**
 
-- `type` - Filter by event type (package, package::module, or full type)
-- `module` - Filter by emitting module
-- `sender` - Filter by transaction sender
-- `atCheckpoint` / `beforeCheckpoint` / `afterCheckpoint` - Filter by checkpoint
+- `type`: Filter by event type (package, package::module, or full type)
+- `module`: Filter by emitting module
+- `sender`: Filter by transaction sender
+- `atCheckpoint` / `beforeCheckpoint` / `afterCheckpoint`: Filter by checkpoint
 
-### Fetching Multiple Transactions
+### Fetching multiple transactions
 
 Replace `multiGetTransactionBlocks` with a GraphQL query:
 
@@ -278,7 +284,7 @@ const result = await graphqlClient.query({
 });
 ```
 
-### Querying Historical Objects
+### Querying historical objects
 
 Replace `tryGetPastObject` with a GraphQL query specifying a version:
 
@@ -306,7 +312,7 @@ const result = await graphqlClient.query({
 });
 ```
 
-### Querying Coin Metadata
+### Querying coin metadata
 
 Replace `getCoinMetadata` and `getTotalSupply` with a GraphQL query:
 
@@ -330,7 +336,7 @@ const result = await graphqlClient.query({
 });
 ```
 
-### Querying Staked SUI
+### Querying staked SUI
 
 Replace `getStakes` with a GraphQL query:
 
@@ -358,10 +364,10 @@ const result = await graphqlClient.query({
 });
 ```
 
-## Response Format Differences
+## Response format differences
 
 The gRPC client uses the core API response format, which differs from JSON-RPC responses. See the
-[@mysten/sui migration guide](/sui/migrations/sui-2.0/sui#transaction-executors-now-accept-any-client)
+[`@mysten/sui` migration guide](/sui/migrations/sui-2.0/sui#transaction-executors-now-accept-any-client)
 for details on the new response format.
 
 Key differences:
@@ -377,7 +383,7 @@ Key differences:
 + { effects: true, events: true }
 ```
 
-## Client Extensions
+## Client extensions
 
 Client extensions work the same way with both clients:
 
@@ -393,7 +399,7 @@ await client.deepbook.checkManagerBalance(manager, asset);
 await client.suins.getName('0xabc...');
 ```
 
-## See Also
+## See also
 
 - [SuiGrpcClient Documentation](/sui/clients/grpc) - Full gRPC client documentation
 - [SuiGraphQLClient Documentation](/sui/clients/graphql) - GraphQL client documentation

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

@@ -1,6 +1,6 @@
 # @mysten/kiosk
 
-> Migrate @mysten/kiosk to 2.0
+> Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction.
 
 This package now exports a client extension that integrates with Sui clients.
 
@@ -27,7 +27,7 @@ This package now exports a client extension that integrates with Sui clients.
 + const ownedKiosks = await client.kiosk.getOwnedKiosks({ address: myAddress });
 ```
 
-## Removed: transactionBlock Parameter
+## Removed: `transactionBlock` parameter
 
 The deprecated `transactionBlock` parameter has been removed from `KioskTransaction`,
 `TransferPolicyTransaction`, and rule resolving functions. Use `transaction` instead:
@@ -48,12 +48,12 @@ const tpTx = new TransferPolicyTransaction({
 });
 ```
 
-## Removed: Low-Level Helper Functions
+## Removed: low-level helper functions
 
 The low-level helper functions have been removed in favor of the `KioskTransaction` and
 `TransferPolicyTransaction` builder classes.
 
-### Kiosk Functions
+### Kiosk functions
 
 | Removed Function    | Use Instead              |
 | ------------------- | ------------------------ |
@@ -70,7 +70,7 @@ The low-level helper functions have been removed in favor of the `KioskTransacti
 | `borrowValue`       | `kioskTx.borrow()`       |
 | `returnValue`       | `kioskTx.return()`       |
 
-### Transfer Policy Functions
+### Transfer policy functions
 
 | Removed Function                     | Use Instead                                             |
 | ------------------------------------ | ------------------------------------------------------- |
@@ -79,14 +79,14 @@ The low-level helper functions have been removed in favor of the `KioskTransacti
 | `confirmRequest`                     | Handled automatically by `kioskTx.purchaseAndResolve()` |
 | `removeTransferPolicyRule`           | `tpTx.removeRule()`                                     |
 
-### Personal Kiosk Functions
+### Personal Kiosk functions
 
 | Removed Function        | Use Instead                                   |
 | ----------------------- | --------------------------------------------- |
 | `convertToPersonalTx`   | `kioskTx.convertToPersonal()`                 |
 | `transferPersonalCapTx` | Handled automatically by `kioskTx.finalize()` |
 
-### Rule Attachment Functions
+### Rule attachment functions
 
 | Removed Function            | Use Instead                   |
 | --------------------------- | ----------------------------- |
@@ -95,7 +95,7 @@ The low-level helper functions have been removed in favor of the `KioskTransacti
 | `attachPersonalKioskRuleTx` | `tpTx.addPersonalKioskRule()` |
 | `attachFloorPriceRuleTx`    | `tpTx.addFloorPriceRule()`    |
 
-## Migration Example
+## Migration example
 
 ```diff
 - import { createKiosk, shareKiosk, placeAndList } from '@mysten/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
+> Migration guide for SDK maintainers and library authors upgrading to 2.0.
 
 # Upgrading SDKs to @mysten/sui@2.0.0
 
@@ -22,7 +22,7 @@ gRPC):
 }
 ```
 
-## Access Data via `client.core` methods
+## Access data through `client.core` methods
 
 All data access methods are namespaced under `client.core`:
 
@@ -44,7 +44,7 @@ All data access methods are namespaced under `client.core`:
 
 See the [Core API documentation](/sui/clients/core) for all available methods.
 
-## Use Peer Dependencies
+## Use peer dependencies
 
 Declare `@mysten/*` packages as peer dependencies:
 
@@ -59,7 +59,7 @@ Declare `@mysten/*` packages as peer dependencies:
 }
 ```
 
-## Client Extensions
+## Client extensions
 
 v2.0 introduces client extensions that let users add your SDK to any Sui client:
 
@@ -81,10 +81,10 @@ await client.mySDK.doSomething();
 See the [Building SDKs guide](/sui/sdk-building#client-extensions) for the complete extension
 pattern.
 
-## Code Generation
+## Code generation
 
-Use **[@mysten/codegen](/codegen)** to generate type-safe TypeScript bindings from your Move
-packages. See the [codegen documentation](/codegen) for setup instructions.
+Use [`@mysten/codegen`](/codegen) to generate type-safe TypeScript bindings from your Move packages.
+See the [codegen documentation](/codegen) for setup instructions.
 
 For complete SDK development patterns including client extensions, transaction thunks, and best
 practices, see the [Building SDKs guide](/sui/sdk-building).

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

@@ -1,6 +1,6 @@
 # @mysten/seal
 
-> Migrate @mysten/seal to 2.0
+> Migrate @mysten/seal to 2.0 with the new registration function pattern.
 
 The deprecated `SealClient.asClientExtension()` static method has been removed. Use the `seal()`
 registration function instead:

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

@@ -1,8 +1,8 @@
 # @mysten/sui
 
-> Migrate @mysten/sui from 1.x to 2.0
+> Migrate @mysten/sui from 1.x to 2.0 with new client APIs and BCS changes.
 
-## Removal of SuiClient Exports
+## 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`.
@@ -34,7 +34,7 @@ exported from `@mysten/sui/jsonRpc`.
   });
 ```
 
-## Network Parameter Required
+## Network parameter required
 
 When creating a new `SuiGraphQLClient` or `SuiJsonRpcClient`, you must now provide a `network`
 parameter:
@@ -51,13 +51,13 @@ const client = new SuiJsonRpcClient({
 });
 ```
 
-## BCS Schema Changes
+## BCS schema changes
 
 Several BCS schemas in `@mysten/sui/bcs` have been updated to align exactly with the Rust
 implementation. These changes affect serialization and deserialization of transaction effects and
 objects.
 
-### ExecutionStatus Changes
+### `ExecutionStatus` changes
 
 **BCS Schema** (when parsing raw effects): The variant was renamed from `Failed` to `Failure`:
 
@@ -66,7 +66,7 @@ objects.
 + effects.status.Failure.error
 ```
 
-**Core API** (gRPC/GraphQL responses): Uses a simplified structure with a `success` boolean:
+**Core API** (gRPC and GraphQL responses): Uses a simplified structure with a `success` boolean:
 
 ```typescript
 // Core API returns this structure
@@ -80,7 +80,7 @@ if (tx.effects.status.success) {
 }
 ```
 
-### Object BCS Schema Changes
+### Object BCS schema changes
 
 Several changes to object BCS schemas:
 
@@ -107,7 +107,7 @@ const data = {
 **This affects serialization.** Any existing serialized data with `ConsensusV2` will need to be
 re-serialized with the new `ConsensusAddressOwner` variant.
 
-### UnchangedSharedKind to UnchangedConsensusKind
+### `UnchangedSharedKind` to `UnchangedConsensusKind`
 
 Transaction effects field renamed:
 
@@ -122,7 +122,7 @@ Transaction effects field renamed:
 **New variants:** `MutateConsensusStreamEnded`, `ReadConsensusStreamEnded`, `Cancelled`,
 `PerEpochConfig`
 
-## Experimental Client API Stabilization
+## Experimental client API stabilization
 
 The experimental client API has been stabilized and moved from `@mysten/sui/experimental` to
 `@mysten/sui/client`. All `Experimental_` prefixes have been removed.
@@ -171,7 +171,7 @@ The experimental client API has been stabilized and moved from `@mysten/sui/expe
 | `Experimental_SuiClientTypes`    | `SuiClientTypes`    |
 | `Experimental_CoreClientOptions` | `CoreClientOptions` |
 
-## Commands Renamed to TransactionCommands
+## Commands renamed to `TransactionCommands`
 
 The `Commands` type exported from `@mysten/sui/transactions` has been renamed to
 `TransactionCommands` because `Commands` is a reserved keyword in React Native.
@@ -187,7 +187,7 @@ The `Commands` type exported from `@mysten/sui/transactions` has been renamed to
 + tx.add(TransactionCommands.TransferObjects([coin], recipient));
 ```
 
-## GraphQL Schema Consolidation
+## GraphQL schema consolidation
 
 The SDK now exports a single unified GraphQL schema instead of multiple versioned schemas.
 
@@ -206,7 +206,7 @@ The SDK now exports a single unified GraphQL schema instead of multiple versione
 + import { graphql } from '@mysten/sui/graphql/schema';
 ```
 
-## Named Packages Plugin Removed
+## Named packages plugin removed
 
 The `namedPackagesPlugin` and global plugin registry APIs have been removed. MVR (Move Registry)
 resolution is now built directly into the core client.
@@ -250,7 +250,7 @@ MVR name resolution happens automatically during transaction building. The SDK d
 + });
 ```
 
-## Transaction Executors Now Accept Any Client
+## Transaction executors now accept any client
 
 The transaction executor classes now accept any client implementing `ClientWithCoreApi` instead of
 requiring `SuiJsonRpcClient` specifically.
@@ -301,9 +301,9 @@ Include options have also changed:
 + });
 ```
 
-## ZkLogin Changes
+## zkLogin changes
 
-### legacyAddress Parameter Required
+### `legacyAddress` parameter required
 
 The `legacyAddress` parameter is now **required** for all zkLogin address computation functions.
 
@@ -327,7 +327,7 @@ The `legacyAddress` parameter is now **required** for all zkLogin address comput
 + toZkLoginPublicIdentifier(addressSeed, iss, { legacyAddress: false })
 ```
 
-## Default Transaction Expiration
+## Default transaction expiration
 
 Transactions now default the expiration to the current epoch + 1 using `ValidDuring` when built with
 a client. This provides replay protection for all transactions without requiring explicit

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

@@ -1,6 +1,6 @@
 # @mysten/suins
 
-> Migrate @mysten/suins to 2.0
+> Migrate @mysten/suins to 2.0 with client extension pattern.
 
 This package now exports a client extension that integrates with Sui clients.
 
@@ -24,9 +24,10 @@ This package now exports a client extension that integrates with Sui clients.
 + const nameRecord = await client.suins.getNameRecord('example.sui');
 ```
 
-## Custom Package IDs
+## Custom package IDs
 
-For custom deployments or networks other than mainnet/testnet, you can provide custom package info:
+For custom deployments or networks other than Mainnet or Testnet, you can provide custom package
+info:
 
 ```ts
 

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

@@ -1,26 +1,26 @@
 # Wallet Builders
 
-> Migration guide for wallet extension developers
+> Migration guide for wallet extension developers upgrading to 2.0.
 
 This guide covers the breaking changes for wallet builders implementing the
 `@mysten/wallet-standard` interface.
 
-## Key Changes
+## Key changes
 
 ### Removal of `sui:reportTransactionEffects`
 
 The `sui:reportTransactionEffects` feature has been removed entirely. If your wallet implements this
 feature, remove it.
 
-### New Core API Response Format
+### New core API response format
 
 The most significant change is how you obtain BCS-encoded effects for the
 `signAndExecuteTransaction` response. The new core API returns effects in a different structure.
 
 ## Migrating `signAndExecuteTransaction`
 
-The wallet standard output format hasn't changed - what's different is how you obtain the BCS
-effects when using the new Sui client APIs.
+The wallet standard output format hasn't changed. What's different is how you obtain the BCS effects
+when using the new Sui client APIs.
 
 ```diff
 #signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod = async ({

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

@@ -1,8 +1,8 @@
 # @mysten/walrus
 
-> Migrate @mysten/walrus to 2.0
+> Migrate @mysten/walrus to 2.0 with required client parameter and updated API.
 
-## Breaking Changes
+## Breaking changes
 
 - **Client required**: `WalrusClient` can no longer be created with just an RPC URL. You must pass a
   Sui client.
@@ -11,7 +11,7 @@
 - **Removed deprecated method**: `WalrusClient.experimental_asClientExtension()` has been removed.
   Use the `walrus()` function instead.
 
-## Updated Usage
+## Updated usage
 
 If you were creating `WalrusClient` directly:
 

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

@@ -1,11 +1,11 @@
 # @mysten/zksend
 
-> Migrate @mysten/zksend to 2.0
+> 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.
 
-## Breaking Changes
+## Breaking changes
 
 - **Client extension**: The zkSend SDK is now a client extension (`client.$extend(zksend())`)
 - **Non-contract links removed**: Only contract-based links are now supported. The `contract` option
@@ -31,7 +31,7 @@ Update your code to use the client extension:
 + }).$extend(zksend());
 ```
 
-### Creating a Link Builder
+### Creating a link builder
 
 ```diff
 - const builder = new ZkSendLinkBuilder({
@@ -44,7 +44,7 @@ Update your code to use the client extension:
 + });
 ```
 
-### Loading a Link
+### Loading a link
 
 ```diff
 - const link = new ZkSendLink({
@@ -68,7 +68,7 @@ Update your code to use the client extension:
 + const link = await client.zksend.loadLinkFromUrl(url);
 ```
 
-## Complete Example
+## Complete example
 
 ```ts