@mysten/docs 0.1.16 → 0.1.17
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.
- package/dist/bcs/llms-index.md +1 -1
- package/dist/codegen/llms-index.md +1 -1
- package/dist/dapp-kit/llms-index.md +4 -3
- package/dist/kiosk/llms-index.md +1 -1
- package/dist/llms-index.md +16 -15
- package/dist/payment-kit/llms-index.md +1 -1
- package/dist/seal/llms-index.md +1 -1
- package/dist/slush-wallet/llms-index.md +1 -1
- package/dist/sui/llms-index.md +4 -4
- package/dist/walrus/llms-index.md +1 -1
- package/dist/zksend/llms-index.md +1 -1
- package/package.json +4 -4
package/dist/bcs/llms-index.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
# BCS
|
|
2
2
|
> Encoding and decoding Sui objects
|
|
3
3
|
|
|
4
|
-
- [BCS - Binary Canonical Serialization](
|
|
4
|
+
- [BCS - Binary Canonical Serialization](..md): Encode and decode Sui Move types with Binary Canonical Serialization
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
# TypeScript Codegen
|
|
2
2
|
> Generate type-safe TypeScript code from Sui Move packages
|
|
3
3
|
|
|
4
|
-
- [Sui TypeScript Codegen](
|
|
4
|
+
- [Sui TypeScript Codegen](..md): Generate type-safe TypeScript bindings from on-chain Sui Move packages
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# dApp Kit
|
|
2
2
|
> Build Sui dApps with @mysten/dapp-kit-core and @mysten/dapp-kit-react
|
|
3
3
|
|
|
4
|
-
- [Sui dApp Kit](
|
|
4
|
+
- [Sui dApp Kit](..md): Build Sui dApps with framework-agnostic core and React bindings
|
|
5
5
|
- [@mysten/create-dapp](./getting-started/create-dapp.md): Create a Sui dApp with one command
|
|
6
6
|
- [React](./getting-started/react.md): Set up dApp Kit in a React application
|
|
7
7
|
- [Next.js](./getting-started/next-js.md): Set up dApp Kit in a Next.js application
|
|
@@ -16,11 +16,12 @@
|
|
|
16
16
|
- [Switch Account](./actions/switch-account.md): Switch the active account in the connected wallet
|
|
17
17
|
- [Switch Network](./actions/switch-network.md): Switch the active network for the dApp Kit instance
|
|
18
18
|
- [DAppKitProvider](./react/dapp-kit-provider.md): React context provider for dApp Kit configuration
|
|
19
|
-
- [React Hooks](./react/hooks
|
|
19
|
+
- [React Hooks](./react/hooks.md): React hooks for accessing dApp Kit state and actions
|
|
20
20
|
- [useDAppKit](./react/hooks/use-dapp-kit.md): React hook to access the full dApp Kit instance
|
|
21
|
-
- [React Components](./react/components
|
|
21
|
+
- [React Components](./react/components.md): Pre-built React UI components for wallet interaction
|
|
22
22
|
- [Connect Button](./react/components/connect-button.md): React button component for wallet connection
|
|
23
23
|
- [Connect Modal](./react/components/connect-modal.md): React modal component for wallet selection
|
|
24
24
|
- [Connect Button](./web-components/connect-button.md): Framework-agnostic web component for wallet connection
|
|
25
25
|
- [Connect Modal](./web-components/connect-modal.md): Framework-agnostic web component for wallet selection
|
|
26
26
|
- [Theming](./theming.md): Customize the appearance of dApp Kit UI components
|
|
27
|
+
- [Sui dApp Kit (Legacy)](./legacy.md): dApp Kit API reference for @mysten/dapp-kit
|
package/dist/kiosk/llms-index.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Kiosk
|
|
2
2
|
> Interact with on-chain commerce applications
|
|
3
3
|
|
|
4
|
-
- [Kiosk SDK](
|
|
4
|
+
- [Kiosk SDK](..md): TypeScript SDK for interacting with Sui Kiosk on-chain commerce
|
|
5
5
|
- [Kiosk Client](./kiosk-client/introduction.md): Introduction to the KioskClient for querying and managing kiosks
|
|
6
6
|
- [Querying](./kiosk-client/querying.md): Query kiosk contents, items, and transfer policies
|
|
7
7
|
- [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and examples
|
package/dist/llms-index.md
CHANGED
|
@@ -4,17 +4,17 @@
|
|
|
4
4
|
## BCS
|
|
5
5
|
> Encoding and decoding Sui objects
|
|
6
6
|
|
|
7
|
-
- [BCS - Binary Canonical Serialization](./bcs
|
|
7
|
+
- [BCS - Binary Canonical Serialization](./bcs.md): Encode and decode Sui Move types with Binary Canonical Serialization
|
|
8
8
|
|
|
9
9
|
## TypeScript Codegen
|
|
10
10
|
> Generate type-safe TypeScript code from Sui Move packages
|
|
11
11
|
|
|
12
|
-
- [Sui TypeScript Codegen](./codegen
|
|
12
|
+
- [Sui TypeScript Codegen](./codegen.md): Generate type-safe TypeScript bindings from on-chain Sui Move packages
|
|
13
13
|
|
|
14
14
|
## dApp Kit
|
|
15
15
|
> Build Sui dApps with @mysten/dapp-kit-core and @mysten/dapp-kit-react
|
|
16
16
|
|
|
17
|
-
- [Sui dApp Kit](./dapp-kit
|
|
17
|
+
- [Sui dApp Kit](./dapp-kit.md): Build Sui dApps with framework-agnostic core and React bindings
|
|
18
18
|
- [@mysten/create-dapp](./dapp-kit/getting-started/create-dapp.md): Create a Sui dApp with one command
|
|
19
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
|
|
@@ -29,19 +29,20 @@
|
|
|
29
29
|
- [Switch Account](./dapp-kit/actions/switch-account.md): Switch the active account in the connected wallet
|
|
30
30
|
- [Switch Network](./dapp-kit/actions/switch-network.md): Switch the active network for the dApp Kit instance
|
|
31
31
|
- [DAppKitProvider](./dapp-kit/react/dapp-kit-provider.md): React context provider for dApp Kit configuration
|
|
32
|
-
- [React Hooks](./dapp-kit/react/hooks
|
|
32
|
+
- [React Hooks](./dapp-kit/react/hooks.md): React hooks for accessing dApp Kit state and actions
|
|
33
33
|
- [useDAppKit](./dapp-kit/react/hooks/use-dapp-kit.md): React hook to access the full dApp Kit instance
|
|
34
|
-
- [React Components](./dapp-kit/react/components
|
|
34
|
+
- [React Components](./dapp-kit/react/components.md): Pre-built React UI components for wallet interaction
|
|
35
35
|
- [Connect Button](./dapp-kit/react/components/connect-button.md): React button component for wallet connection
|
|
36
36
|
- [Connect Modal](./dapp-kit/react/components/connect-modal.md): React modal component for wallet selection
|
|
37
37
|
- [Connect Button](./dapp-kit/web-components/connect-button.md): Framework-agnostic web component for wallet connection
|
|
38
38
|
- [Connect Modal](./dapp-kit/web-components/connect-modal.md): Framework-agnostic web component for wallet selection
|
|
39
39
|
- [Theming](./dapp-kit/theming.md): Customize the appearance of dApp Kit UI components
|
|
40
|
+
- [Sui dApp Kit (Legacy)](./dapp-kit/legacy.md): dApp Kit API reference for @mysten/dapp-kit
|
|
40
41
|
|
|
41
42
|
## Kiosk
|
|
42
43
|
> Interact with on-chain commerce applications
|
|
43
44
|
|
|
44
|
-
- [Kiosk SDK](./kiosk
|
|
45
|
+
- [Kiosk SDK](./kiosk.md): TypeScript SDK for interacting with Sui Kiosk on-chain commerce
|
|
45
46
|
- [Kiosk Client](./kiosk/kiosk-client/introduction.md): Introduction to the KioskClient for querying and managing kiosks
|
|
46
47
|
- [Querying](./kiosk/kiosk-client/querying.md): Query kiosk contents, items, and transfer policies
|
|
47
48
|
- [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and examples
|
|
@@ -50,7 +51,7 @@
|
|
|
50
51
|
## Payment Kit
|
|
51
52
|
> Accept payments in any coin type on Sui
|
|
52
53
|
|
|
53
|
-
- [Payment Kit](./payment-kit
|
|
54
|
+
- [Payment Kit](./payment-kit.md): Accept payments in any coin type on Sui
|
|
54
55
|
- [Getting Started](./payment-kit/getting-started.md): Install and set up Payment Kit for your Sui dApp
|
|
55
56
|
- [Payment Kit SDK](./payment-kit/payment-kit-sdk.md): Payment Kit SDK API reference and configuration
|
|
56
57
|
- [Payment Processing](./payment-kit/payment-processing.md): Process payments and handle transaction results
|
|
@@ -59,24 +60,24 @@
|
|
|
59
60
|
## Seal
|
|
60
61
|
> Use Seal, a decentralized secrets management service that secures your data using threshold encryption and on-chain access control.
|
|
61
62
|
|
|
62
|
-
- [Seal SDK](./seal
|
|
63
|
+
- [Seal SDK](./seal.md): Decentralized secrets management with threshold encryption on Sui
|
|
63
64
|
|
|
64
65
|
## Slush Wallet
|
|
65
66
|
> Slush Wallet Integration
|
|
66
67
|
|
|
67
|
-
- [Slush Wallet Integration](./slush-wallet
|
|
68
|
+
- [Slush Wallet Integration](./slush-wallet.md): Integrate Slush Wallet into your Sui dApp
|
|
68
69
|
- [dApp Integration](./slush-wallet/dapp.md): Connect your dApp to Slush Wallet
|
|
69
70
|
- [Deep Linking](./slush-wallet/deep-linking.md): Deep linking configuration for Slush Wallet
|
|
70
71
|
|
|
71
72
|
## Sui SDK
|
|
72
73
|
> TypeScript interfaces for Sui
|
|
73
74
|
|
|
74
|
-
- [Sui TypeScript SDK Quick Start](./sui
|
|
75
|
+
- [Sui TypeScript SDK Quick Start](./sui.md): TypeScript SDK for building on the Sui blockchain
|
|
75
76
|
- [Install Sui TypeScript SDK](./sui/install.md): Install the @mysten/sui package and configure your project
|
|
76
77
|
- [LLM Documentation](./sui/llm-docs.md): Give AI agents access to Sui SDK documentation in your project
|
|
77
78
|
- [Hello Sui](./sui/hello-sui.md): Build your first Sui application with the TypeScript SDK
|
|
78
79
|
- [Faucet](./sui/faucet.md): Request test SUI tokens from the faucet
|
|
79
|
-
- [Sui Clients](./sui/clients
|
|
80
|
+
- [Sui Clients](./sui/clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients
|
|
80
81
|
- [Core API](./sui/clients/core.md): Transport-agnostic Core API shared by all Sui clients
|
|
81
82
|
- [SuiGrpcClient](./sui/clients/grpc.md): Connect to Sui via gRPC with SuiGrpcClient
|
|
82
83
|
- [SuiGraphQLClient](./sui/clients/graphql.md): Connect to Sui via GraphQL with SuiGraphQLClient
|
|
@@ -90,14 +91,14 @@
|
|
|
90
91
|
- [Multi-Signature Transactions](./sui/cryptography/multisig.md): Create multi-signature transactions with multiple signers
|
|
91
92
|
- [Passkey](./sui/cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing
|
|
92
93
|
- [Web Crypto Signer](./sui/cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto API
|
|
93
|
-
- [The `@mysten/sui/utils` package](./sui/utils
|
|
94
|
+
- [The `@mysten/sui/utils` package](./sui/utils.md): Utility functions for addresses, coins, and common operations
|
|
94
95
|
- [Derived Objects](./sui/utils/derived_objects.md): Compute derived object IDs from parent objects
|
|
95
96
|
- [BCS](./sui/bcs.md): Binary Canonical Serialization for encoding Sui Move types
|
|
96
97
|
- [ZkLogin](./sui/zklogin.md): Zero-knowledge authentication with OAuth providers on Sui
|
|
97
98
|
- [Transaction Executors](./sui/executors.md): Manage transaction execution with queuing and parallel strategies
|
|
98
99
|
- [Transaction Plugins](./sui/plugins.md): Extend transaction building with reusable plugins
|
|
99
100
|
- [Building SDKs](./sui/sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
|
|
100
|
-
- [Migrate to 2.0](./sui/migrations/sui-2.0
|
|
101
|
+
- [Migrate to 2.0](./sui/migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0
|
|
101
102
|
- [Agent Migration Prompt](./sui/migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration
|
|
102
103
|
- [@mysten/sui](./sui/migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0
|
|
103
104
|
- [Migrating from JSON-RPC](./sui/migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API
|
|
@@ -116,10 +117,10 @@
|
|
|
116
117
|
## Walrus
|
|
117
118
|
> Publish and Read blobs directly from walrus storage nodes
|
|
118
119
|
|
|
119
|
-
- [Walrus SDK](./walrus
|
|
120
|
+
- [Walrus SDK](./walrus.md): Store and retrieve blobs on Walrus decentralized storage
|
|
120
121
|
|
|
121
122
|
## ZkSend
|
|
122
123
|
> Send Sui with a link
|
|
123
124
|
|
|
124
|
-
- [zkSend SDK](./zksend
|
|
125
|
+
- [zkSend SDK](./zksend.md): Send Sui assets via shareable links with zkSend
|
|
125
126
|
- [Creating zkSend Links](./zksend/link-builder.md): Create and customize zkSend claim links
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Payment Kit
|
|
2
2
|
> Accept payments in any coin type on Sui
|
|
3
3
|
|
|
4
|
-
- [Payment Kit](
|
|
4
|
+
- [Payment Kit](..md): Accept payments in any coin type on Sui
|
|
5
5
|
- [Getting Started](./getting-started.md): Install and set up Payment Kit for your Sui dApp
|
|
6
6
|
- [Payment Kit SDK](./payment-kit-sdk.md): Payment Kit SDK API reference and configuration
|
|
7
7
|
- [Payment Processing](./payment-processing.md): Process payments and handle transaction results
|
package/dist/seal/llms-index.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
# Seal
|
|
2
2
|
> Use Seal, a decentralized secrets management service that secures your data using threshold encryption and on-chain access control.
|
|
3
3
|
|
|
4
|
-
- [Seal SDK](
|
|
4
|
+
- [Seal SDK](..md): Decentralized secrets management with threshold encryption on Sui
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Slush Wallet
|
|
2
2
|
> Slush Wallet Integration
|
|
3
3
|
|
|
4
|
-
- [Slush Wallet Integration](
|
|
4
|
+
- [Slush Wallet Integration](..md): Integrate Slush Wallet into your Sui dApp
|
|
5
5
|
- [dApp Integration](./dapp.md): Connect your dApp to Slush Wallet
|
|
6
6
|
- [Deep Linking](./deep-linking.md): Deep linking configuration for Slush Wallet
|
package/dist/sui/llms-index.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Sui SDK
|
|
2
2
|
> TypeScript interfaces for Sui
|
|
3
3
|
|
|
4
|
-
- [Sui TypeScript SDK Quick Start](
|
|
4
|
+
- [Sui TypeScript SDK Quick Start](..md): TypeScript SDK for building on the Sui blockchain
|
|
5
5
|
- [Install Sui TypeScript SDK](./install.md): Install the @mysten/sui package and configure your project
|
|
6
6
|
- [LLM Documentation](./llm-docs.md): Give AI agents access to Sui SDK documentation in your project
|
|
7
7
|
- [Hello Sui](./hello-sui.md): Build your first Sui application with the TypeScript SDK
|
|
8
8
|
- [Faucet](./faucet.md): Request test SUI tokens from the faucet
|
|
9
|
-
- [Sui Clients](./clients
|
|
9
|
+
- [Sui Clients](./clients.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients
|
|
10
10
|
- [Core API](./clients/core.md): Transport-agnostic Core API shared by all Sui clients
|
|
11
11
|
- [SuiGrpcClient](./clients/grpc.md): Connect to Sui via gRPC with SuiGrpcClient
|
|
12
12
|
- [SuiGraphQLClient](./clients/graphql.md): Connect to Sui via GraphQL with SuiGraphQLClient
|
|
@@ -20,14 +20,14 @@
|
|
|
20
20
|
- [Multi-Signature Transactions](./cryptography/multisig.md): Create multi-signature transactions with multiple signers
|
|
21
21
|
- [Passkey](./cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing
|
|
22
22
|
- [Web Crypto Signer](./cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto API
|
|
23
|
-
- [The `@mysten/sui/utils` package](./utils
|
|
23
|
+
- [The `@mysten/sui/utils` package](./utils.md): Utility functions for addresses, coins, and common operations
|
|
24
24
|
- [Derived Objects](./utils/derived_objects.md): Compute derived object IDs from parent objects
|
|
25
25
|
- [BCS](./bcs.md): Binary Canonical Serialization for encoding Sui Move types
|
|
26
26
|
- [ZkLogin](./zklogin.md): Zero-knowledge authentication with OAuth providers on Sui
|
|
27
27
|
- [Transaction Executors](./executors.md): Manage transaction execution with queuing and parallel strategies
|
|
28
28
|
- [Transaction Plugins](./plugins.md): Extend transaction building with reusable plugins
|
|
29
29
|
- [Building SDKs](./sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
|
|
30
|
-
- [Migrate to 2.0](./migrations/sui-2.0
|
|
30
|
+
- [Migrate to 2.0](./migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0
|
|
31
31
|
- [Agent Migration Prompt](./migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration
|
|
32
32
|
- [@mysten/sui](./migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0
|
|
33
33
|
- [Migrating from JSON-RPC](./migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to the new Core API
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# ZkSend
|
|
2
2
|
> Send Sui with a link
|
|
3
3
|
|
|
4
|
-
- [zkSend SDK](
|
|
4
|
+
- [zkSend SDK](..md): Send Sui assets via shareable links with zkSend
|
|
5
5
|
- [Creating zkSend Links](./link-builder.md): Create and customize zkSend claim links
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mysten/docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.17",
|
|
4
4
|
"description": "LLM-friendly documentation for the Sui TypeScript SDK ecosystem",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -23,14 +23,14 @@
|
|
|
23
23
|
"fumadocs-typescript": "^5.2.0",
|
|
24
24
|
"fumadocs-ui": "16.4.7",
|
|
25
25
|
"gray-matter": "^4.0.3",
|
|
26
|
-
"next": "^16.
|
|
26
|
+
"next": "^16.2.3",
|
|
27
27
|
"react": "^19.2.3",
|
|
28
28
|
"react-dom": "^19.2.3",
|
|
29
29
|
"@mysten/bcs": "2.0.3",
|
|
30
30
|
"@mysten/dapp-kit": "1.0.4",
|
|
31
31
|
"@mysten/dapp-kit-core": "1.3.0",
|
|
32
32
|
"@mysten/dapp-kit-react": "2.0.1",
|
|
33
|
-
"@mysten/deepbook-v3": "1.
|
|
33
|
+
"@mysten/deepbook-v3": "1.3.0",
|
|
34
34
|
"@mysten/enoki": "1.0.4",
|
|
35
35
|
"@mysten/enoki-connect": "1.0.2",
|
|
36
36
|
"@mysten/kiosk": "1.2.1",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"@mysten/signers": "1.0.2",
|
|
40
40
|
"@mysten/slush-wallet": "1.0.3",
|
|
41
41
|
"@mysten/sui": "2.15.0",
|
|
42
|
-
"@mysten/suins": "1.0.
|
|
42
|
+
"@mysten/suins": "1.0.4",
|
|
43
43
|
"@mysten/utils": "0.3.1",
|
|
44
44
|
"@mysten/wallet-standard": "0.20.1",
|
|
45
45
|
"@mysten/walrus": "1.1.1",
|