@mysten/sui 2.16.0 → 2.16.2

package/docs/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';
@@ -117,4 +117,4 @@ The low-level helper functions have been removed in favor of the `KioskTransacti
 +   .placeAndList({ itemType, item, price })
 +   .shareAndTransferCap(address)
 +   .finalize();
-```
+```

package/docs/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).
+practices, see the [Building SDKs guide](/sui/sdk-building).

package/docs/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:
@@ -11,4 +11,4 @@ registration function instead:
 
 - const client = suiClient.$extend(SealClient.asClientExtension());
 + const client = suiClient.$extend(seal());
-```
+```

package/docs/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
@@ -338,4 +338,4 @@ configuration.
 ```typescript
 const tx = new Transaction();
 tx.setExpiration({ None: true });
-```
+```

package/docs/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,11 +24,13 @@ 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
+
 const customPackageInfo: PackageInfo = {
 	packageId: '0x...',
 	packageIdV1: '0x...',
@@ -39,4 +41,4 @@ const client = new SuiGrpcClient({
 	baseUrl: 'http://localhost:9000',
 	network: 'localnet',
 }).$extend(suins({ packageInfo: customPackageInfo }));
-```
+```

package/docs/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 ({
@@ -63,4 +63,4 @@ Key changes:
 
 - Use `signer.signAndExecuteTransaction()` instead of `suiClient.executeTransactionBlock()`
 - Response is a union type - unwrap with `result.Transaction ?? result.FailedTransaction`
-- BCS effects are in `tx.effects.bcs` (Uint8Array) instead of `rawEffects` (number array)
+- BCS effects are in `tx.effects.bcs` (Uint8Array) instead of `rawEffects` (number array)

package/docs/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:
 
@@ -38,4 +38,4 @@ If you were passing `network` to `walrus()`, remove it:
 ```diff
 - client.$extend(walrus({ network: 'testnet' }));
 + client.$extend(walrus());
-```
+```

package/docs/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,9 +68,10 @@ Update your code to use the client extension:
 + const link = await client.zksend.loadLinkFromUrl(url);
 ```
 
-## Complete Example
+## Complete example
 
 ```ts
+
 // Create client with zkSend extension
 const client = new SuiGrpcClient({
 	baseUrl: 'https://fullnode.testnet.sui.io:443',
@@ -91,4 +92,4 @@ const { tx, link } = await linkBuilder.build();
 // Later, load an existing link
 const existingLink = await client.zksend.loadLinkFromUrl(linkUrl);
 const assets = await existingLink.getAssets();
-```
+```

package/docs/plugins.md

@@ -1,9 +1,8 @@
 # Transaction Plugins
 
-> Extend transaction building with reusable plugins
+> Extend transaction building with reusable plugins.
 
-> **Warning:** The `Transaction` plugin API is experimental and may change rapidly as it is being
-> developed.
+> **Warning:** The `Transaction` plugin API is experimental and might change rapidly as it is being developed.
 
 This document describes the plugin API for the `Transaction` builder. It covers internal details
 intended for developers interested in extending the `Transaction` builder. Developers using the
@@ -20,10 +19,10 @@ modify the data and commands added to a transaction before it is serialized to J
 BCS bytes. Transaction Intents are custom representations of user intents for a transaction,
 eventually resolved to one or more commands in the transaction.
 
-## Contents of a Transaction
+## Contents of a transaction
 
-When a `Transaction` is created (e.g., `new Transaction()`), it is initialized with an empty
-[TransactionDataBuilder](/typedoc/classes/_mysten_sui.transactions.TransactionDataBuilder.html)
+When a `Transaction` is created (for example, `new Transaction()`), it is initialized with an empty
+[`TransactionDataBuilder`](/typedoc/classes/_mysten_sui.transactions.TransactionDataBuilder.html)
 instance which stores the state of the partially built transaction. The full API of the
 `TransactionDataBuilder` won't be covered here, but you can find the available methods and
 properties in the
@@ -36,13 +35,13 @@ takes depend on the command, but they will be one of a few different types:
 - `GasCoin`: A reference to the coin used to pay for gas.
 - `Input`: An input to the transaction (described below).
 - `Result`: The result of a previous command.
-- `NestedResult`: If a previous command returns a tuple (e.g., `SplitCoin`), a `NestedResult` is
-  used to refer to a specific value in that tuple.
+- `NestedResult`: If a previous command returns a tuple (for example, `SplitCoin`), a `NestedResult`
+  is used to refer to a specific value in that tuple.
 
 Transactions also store a list of Inputs, which refer to user-provided values. Inputs can either be
 objects or Pure values and can be represented in several different ways:
 
-- `Pure`: An input value serialized to BCS. Pure values are generally scalar values or simple
+- `Pure`: An input value serialized to BCS. Pure values are generally scalar values or basic
   wrappers like options or vectors and cannot represent object types.
 - `Object`: A fully resolved object reference, which will be one of the following types:
   - `ImmOrOwnedObject`: A reference to an object, including the object's `id`, `version`, and
@@ -53,13 +52,13 @@ objects or Pure values and can be represented in several different ways:
     `digest`.
 - `UnresolvedPure`: A placeholder for a pure value that has not been serialized to BCS.
 - `UnresolvedObject`: A partial reference to an object, often containing just the object's `id`, but
-  may also include a version, digest, or initialSharedVersion.
+  might also include a version, digest, or initialSharedVersion.
 
-## Lifecycle of a Transaction
+## Lifecycle of a transaction
 
 Because transactions can contain `UnresolvedPure` and `UnresolvedObject` inputs, these values need
 to be resolved before the transaction can be serialized to BCS. However, these unresolved inputs can
-be represented in JSON. What may not be able to be represented in JSON are Transaction Intents.
+be represented in JSON. What might not be able to be represented in JSON are Transaction Intents.
 Transaction Intents represent custom concepts added by plugins or third-party SDKs. To account for
 this, the build process of a transaction is split into two phases: serialization and building.
 Serialization prepares the transaction to be serialized to JSON by running serialization plugins,
@@ -67,7 +66,7 @@ and resolving any unsupported intents. The Build phase then runs, which runs bui
 resolves any UnresolvedPure and UnresolvedObject inputs, before the transaction is serialized to
 BCS.
 
-## Serialization Plugins
+## Serialization plugins
 
 Serialization plugins can be added to a `Transaction` by calling the `addSerializationPlugin` method
 on a `Transaction` instance. Serialization plugins are called in the order they are added and are
@@ -83,7 +82,7 @@ transaction.addSerializationPlugin(async (transactionData, buildOptions, next) =
 });
 ```
 
-## Build Plugins
+## Build plugins
 
 The build phase is responsible for taking unresolved objects and unresolved pure values and
 converting them to their resolved versions by querying the RPC API to fetch the missing data. Build
@@ -137,7 +136,7 @@ const transaction = new Transaction();
 transaction.addBuildPlugin(simpleObjectCachePlugin);
 ```
 
-## Transaction Intents
+## Transaction intents
 
 Transaction Intents consist of two parts: adding the intent to the transaction and resolving the
 intent to standard commands.
@@ -145,6 +144,7 @@ intent to standard commands.
 Adding an intent is similar to adding any other command to a transaction:
 
 ```typescript
+
 const transaction = new Transaction();
 
 transaction.add(
@@ -162,6 +162,7 @@ wraps things up a bit. The `add` method on transactions accepts a function that
 current transaction instance. This allows us to create a helper that automatically adds the intent:
 
 ```typescript
+
 function transferToSender(objects: TransactionObjectInput[]) {
 	return (tx: Transaction) => {
 		tx.add(
@@ -186,6 +187,7 @@ commands. To do this, we'll use the `addIntentResolver` method on the `Transacti
 intent is present in the transaction.
 
 ```typescript
+
 const transaction = new Transaction();
 
 transaction.addIntentResolver('TransferToSender', resolveTransferToSender);
@@ -235,6 +237,7 @@ Manually adding intent resolvers to a transaction can be cumbersome, so we can a
 automatically when our `transferToSender` helper is called:
 
 ```typescript
+
 function transferToSender(objects: TransactionObjectInput[]) {
 	return (tx: Transaction) => {
 		// As long as we are adding the same function reference, it will only be added once
@@ -252,4 +255,4 @@ function transferToSender(objects: TransactionObjectInput[]) {
 
 const transaction = new Transaction();
 transaction.add(transferToSender(['0x1234']));
-```
+```