@mysten/docs 0.1.18 → 0.1.20

package/dist/sui/cryptography/passkey.md

@@ -1,6 +1,6 @@
 # Passkey
 
-> Use WebAuthn passkeys for Sui transaction signing
+> Use WebAuthn passkeys for Sui transaction signing.
 
 Similar to other Keypair classes, the Sui TypeScript SDK provides the `PasskeyKeypair` that handles
 communication with the passkey device and signing with it. This SDK defines the address and
@@ -19,8 +19,8 @@ To use, import the `PasskeyKeypair` class from `@mysten/sui/keypairs/passkey`.
 ## Create a new passkey
 
 To create a new passkey with the passkey device, and initialize a `PasskeyKeypair`, you can use the
-`PasskeyProvider` and provide the `rpName`, `rpId` and additional options. Note that
-`getPasskeyInstance` call will initialize a new passkey wallet for the origin.
+`PasskeyProvider` and provide the `rpName`, `rpId`, and additional options. The `getPasskeyInstance`
+call initializes a new passkey wallet for the origin.
 
 ```typescript
 const keypair = await PasskeyKeypair.getPasskeyInstance(
@@ -49,15 +49,15 @@ same instance and the public key is available when constructing the passkey sign
 It is recommended that the user should only be allowed to create a passkey wallet once per origin.
 If the user ended up with multiple passkeys for the same origin, the passkey UI would show a list of
 all passkeys of the same origin and the user can choose which one to use. This can be a confusing
-experience since they do not remember which passkey is the way that the wallet was created for.
+experience because they do not remember which passkey is the way that the wallet was created for.
 
 ## Recover a passkey
 
 However, if the user is logged out or uses a different browser or device, or the `PasskeyKeypair`
-instance is no longer present for any reason, the user should be prompt to recover the public key
-(e.g. "Log in to existing passkey wallet") to be able to use the passkey wallet again. If the user
-is prompted to create a new key in passkey device, a fresh new wallet with new address will be
-created.
+instance is no longer present for any reason, the user should be prompted to recover the public key
+(for example, through a "Log in to existing passkey wallet" flow) to be able to use the passkey
+wallet again. If the user is prompted to create a new key in passkey device, a fresh new wallet with
+new address will be created.
 
 One can recover the unique public key with exactly two passkey signatures on two messages. This
 means that if the user is asked to sign two messages, the developer can recover an unique public key
@@ -80,15 +80,16 @@ const keypair = new PasskeyKeypair(commonPk.toRawBytes(), provider);
 ```
 
 Alternatively, the developer can choose to ask the user to only sign one personal message that
-returns two possible public keys. Then the frontend may derive the addresses for both, and check
-onchain for the unique address that contains assets. Or the frontend may retrieve additional
-signatures from past transaction history for the given address. This may a preferred user experience
-since the user is only prompted to sign one message, but the frontend needs to do extra work.
+returns two possible public keys. Then the frontend might derive the addresses for both and check
+onchain for the unique address that contains assets. Or the frontend might retrieve additional
+signatures from past transaction history for the given address. This might be a preferred user
+experience because the user is only prompted to sign one message, but the frontend needs to do extra
+work.
 
 ## Usage
 
 The usage for a passkey keypair is the same as any other keypair. You can derive the public key,
