@mysten/docs 0.1.44 → 0.1.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/codegen/index.md +307 -25
  2. package/dist/dapp-kit/getting-started/react.md +2 -2
  3. package/dist/dapp-kit/getting-started/vue.md +2 -2
  4. package/dist/dapp-kit/llms-index.md +4 -4
  5. package/dist/dapp-kit/react/hooks/use-current-client.md +6 -5
  6. package/dist/dapp-kit/state.md +2 -2
  7. package/dist/kiosk/advanced-examples.md +3 -3
  8. package/dist/kiosk/from-v1.md +9 -9
  9. package/dist/kiosk/index.md +6 -3
  10. package/dist/kiosk/kiosk-client/introduction.md +10 -7
  11. package/dist/kiosk/llms-index.md +4 -4
  12. package/dist/llms-index.md +26 -25
  13. package/dist/seal/index.md +3 -0
  14. package/dist/sui/bcs.md +2 -2
  15. package/dist/sui/clients/core.md +151 -690
  16. package/dist/sui/clients/executing.md +113 -0
  17. package/dist/sui/clients/graphql.md +91 -46
  18. package/dist/sui/clients/grpc.md +239 -142
  19. package/dist/sui/clients/index.md +87 -51
  20. package/dist/sui/clients/querying.md +539 -0
  21. package/dist/sui/executors.md +28 -13
  22. package/dist/sui/index.md +1 -1
  23. package/dist/sui/llms-index.md +18 -17
  24. package/dist/sui/migrations/sui-2.0/dapp-kit.md +3 -3
  25. package/dist/sui/migrations/sui-2.0/deepbook-v3.md +2 -2
  26. package/dist/sui/migrations/sui-2.0/index.md +46 -25
  27. package/dist/sui/migrations/sui-2.0/json-rpc-migration.md +462 -284
  28. package/dist/sui/migrations/sui-2.0/kiosk.md +10 -9
  29. package/dist/sui/migrations/sui-2.0/sdk-maintainers.md +17 -11
  30. package/dist/sui/migrations/sui-2.0/sui.md +47 -29
  31. package/dist/sui/migrations/sui-2.0/suins.md +2 -2
  32. package/dist/sui/migrations/sui-2.0/walrus.md +3 -3
  33. package/dist/sui/migrations/sui-2.0/zksend.md +9 -8
  34. package/dist/sui/sdk-building.md +7 -5
  35. package/dist/sui/transactions/signing-and-execution.md +8 -28
  36. package/package.json +21 -21
  37. package/dist/sui/clients/json-rpc.md +0 -239
@@ -1,8 +1,8 @@
1
1
  # Kiosk
2
2
  > Interact with on-chain commerce applications
3
3
 