-derive the address, sign personal messages, sign transactions and verify signatures. See the
+derive the address, sign personal messages, sign transactions, and verify signatures. See the
 [Key pairs](./keypairs) documentation for more details.
 
 ```typescript
@@ -103,7 +104,7 @@ const txSignature = await passkey.signTransaction(txBytes);
 
 An example implemention can be found [here](https://github.com/MystenLabs/passkey-example).
 
-## Supported Platforms
+## Supported platforms
 
 Sui supports passkey wallets on any device that complies with the WebAuthn standard. This includes
 most modern browsers and operating systems across desktop and mobile. To check which platforms and

package/dist/sui/cryptography/webcrypto-signer.md

@@ -1,9 +1,9 @@
 # Web Crypto Signer
 
-> Sign transactions using the Web Crypto API
+> Sign transactions using the Web Crypto API for secure browser-based key management.
 
-For cases where you need to create keypairs directly within client dapps, we recommend using the Web
-Crypto Signer. This signer leverages the
+For cases where you need to create keypairs directly within client apps, you can use the Web Crypto
+Signer. This signer leverages the
 [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) to provide a
 secure and efficient way to generate and manage cryptographic keys in the browser. The generated
 keys are `Secp256r1` keys which can be persisted between sessions, and are not extractable by
@@ -68,7 +68,7 @@ const keypair = await WebCryptoSigner.import(exported);
 ## Usage
 
 The usage for a Web Crypto signer is the same as any other keypair. You can derive the public key,
-derive the address, sign personal messages, sign transactions and verify signatures. See the
+derive the address, sign personal messages, sign transactions, and verify signatures. See the
 [Key pairs](./keypairs) documentation for more details.
 
 ```typescript

package/dist/sui/executors.md

@@ -1,15 +1,16 @@
 # Transaction Executors
 
-> Manage transaction execution with queuing and parallel strategies
+> Manage transaction execution with queuing and parallel strategies.
 
-The Typescript SDK ships 2 Transaction executor classes that simplify the processes of efficiently
-executing multiple transactions signed by the same address. These executors help manage object
-versions and gas coins which significantly reduces the number of requests made to RPC nodes, and for
-many cases avoids the need to wait for the RPC nodes to index previously executed transactions.
+The TypeScript SDK ships two `Transaction` executor classes that simplify the processes of
+efficiently executing multiple transactions signed by the same address. These executors help manage
+object versions and gas coins which significantly reduces the number of requests made to RPC nodes,
+and for many cases avoids the need to wait for the RPC nodes to index previously executed
+transactions.
 
 ## `SerialTransactionExecutor`
 
-The `SerialTransactionExecutor` is designed for use in wallet implementations, and dapps where the
+The `SerialTransactionExecutor` is designed for use in wallet implementations and apps where the
 objects owned by the address executing transactions are unlikely to be changed by transactions not
 executed through the executor.
 
@@ -61,7 +62,7 @@ const [{ digest: digest1 }, { digest: digest2 }] = await Promise.all([
 
 ## `ParallelTransactionExecutor`
 
-> **Warning:** `ParallelTransactionExecutor` is experimental and may change rapidly as it is being developed.
+> **Warning:** `ParallelTransactionExecutor` is experimental and might change rapidly as it is being developed.
 
 The `ParallelTransactionExecutor` class works similarly to the `SerialTransactionExecutor`, but
 allows for parallel execution of transactions. To make this work, the `ParallelTransactionExecutor`
@@ -69,8 +70,8 @@ will maintain a pool of gas coins, and automatically execute additional transact
 gas pool as needed.
 
 > **Warning:** Using other client methods or wallets to execute additional transactions while
-> `ParallelTransactionExecutor` is in use may consume/combine gas coins in the gasPool, causing
-> transactions to fail. This may also result in the coins becoming locked for the remainder of the
+> `ParallelTransactionExecutor` is in use might consume or combine gas coins in the gasPool, causing
+> transactions to fail. This might also result in the coins becoming locked for the remainder of the
 > current epoch, preventing them from being used in future transactions.
 > 
 > Running multiple instances of `ParallelTransactionExecutor` using the same `sourceCoins` will
@@ -99,9 +100,10 @@ way that avoids conflicts between transactions using the same object ids.
   maximum number of concurrent transactions (default 50),
 - `sourceCoins`: An array of coins to use to create the gas pool, defaults to using all coins owned
   by the signer.
-- `epochBoundaryWindow` Time to wait before/after the expected epoch boundary before re-fetching the
-  gas pool (in milliseconds). Building transactions will be paused for up to 2x this duration around
-  each epoch boundary to ensure the gas price is up-to-date for the next epoch. (default `1000`)
+- `epochBoundaryWindow`: Time to wait before or after the expected epoch boundary before re-fetching
+  the gas pool (in milliseconds). Building transactions will be paused for up to 2x this duration
+  around each epoch boundary to ensure the gas price is up-to-date for the next epoch. (default
+  `1000`)
 
 ```ts
 
@@ -125,23 +127,23 @@ const [{ digest: digest1 }, { digest: digest2 }] = await Promise.all([
 ]);
 ```
 
-## Building and Executing Transactions with Executors
+## Building and executing transactions with executors
 
 The executor classes will significantly improve efficiency when executing multiple transactions, but
 to get the best results there are some best practices to follow:
 
 When building transactions, always prefer using unresolved object IDs rather than specifying the
-full `id`/`version`/`digest` for an object input (eg use `tx.object(id)` rather than
+full `id`, `version`, and `digest` for an object input (for example, use `tx.object(id)` rather than
 `tx.objectRef({ objectId, version, digest })`). By doing this, you allow the executor to use object
 versions and digests from the cache, and will avoid executing transactions using stale object
 versions.
 
-If the signer executes transactions that are not sent through the executor that may cause
+If the signer executes transactions that are not sent through the executor, that might cause
 transactions to fail. The executor classes will handle this by invalidating the cache for any
 objects used in the transaction, so you will often be able to recover by re-trying a failed
 transaction once. If it was caused by a stale cache, it should succeed on the second execution.
 
-> **Warning:** Transaction plugins and intents may resolve their own data (such as object references) that are
+> **Warning:** Transaction plugins and intents might resolve their own data (such as object references) that are
 > not automatically managed by the executor's object cache. This can cause transactions to include
 > stale object versions. The `coinWithBalance` intent is partially supported by the executors and
 > will work correctly when all coin types are either SUI or the required balances are available as

package/dist/sui/faucet.md

@@ -1,6 +1,6 @@
 # Faucet
 
-> Request test SUI tokens from the faucet
+> Request test SUI tokens from the faucet on Devnet, Testnet, or local networks.
 
 Devnet, Testnet, and local networks include faucets that mint SUI. You can use the Sui TypeScript
 SDK to call a network's faucet and provide SUI to the address you provide.
@@ -22,5 +22,5 @@ await requestSuiFromFaucetV2({
 ```
 
 > **Note:** Faucets on Devnet and Testnet are rate limited. If you run the script too many times, you surpass
-> the limit and must wait to successfully run it again. For testnet, the best way to get SUI is via
-> the Web UI: `faucet.sui.io`.
+> the limit and must wait to successfully run it again. For Testnet, the best way to get SUI is
+> through the Web UI: `faucet.sui.io`.

package/dist/sui/hello-sui.md

@@ -1,6 +1,6 @@
 # Hello Sui
 
-> Build your first Sui application with the TypeScript SDK
+> Build your first Sui application with the TypeScript SDK.
 
 This basic example introduces you to the Sui TypeScript SDK. The Node.js example mints SUI on a Sui
 network and then queries the address to get a sum for the owned SUI. You don't need to use an IDE to
@@ -9,8 +9,8 @@ projects.
 
 ## Before you begin
 
-You need an address on a Sui development network (Devnet, Testnet, local). If you don't already have
-an address, use the [Sui Client CLI](https://docs.sui.io/references/cli/client) or the
+You need an address on a Sui development network (Devnet, Testnet, or local). If you don't already
+have an address, use the [Sui Client CLI](https://docs.sui.io/references/cli/client) or the
 [Sui Wallet browser extension](https://docs.mystenlabs.com) to create one.
 
 You also need [Node.js](https://nodejs.org/en/download/current) and a package manager like
@@ -108,8 +108,8 @@ using the faucet. You can check the total SUI for your address using the Sui Wal
 CLI.
 
 > **Note:** Faucets on Devnet and Testnet are rate limited. If you run the script too many times, you surpass
-> the limit and must wait to successfully run it again. For testnet, the best way to get SUI is via
-> the Web UI: `faucet.sui.io`.
+> the limit and must wait to successfully run it again. For Testnet, the best way to get SUI is
+> through the Web UI: `faucet.sui.io`.
 
 You can also use the [Sui Client CLI](https://docs.sui.io/references/cli/client) to perform client
 calls on a Sui network.

package/dist/sui/index.md

@@ -1,6 +1,6 @@
 # Sui TypeScript SDK Quick Start
 
-> TypeScript SDK for building on the Sui blockchain
+> The Sui TypeScript SDK is a modular library of tools for interacting with the Sui blockchain.
 
 The Sui TypeScript SDK is a modular library of tools for interacting with the Sui blockchain. Use it
 to send queries to RPC nodes, build and sign transactions, and interact with a Sui or local network.
@@ -16,7 +16,7 @@ npm i @mysten/sui
 The following table lists the locations for Sui networks.
 
 | Network | Full node                             | faucet                                   |
-| ------- | ------------------------------------- | ---------------------------------------- |
+| :------ | :------------------------------------ | :--------------------------------------- |
 | local   | `http://127.0.0.1:9000` (default)     | `http://127.0.0.1:9123/v2/gas` (default) |
 | Devnet  | `https://fullnode.devnet.sui.io:443`  | `https://faucet.devnet.sui.io/v2/gas`    |
 | Testnet | `https://fullnode.testnet.sui.io:443` | `https://faucet.testnet.sui.io/v2/gas`   |
@@ -36,18 +36,18 @@ The following table lists the locations for Sui networks.
 The SDK contains a set of modular packages that you can use independently or together. Import just
 what you need to keep your code light and compact.
 
-- [`@mysten/sui/client`](/sui/clients) - A client for interacting with Sui RPC nodes.
-- [`@mysten/sui/bcs`](/sui/bcs) - A BCS builder with pre-defined types for Sui.
-- [`@mysten/sui/transactions`](/sui/transaction-building/basics) - Utilities for building and
+- [`@mysten/sui/client`](/sui/clients): A client for interacting with Sui RPC nodes.
+- [`@mysten/sui/bcs`](/sui/bcs): A BCS builder with pre-defined types for Sui.
+- [`@mysten/sui/transactions`](/sui/transaction-building/basics): Utilities for building and
   interacting with transactions.
-- [`@mysten/sui/keypairs/*`](/sui/cryptography/keypairs) - Modular exports for specific KeyPair
+- [`@mysten/sui/keypairs/*`](/sui/cryptography/keypairs): Modular exports for specific KeyPair
   implementations.
-- [`@mysten/sui/verify`](/sui/cryptography/keypairs#verifying-signatures-without-a-key-pair) -
+- [`@mysten/sui/verify`](/sui/cryptography/keypairs#verifying-signatures-without-a-key-pair):
   Methods for verifying transactions and messages.
-- [`@mysten/sui/cryptography`](/sui/cryptography/keypairs) - Shared types and classes for
+- [`@mysten/sui/cryptography`](/sui/cryptography/keypairs): Shared types and classes for
   cryptography.
-- [`@mysten/sui/multisig`](/sui/cryptography/multisig) - Utilities for working with multisig
+- [`@mysten/sui/multisig`](/sui/cryptography/multisig): Utilities for working with multisig
   signatures.
-- [`@mysten/sui/utils`](/sui/utils) - Utilities for formatting and parsing various Sui types.
-- [`@mysten/sui/faucet`](/sui/faucet) - Methods for requesting SUI from a faucet.
-- [`@mysten/sui/zklogin`](/sui/zklogin) - Utilities for working with zkLogin.
+- [`@mysten/sui/utils`](/sui/utils): Utilities for formatting and parsing various Sui types.
+- [`@mysten/sui/faucet`](/sui/faucet): Methods for requesting SUI from a faucet.
+- [`@mysten/sui/zklogin`](/sui/zklogin): Utilities for working with zkLogin.

package/dist/sui/install.md

@@ -1,6 +1,6 @@
 # Install Sui TypeScript SDK
 
-> Install the @mysten/sui package and configure your project
+> Install the @mysten/sui package and configure your project.
 
 The Sui TypeScript SDK is available in the
 [Sui TS SDK monorepo](https://github.com/MystenLabs/ts-sdks) and NPM.
@@ -28,9 +28,9 @@ such as `"NodeNext"`, `"Node16"`, or `"Bundler"`. See the
 
 ## Experimental tag for use with a local Sui network
 
-Projects developing against one of the on-chain Sui networks (Devnet, Testnet, Mainnet) should use
+Projects developing against one of the onchain Sui networks (Devnet, Testnet, Mainnet) should use
 the base SDK published in the NPM registry (previous section) because the code aligns with the
-relevant JSON-RPC. If your developing against a
+relevant JSON-RPC. If you are developing against a
 [local network](https://docs.sui.io/guides/developer/getting-started/local-network) built from the
 `main` branch of the Sui monorepo, however, you should use the `experimental`-tagged SDK package as
 it contains the latest features (or a local build detailed in the section that follows).

package/dist/sui/llm-docs.md

@@ -1,29 +1,29 @@
 # LLM Documentation
 
-> Give AI agents access to Sui SDK documentation in your project
+> Give AI agents access to Sui SDK documentation in your project.
 
 Every `@mysten/*` package ships a `docs/` directory containing flat markdown files optimized for AI
 agent consumption. When you install an SDK package, you automatically get accurate, up-to-date
-documentation that coding agents (Claude Code, Cursor, Copilot, etc.) can read directly — no
-separate install or training data required.
+documentation that coding agents (Claude Code, Cursor, Copilot, and others) can read directly. No
+separate install or training data is required.
 
-## How It Works
+## How it works
 
 Each package includes:
 
-- `docs/llms-index.md` — routing index listing all doc pages with descriptions
-- `docs/*.md` — individual reference pages
+- `docs/llms-index.md`: Routing index listing all doc pages with descriptions
+- `docs/*.md`: Individual reference pages
 
 For example, installing `@mysten/sui` gives you docs at
 `node_modules/@mysten/sui/docs/llms-index.md`.
 
-## Configure Your Agent
+## Configure your agent
 
 Add the following snippet to your agent's configuration file (`AGENTS.md`, `CLAUDE.md`,
-`.cursorrules`, etc.):
+`.cursorrules`, and others):
 
 ```markdown
-## Sui SDK Reference
+## Sui SDK reference
 
 Every @mysten/\* package ships LLM documentation in its `docs/` directory. When working with these
 packages, find the relevant docs by looking for `docs/llms-index.md` files inside

package/dist/sui/llms-index.md

@@ -1,44 +1,44 @@
 # Sui SDK
 > TypeScript interfaces for Sui
 
-- [Sui TypeScript SDK Quick Start](..md): TypeScript SDK for building on the Sui blockchain
-- [Install Sui TypeScript SDK](./install.md): Install the @mysten/sui package and configure your project
-- [LLM Documentation](./llm-docs.md): Give AI agents access to Sui SDK documentation in your project
-- [Hello Sui](./hello-sui.md): Build your first Sui application with the TypeScript SDK
-- [Faucet](./faucet.md): Request test SUI tokens from the faucet
-- [Sui Clients](./clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients
-- [Core API](./clients/core.md): Transport-agnostic Core API shared by all Sui clients
-- [SuiGrpcClient](./clients/grpc.md): Connect to Sui via gRPC with SuiGrpcClient
-- [SuiGraphQLClient](./clients/graphql.md): Connect to Sui via GraphQL with SuiGraphQLClient
-- [SuiJsonRpcClient](./clients/json-rpc.md): Connect to Sui via JSON-RPC with SuiJsonRpcClient
-- [Sui Programmable Transaction Basics](./transaction-building/basics.md): Construct programmable transaction blocks with the Transaction API
-- [Paying for Sui Transactions with Gas Coins](./transaction-building/gas.md): Configure gas budget, price, and coin selection for transactions
-- [Transaction Intents](./transaction-building/intents.md): Use high-level intents to simplify transaction building
-- [Building Offline](./transaction-building/offline.md): Build transactions without a network connection
-- [Sponsored Transactions](./transaction-building/sponsored-transactions.md): Pay gas fees on behalf of other users with sponsored transactions
-- [Key pairs](./cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1 keypairs
-- [Multi-Signature Transactions](./cryptography/multisig.md): Create multi-signature transactions with multiple signers
-- [Passkey](./cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing
-- [Web Crypto Signer](./cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto API
-- [The `@mysten/sui/utils` package](./utils.md): Utility functions for addresses, coins, and common operations
-- [Derived Objects](./utils/derived_objects.md): Compute derived object IDs from parent objects
-- [BCS](./bcs.md): Binary Canonical Serialization for encoding Sui Move types
-- [ZkLogin](./zklogin.md): Zero-knowledge authentication with OAuth providers on Sui
-- [Transaction Executors](./executors.md): Manage transaction execution with queuing and parallel strategies
-- [Transaction Plugins](./plugins.md): Extend transaction building with reusable plugins
-- [Building SDKs](./sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
-- [Migrate to 2.0](./migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0
-- [Agent Migration Prompt](./migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration
-- [@mysten/sui](./migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0
-- [Migrating from JSON-RPC](./migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API
-- [@mysten/dapp-kit](./migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to 2.0
-- [@mysten/kiosk](./migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0
-- [@mysten/zksend](./migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0
-- [@mysten/suins](./migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0
-- [@mysten/deepbook-v3](./migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0
-- [@mysten/walrus](./migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0
-- [@mysten/seal](./migrations/sui-2.0/seal.md): Migrate @mysten/seal to 2.0
-- [Wallet Builders](./migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers
-- [SDK Maintainers](./migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors
-- [Migrate to 1.0](./migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0
-- [Migrate to 0.38.0](./migrations/0.38.md): Migrate from SDK version 0.37 to 0.38
+- [Sui TypeScript SDK Quick Start](..md): The Sui TypeScript SDK is a modular library of tools for interacting with the Sui blockchain.
+- [Install Sui TypeScript SDK](./install.md): Install the @mysten/sui package and configure your project.
+- [LLM Documentation](./llm-docs.md): Give AI agents access to Sui SDK documentation in your project.
+- [Hello Sui](./hello-sui.md): Build your first Sui application with the TypeScript SDK.
+- [Faucet](./faucet.md): Request test SUI tokens from the faucet on Devnet, Testnet, or local networks.
+- [Sui Clients](./clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients for the Sui network.
+- [Core API](./clients/core.md): Transport-agnostic Core API shared by all Sui clients.
+- [SuiGrpcClient](./clients/grpc.md): Connect to Sui through gRPC with SuiGrpcClient.
+- [SuiGraphQLClient](./clients/graphql.md): Connect to Sui through GraphQL with SuiGraphQLClient.
+- [SuiJsonRpcClient](./clients/json-rpc.md): Connect to Sui through JSON-RPC with SuiJsonRpcClient.
+- [Sui Programmable Transaction Basics](./transaction-building/basics.md): Construct programmable transaction blocks with the Transaction API.
+- [Paying for Sui Transactions with Gas Coins](./transaction-building/gas.md): Configure gas budget, price, and coin selection for Sui transactions.
+- [Transaction Intents](./transaction-building/intents.md): Use high-level intents to simplify transaction building.
+- [Building Offline](./transaction-building/offline.md): Build transactions without a network connection.
+- [Sponsored Transactions](./transaction-building/sponsored-transactions.md): Pay gas fees on behalf of other users with sponsored transactions.
+- [Key pairs](./cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1 keypairs for Sui transaction signing.
+- [Multi-Signature Transactions](./cryptography/multisig.md): Create multi-signature transactions with multiple signers on Sui.
+- [Passkey](./cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing.
+- [Web Crypto Signer](./cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto API for secure browser-based key management.
+- [The `@mysten/sui/utils` package](./utils.md): Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
+- [Derived Objects](./utils/derived_objects.md): Compute derived object IDs from parent objects for deterministic offline derivation.
+- [BCS](./bcs.md): Binary Canonical Serialization for encoding Sui Move types.
+- [ZkLogin](./zklogin.md): Zero-knowledge authentication with OAuth providers on Sui.
+- [Transaction Executors](./executors.md): Manage transaction execution with queuing and parallel strategies.
+- [Transaction Plugins](./plugins.md): Extend transaction building with reusable plugins.
+- [Building SDKs](./sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK.
+- [Migrate to 2.0](./migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages.
+- [Agent Migration Prompt](./migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration of your codebase.
+- [@mysten/sui](./migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0 with new client APIs and BCS changes.
+- [Migrating from JSON-RPC](./migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API using SuiGrpcClient or SuiGraphQLClient.
+- [@mysten/dapp-kit](./migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to the new dapp-kit-react package in 2.0.
+- [@mysten/kiosk](./migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction.
+- [@mysten/zksend](./migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API.
+- [@mysten/suins](./migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0 with client extension pattern.
+- [@mysten/deepbook-v3](./migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern.
+- [@mysten/walrus](./migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0 with required client parameter and updated API.
+- [@mysten/seal](./migrations/sui-2.0/seal.md): Migrate @mysten/seal to 2.0 with the new registration function pattern.
+- [Wallet Builders](./migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers upgrading to 2.0.
+- [SDK Maintainers](./migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors upgrading to 2.0.
+- [Migrate to 1.0](./migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0 with new features and API changes.
+- [Migrate to 0.38.0](./migrations/0.38.md): Migrate from SDK version 0.37 to 0.38 with updated module structure and API changes.

package/dist/sui/migrations/0.38.md

@@ -1,8 +1,8 @@
 # Migrate to 0.38.0
 
-> Migrate from SDK version 0.37 to 0.38
+> Migrate from SDK version 0.37 to 0.38 with updated module structure and API changes.
 
-> **Warning:** The 1.0 release of the SDK contains many additional changes. This document may help help as an
+> **Warning:** The 1.0 release of the SDK contains many additional changes. This document might help as an
 > intermediate step when upgrading from older versions of the SDK, but all apps should be upgraded to
 > the latest version of the SDK instead of 0.38.0.
 
@@ -19,13 +19,13 @@ the complete SDK module. Now, you upload the individual packages of the SDK modu
 
 The Sui TypeScript SDK deprecates the following classes with version 0.38.0:
 
-- `JsonRpcProvider` - The `JsonRpcProvider` class is deprecated in favor of the `suiClient` class
+- `JsonRpcProvider`: The `JsonRpcProvider` class is deprecated in favor of the `suiClient` class
   when creating a client for a Sui network. See
   [Network Interactions with SuiJsonRpcClient](/sui/clients) for more information.
 - `SignerWithProver` and `RawSigner` - Key pairs now directly support signing transactions and
   messages without the need of a `Signer` class. See the [Key pairs](/sui/cryptography/keypairs)
   topic for more information.
-- `signAndExecuteTransaction` - This method was not deprecated, but is now part of
+- `signAndExecuteTransaction`: This method was not deprecated, but is now part of
   `SuiJsonRpcClient`.
 - `Connection` classes - The `Connection` classes (`Connection`, `devnetConnection`, and so on) have
   been deprecated in favor ofSuiJsonRpcClientuiClient` for establishing the connection. See
@@ -33,8 +33,8 @@ The Sui TypeScript SDK deprecates the following classes with version 0.38.0:
 - The `superstruct` type definitions for `JsonRPCProvider` types are replaced with generated types
   exported from `@mysten/sui/client`. The new type definitions are pure TypeScript types that you
   can't use for runtime validation.
-- A more stable JSON-RPC API has reduced the need for many of the SDK "getter" methods, which are
-  now deprecated.
+- A more stable JSON-RPC API has reduced the need for many of the SDK getter methods, which are now
+  deprecated.
 
 ### Signing transactions