4
- - [Kiosk SDK](..md): TypeScript SDK for interacting with Sui Kiosk onchain commerce.
5
- - [Kiosk Client](./kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui.
4
+ - [Kiosk SDK](..md): TypeScript SDK for interacting with Sui Kiosk onchain commerce
5
+ - [Kiosk Client](./kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui
6
6
  - [Querying](./kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
7
7
  - [KioskTransaction](./kiosk-client/kiosk-transaction/kiosk-transaction.md): Build kiosk transactions for listing, purchasing, and managing items on Sui.
8
8
  - [Managing Owned Kiosk](./kiosk-client/kiosk-transaction/managing.md): Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
@@ -10,5 +10,5 @@
10
10
  - [Examples](./kiosk-client/kiosk-transaction/examples.md): Practical code examples for kiosk transactions including minting, listing, and purchasing.
11
11
  - [TransferPolicyTransaction](./kiosk-client/transfer-policy-transaction/introduction.md): Create and manage transfer policies for kiosk items using the Kiosk SDK.
12
12
  - [Using the manager](./kiosk-client/transfer-policy-transaction/using-the-manager.md): Use the TransferPolicyTransaction manager to add rules and withdraw profits.
13
- - [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios.
14
- - [Migrating from Kiosk SDK V1](./from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API.
13
+ - [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios
14
+ - [Migrating from Kiosk SDK V1](./from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API
@@ -16,11 +16,11 @@
16
16
 
17
17
  - [Sui dApp Kit](./dapp-kit.md): Build Sui apps with framework-agnostic core and React bindings.
18
18
  - [@mysten/create-dapp](./dapp-kit/getting-started/create-dapp.md): Create a Sui app with one command using the create-dapp CLI scaffolding tool.
19
- - [React](./dapp-kit/getting-started/react.md): Set up dApp Kit in a React application.
19
+ - [React](./dapp-kit/getting-started/react.md): Set up dApp Kit in a React application
20
20
  - [Next.js](./dapp-kit/getting-started/next-js.md): Set up dApp Kit in a Next.js application.
21
- - [Vue](./dapp-kit/getting-started/vue.md): Set up dApp Kit in a Vue application.
21
+ - [Vue](./dapp-kit/getting-started/vue.md): Set up dApp Kit in a Vue application
22
22
  - [DApp Kit Instance](./dapp-kit/dapp-kit-instance.md): Create and configure a DAppKit instance for wallet and client management
23
- - [State](./dapp-kit/state.md): Access and subscribe to wallet connection state in dApp Kit.
23
+ - [State](./dapp-kit/state.md): Access and subscribe to wallet connection state in dApp Kit
24
24
  - [Connect Wallet](./dapp-kit/actions/connect-wallet.md): Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
25
25
  - [Disconnect Wallet](./dapp-kit/actions/disconnect-wallet.md): Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
26
26
  - [Sign and Execute Transaction](./dapp-kit/actions/sign-and-execute-transaction.md): Sign and execute a transaction on the Sui network using the connected wallet.
@@ -32,7 +32,7 @@
32
32
  - [React Hooks](./dapp-kit/react/hooks.md): React hooks for accessing dApp Kit state and actions in Sui applications.
33
33
  - [useDAppKit](./dapp-kit/react/hooks/use-dapp-kit.md): React hook to access the full dApp Kit instance for calling actions directly.
34
34
  - [useCurrentAccount](./dapp-kit/react/hooks/use-current-account.md): React hook to get the currently selected wallet account in a Sui dApp.
35
- - [useCurrentClient](./dapp-kit/react/hooks/use-current-client.md): React hook to get the current Sui client instance for the active network.
35
+ - [useCurrentClient](./dapp-kit/react/hooks/use-current-client.md): React hook to get the current Sui client instance for the active network
36
36
  - [useCurrentNetwork](./dapp-kit/react/hooks/use-current-network.md): React hook to get the currently selected Sui network in dApp Kit.
37
37
  - [useCurrentWallet](./dapp-kit/react/hooks/use-current-wallet.md): React hook to get the currently connected wallet in a Sui dApp.
38
38
  - [useWalletConnection](./dapp-kit/react/hooks/use-wallet-connection.md): React hook to manage wallet connection status and information in a Sui dApp.
@@ -48,8 +48,8 @@
48
48
  ## Kiosk
49
49
  > Interact with on-chain commerce applications
50
50
 
51
- - [Kiosk SDK](./kiosk.md): TypeScript SDK for interacting with Sui Kiosk onchain commerce.
52
- - [Kiosk Client](./kiosk/kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui.
51
+ - [Kiosk SDK](./kiosk.md): TypeScript SDK for interacting with Sui Kiosk onchain commerce
52
+ - [Kiosk Client](./kiosk/kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui
53
53
  - [Querying](./kiosk/kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
54
54
  - [KioskTransaction](./kiosk/kiosk-client/kiosk-transaction/kiosk-transaction.md): Build kiosk transactions for listing, purchasing, and managing items on Sui.
55
55
  - [Managing Owned Kiosk](./kiosk/kiosk-client/kiosk-transaction/managing.md): Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
@@ -57,8 +57,8 @@
57
57
  - [Examples](./kiosk/kiosk-client/kiosk-transaction/examples.md): Practical code examples for kiosk transactions including minting, listing, and purchasing.
58
58
  - [TransferPolicyTransaction](./kiosk/kiosk-client/transfer-policy-transaction/introduction.md): Create and manage transfer policies for kiosk items using the Kiosk SDK.
59
59
  - [Using the manager](./kiosk/kiosk-client/transfer-policy-transaction/using-the-manager.md): Use the TransferPolicyTransaction manager to add rules and withdraw profits.
60
- - [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios.
61
- - [Migrating from Kiosk SDK V1](./kiosk/from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API.
60
+ - [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios
61
+ - [Migrating from Kiosk SDK V1](./kiosk/from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API
62
62
 
63
63
  ## Payment Kit
64
64
  > Accept P2P and merchant payments in any coin type on Sui with @mysten/payment-kit
@@ -94,11 +94,12 @@
94
94
 
95
95
  - [Sui TypeScript SDK](./sui.md): TypeScript SDK for building on the Sui blockchain
96
96
  - [LLM Documentation](./sui/llm-docs.md): Give AI agents access to Sui SDK documentation in your project.
97
- - [Sui Clients](./sui/clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients for the Sui network.
98
- - [Core API](./sui/clients/core.md): Transport-agnostic Core API shared by all Sui clients.
99
- - [SuiGrpcClient](./sui/clients/grpc.md): Connect to Sui through gRPC with SuiGrpcClient.
100
- - [SuiGraphQLClient](./sui/clients/graphql.md): Connect to Sui through GraphQL with SuiGraphQLClient.
101
- - [SuiJsonRpcClient](./sui/clients/json-rpc.md): Connect to Sui through JSON-RPC with SuiJsonRpcClient.
97
+ - [Sui Clients](./sui/clients.md): Choose between SuiGrpcClient and SuiGraphQLClient and understand their shared API
98
+ - [Querying Data](./sui/clients/querying.md): Read objects, coins, balances, dynamic fields, and history with any Sui client
99
+ - [Executing Transactions](./sui/clients/executing.md): Simulate, execute, and wait for transactions with any Sui client
100
+ - [SuiGrpcClient](./sui/clients/grpc.md): Connect to Sui over gRPC, with native service clients and real-time subscriptions
101
+ - [SuiGraphQLClient](./sui/clients/graphql.md): Connect to Sui over GraphQL and write type-safe custom queries
102
+ - [Core API](./sui/clients/core.md): The transport-agnostic client contract that SDKs and libraries build against
102
103
  - [Building Transactions](./sui/transactions/basics.md): Construct programmable transaction blocks with the Transaction API
103
104
  - [Signing and Execution](./sui/transactions/signing-and-execution.md): Sign transactions and execute them on the Sui network
104
105
  - [Coins and Balances](./sui/transactions/coins-and-balances.md): Work with coin objects and address balances in transactions
@@ -117,22 +118,22 @@
117
118
  - [Derived Objects](./sui/utils/derived_objects.md): Compute derived object IDs from parent objects for deterministic offline derivation.
118
119
  - [BCS](./sui/bcs.md): Binary Canonical Serialization for encoding Sui Move types.
119
120
  - [ZkLogin](./sui/zklogin.md): Zero-knowledge authentication with OAuth providers on Sui.
120
- - [Transaction Executors](./sui/executors.md): Manage transaction execution with queuing and parallel strategies.
121
+ - [Transaction Executors](./sui/executors.md): Manage transaction execution with queuing and parallel strategies
121
122
  - [Transaction Plugins](./sui/plugins.md): Extend transaction building with reusable plugins.
122
- - [Building SDKs](./sui/sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK.
123
- - [Migrate to 2.0](./sui/migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages.
123
+ - [Building SDKs](./sui/sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
124
+ - [Migrate to 2.0](./sui/migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages
124
125
  - [Agent Migration Prompt](./sui/migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration of your codebase.
125
- - [@mysten/sui](./sui/migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0 with new client APIs and BCS changes.
126
- - [Migrating from JSON-RPC](./sui/migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API using SuiGrpcClient or SuiGraphQLClient.
127
- - [@mysten/dapp-kit](./sui/migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to the new dapp-kit-react package in 2.0.
128
- - [@mysten/kiosk](./sui/migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction.
129
- - [@mysten/zksend](./sui/migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API.
130
- - [@mysten/suins](./sui/migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0 with client extension pattern.
131
- - [@mysten/deepbook-v3](./sui/migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern.
132
- - [@mysten/walrus](./sui/migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0 with required client parameter and updated API.
126
+ - [@mysten/sui](./sui/migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0 with gRPC clients, Core API, and BCS changes
127
+ - [Migrating from JSON-RPC](./sui/migrations/sui-2.0/json-rpc-migration.md): Migrate deprecated JSON-RPC code to shared gRPC and GraphQL top-level methods
128
+ - [@mysten/dapp-kit](./sui/migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to the new dapp-kit-react package in 2.0
129
+ - [@mysten/kiosk](./sui/migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
130
+ - [@mysten/zksend](./sui/migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API
131
+ - [@mysten/suins](./sui/migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0 with client extension pattern
132
+ - [@mysten/deepbook-v3](./sui/migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern
133
+ - [@mysten/walrus](./sui/migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0 with required client parameter and updated API
133
134
  - [@mysten/seal](./sui/migrations/sui-2.0/seal.md): Migrate @mysten/seal to 2.0 with the new registration function pattern.
134
135
  - [Wallet Builders](./sui/migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers upgrading to 2.0.
135
- - [SDK Maintainers](./sui/migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors upgrading to 2.0.
136
+ - [SDK Maintainers](./sui/migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors upgrading to 2.0
136
137
  - [Migrate to 1.0](./sui/migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0 with new features and API changes.
137
138
  - [Migrate to 0.38.0](./sui/migrations/0.38.md): Migrate from SDK version 0.37 to 0.38 with updated module structure and API changes.
138
139
 
@@ -46,6 +46,9 @@ The `seal()` function accepts the following options:
46
46
  authentication
47
47
  - **`verifyKeyServers`** (optional) - Whether to verify key server authenticity (default: `true`)
48
48
  - **`timeout`** (optional) - Timeout in milliseconds for network requests (default: `10000`)
49
+ - **`fetch`** (optional) - Custom fetch implementation used for all key server requests (default:
50
+ the global `fetch`), for example to send cookies with `credentials: 'include'` or attach your own
51
+ headers
49
52
 
50
53
  ## Choosing key servers
51
54
 
package/dist/sui/bcs.md CHANGED
@@ -112,8 +112,8 @@ const serialized = bcs.Object.serialize({
112
112
  ```
113
113
 
114
114
  > **Warning:** Do not pass `objectBcs` bytes to a Move struct parser. It contains wrapping metadata that will
115
- > cause parsing to fail. Use `content` for parsing Move struct fields. See the [Core API
116
- > docs](/sui/clients/core#objectbcs) for details.
115
+ > cause parsing to fail. Use `content` for parsing Move struct fields, as described under
116
+ > [objectBcs](/sui/clients/querying#objectbcs).
117
117
 
118
118
  ## Working with transaction effects
119
119