@mysten/docs 0.1.20 → 0.1.22
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/dapp-kit/getting-started/next-js.md +1 -1
- package/dist/dapp-kit/getting-started/react.md +1 -1
- package/dist/dapp-kit/getting-started/vue.md +1 -1
- package/dist/dapp-kit/llms-index.md +6 -0
- package/dist/kiosk/llms-index.md +6 -0
- package/dist/llms-index.md +14 -2
- package/dist/sui/clients/grpc.md +2 -2
- package/dist/sui/cryptography/webcrypto-signer.md +2 -2
- package/dist/sui/llms-index.md +2 -2
- package/package.json +30 -24
|
@@ -153,7 +153,7 @@ imports or are inside a `'use client'` component that's dynamically imported.
|
|
|
153
153
|
## Example application
|
|
154
154
|
|
|
155
155
|
See the complete
|
|
156
|
-
[Next.js example](https://github.com/MystenLabs/ts-sdks/tree/main/packages/dapp-kit
|
|
156
|
+
[Next.js example](https://github.com/MystenLabs/ts-sdks/tree/main/packages/dapp-kit/examples/next-js/simple)
|
|
157
157
|
on GitHub.
|
|
158
158
|
|
|
159
159
|
## Next steps
|
|
@@ -161,7 +161,7 @@ function TransferButton() {
|
|
|
161
161
|
## Example application
|
|
162
162
|
|
|
163
163
|
See the complete
|
|
164
|
-
[React example](https://github.com/MystenLabs/ts-sdks/tree/main/packages/dapp-kit
|
|
164
|
+
[React example](https://github.com/MystenLabs/ts-sdks/tree/main/packages/dapp-kit/examples/react/simple)
|
|
165
165
|
on GitHub.
|
|
166
166
|
|
|
167
167
|
## Next steps
|
|
@@ -182,7 +182,7 @@ See [State Management](/dapp-kit/state) for full documentation.
|
|
|
182
182
|
## Example application
|
|
183
183
|
|
|
184
184
|
See the complete
|
|
185
|
-
[Vue example](https://github.com/MystenLabs/ts-sdks/tree/main/packages/dapp-kit
|
|
185
|
+
[Vue example](https://github.com/MystenLabs/ts-sdks/tree/main/packages/dapp-kit/examples/vue/simple)
|
|
186
186
|
on GitHub.
|
|
187
187
|
|
|
188
188
|
## Next steps
|
|
@@ -18,6 +18,12 @@
|
|
|
18
18
|
- [DAppKitProvider](./react/dapp-kit-provider.md): React context provider that makes dApp Kit available throughout your application.
|
|
19
19
|
- [React Hooks](./react/hooks.md): React hooks for accessing dApp Kit state and actions in Sui applications.
|
|
20
20
|
- [useDAppKit](./react/hooks/use-dapp-kit.md): React hook to access the full dApp Kit instance for calling actions directly.
|
|
21
|
+
- [useCurrentAccount](./react/hooks/use-current-account.md): React hook to get the currently selected wallet account in a Sui dApp.
|
|
22
|
+
- [useCurrentClient](./react/hooks/use-current-client.md): React hook to get the current Sui client instance for the active network.
|
|
23
|
+
- [useCurrentNetwork](./react/hooks/use-current-network.md): React hook to get the currently selected Sui network in dApp Kit.
|
|
24
|
+
- [useCurrentWallet](./react/hooks/use-current-wallet.md): React hook to get the currently connected wallet in a Sui dApp.
|
|
25
|
+
- [useWalletConnection](./react/hooks/use-wallet-connection.md): React hook to manage wallet connection status and information in a Sui dApp.
|
|
26
|
+
- [useWallets](./react/hooks/use-wallets.md): React hook to list all available Sui wallets detected by dApp Kit.
|
|
21
27
|
- [React Components](./react/components.md): Pre-built React UI components for wallet interaction in Sui dApps.
|
|
22
28
|
- [Connect Button](./react/components/connect-button.md): React button component for connecting and disconnecting Sui wallets.
|
|
23
29
|
- [Connect Modal](./react/components/connect-modal.md): React modal component for selecting and connecting to a Sui wallet.
|
package/dist/kiosk/llms-index.md
CHANGED
|
@@ -4,5 +4,11 @@
|
|
|
4
4
|
- [Kiosk SDK](..md): TypeScript SDK for interacting with Sui Kiosk onchain commerce.
|
|
5
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
|
+
- [KioskTransaction](./kiosk-client/kiosk-transaction/kiosk-transaction.md): Build kiosk transactions for listing, purchasing, and managing items on Sui.
|
|
8
|
+
- [Managing Owned Kiosk](./kiosk-client/kiosk-transaction/managing.md): Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
9
|
+
- [Purchasing from a kiosk](./kiosk-client/kiosk-transaction/purchasing.md): Purchase items from kiosks with automatic transfer policy rule resolution.
|
|
10
|
+
- [Examples](./kiosk-client/kiosk-transaction/examples.md): Practical code examples for kiosk transactions including minting, listing, and purchasing.
|
|
11
|
+
- [TransferPolicyTransaction](./kiosk-client/transfer-policy-transaction/introduction.md): Create and manage transfer policies for kiosk items using the Kiosk SDK.
|
|
12
|
+
- [Using the manager](./kiosk-client/transfer-policy-transaction/using-the-manager.md): Use the TransferPolicyTransaction manager to add rules and withdraw profits.
|
|
7
13
|
- [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios.
|
|
8
14
|
- [Migrating from Kiosk SDK V1](./from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API.
|
package/dist/llms-index.md
CHANGED
|
@@ -31,6 +31,12 @@
|
|
|
31
31
|
- [DAppKitProvider](./dapp-kit/react/dapp-kit-provider.md): React context provider that makes dApp Kit available throughout your application.
|
|
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
|
+
- [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.
|
|
36
|
+
- [useCurrentNetwork](./dapp-kit/react/hooks/use-current-network.md): React hook to get the currently selected Sui network in dApp Kit.
|
|
37
|
+
- [useCurrentWallet](./dapp-kit/react/hooks/use-current-wallet.md): React hook to get the currently connected wallet in a Sui dApp.
|
|
38
|
+
- [useWalletConnection](./dapp-kit/react/hooks/use-wallet-connection.md): React hook to manage wallet connection status and information in a Sui dApp.
|
|
39
|
+
- [useWallets](./dapp-kit/react/hooks/use-wallets.md): React hook to list all available Sui wallets detected by dApp Kit.
|
|
34
40
|
- [React Components](./dapp-kit/react/components.md): Pre-built React UI components for wallet interaction in Sui dApps.
|
|
35
41
|
- [Connect Button](./dapp-kit/react/components/connect-button.md): React button component for connecting and disconnecting Sui wallets.
|
|
36
42
|
- [Connect Modal](./dapp-kit/react/components/connect-modal.md): React modal component for selecting and connecting to a Sui wallet.
|
|
@@ -45,6 +51,12 @@
|
|
|
45
51
|
- [Kiosk SDK](./kiosk.md): TypeScript SDK for interacting with Sui Kiosk onchain commerce.
|
|
46
52
|
- [Kiosk Client](./kiosk/kiosk-client/introduction.md): Introduction to the KioskClient extension for querying and managing kiosks on Sui.
|
|
47
53
|
- [Querying](./kiosk/kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
|
|
54
|
+
- [KioskTransaction](./kiosk/kiosk-client/kiosk-transaction/kiosk-transaction.md): Build kiosk transactions for listing, purchasing, and managing items on Sui.
|
|
55
|
+
- [Managing Owned Kiosk](./kiosk/kiosk-client/kiosk-transaction/managing.md): Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
56
|
+
- [Purchasing from a kiosk](./kiosk/kiosk-client/kiosk-transaction/purchasing.md): Purchase items from kiosks with automatic transfer policy rule resolution.
|
|
57
|
+
- [Examples](./kiosk/kiosk-client/kiosk-transaction/examples.md): Practical code examples for kiosk transactions including minting, listing, and purchasing.
|
|
58
|
+
- [TransferPolicyTransaction](./kiosk/kiosk-client/transfer-policy-transaction/introduction.md): Create and manage transfer policies for kiosk items using the Kiosk SDK.
|
|
59
|
+
- [Using the manager](./kiosk/kiosk-client/transfer-policy-transaction/using-the-manager.md): Use the TransferPolicyTransaction manager to add rules and withdraw profits.
|
|
48
60
|
- [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios.
|
|
49
61
|
- [Migrating from Kiosk SDK V1](./kiosk/from-v1.md): Migrate from Kiosk SDK v1 to the current version with the builder-pattern API.
|
|
50
62
|
|
|
@@ -84,9 +96,9 @@
|
|
|
84
96
|
- [SuiJsonRpcClient](./sui/clients/json-rpc.md): Connect to Sui through JSON-RPC with SuiJsonRpcClient.
|
|
85
97
|
- [Sui Programmable Transaction Basics](./sui/transaction-building/basics.md): Construct programmable transaction blocks with the Transaction API.
|
|
86
98
|
- [Paying for Sui Transactions with Gas Coins](./sui/transaction-building/gas.md): Configure gas budget, price, and coin selection for Sui transactions.
|
|
87
|
-
- [Transaction Intents](./sui/transaction-building/intents.md): Use high-level intents to simplify transaction building.
|
|
88
|
-
- [Building Offline](./sui/transaction-building/offline.md): Build transactions without a network connection.
|
|
89
99
|
- [Sponsored Transactions](./sui/transaction-building/sponsored-transactions.md): Pay gas fees on behalf of other users with sponsored transactions.
|
|
100
|
+
- [Building Offline](./sui/transaction-building/offline.md): Build transactions without a network connection.
|
|
101
|
+
- [Transaction Intents](./sui/transaction-building/intents.md): Use high-level intents to simplify transaction building.
|
|
90
102
|
- [Key pairs](./sui/cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1 keypairs for Sui transaction signing.
|
|
91
103
|
- [Multi-Signature Transactions](./sui/cryptography/multisig.md): Create multi-signature transactions with multiple signers on Sui.
|
|
92
104
|
- [Passkey](./sui/cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing.
|
package/dist/sui/clients/grpc.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
The `SuiGrpcClient` provides access to the Full Node gRPC API.
|
|
6
6
|
|
|
7
7
|
For more complete details on what is available through this API see the
|
|
8
|
-
[gRPC API docs](https://docs.sui.io/
|
|
8
|
+
[gRPC API docs](https://docs.sui.io/develop/accessing-data/grpc/what-is-grpc).
|
|
9
9
|
|
|
10
10
|
## Creating a gRPC client
|
|
11
11
|
|
|
@@ -103,7 +103,7 @@ const grpcClient = new SuiGrpcClient({
|
|
|
103
103
|
The `SuiGrpcClient` exposes several service clients for lower-level access to the gRPC API. These
|
|
104
104
|
service clients are generated using [protobuf-ts](https://github.com/timostamm/protobuf-ts), which
|
|
105
105
|
provides type-safe gRPC clients for TypeScript. For more details on how to use gRPC with Sui, see
|
|
106
|
-
the [gRPC overview](https://docs.sui.io/
|
|
106
|
+
the [gRPC overview](https://docs.sui.io/develop/accessing-data/grpc/what-is-grpc).
|
|
107
107
|
|
|
108
108
|
### With the core API
|
|
109
109
|
|
|
@@ -16,10 +16,10 @@ Common use cases for the Web Crypto Signer include:
|
|
|
16
16
|
|
|
17
17
|
## Installation
|
|
18
18
|
|
|
19
|
-
To use the Web Crypto Signer, you need to install the `@mysten/
|
|
19
|
+
To use the Web Crypto Signer, you need to install the `@mysten/webcrypto-signer` package.
|
|
20
20
|
|
|
21
21
|
```sh npm2yarn
|
|
22
|
-
npm i @mysten/
|
|
22
|
+
npm i @mysten/webcrypto-signer
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
You can then import the `WebCryptoSigner` class from the package:
|
package/dist/sui/llms-index.md
CHANGED
|
@@ -13,9 +13,9 @@
|
|
|
13
13
|
- [SuiJsonRpcClient](./clients/json-rpc.md): Connect to Sui through JSON-RPC with SuiJsonRpcClient.
|
|
14
14
|
- [Sui Programmable Transaction Basics](./transaction-building/basics.md): Construct programmable transaction blocks with the Transaction API.
|
|
15
15
|
- [Paying for Sui Transactions with Gas Coins](./transaction-building/gas.md): Configure gas budget, price, and coin selection for Sui transactions.
|
|
16
|
-
- [Transaction Intents](./transaction-building/intents.md): Use high-level intents to simplify transaction building.
|
|
17
|
-
- [Building Offline](./transaction-building/offline.md): Build transactions without a network connection.
|
|
18
16
|
- [Sponsored Transactions](./transaction-building/sponsored-transactions.md): Pay gas fees on behalf of other users with sponsored transactions.
|
|
17
|
+
- [Building Offline](./transaction-building/offline.md): Build transactions without a network connection.
|
|
18
|
+
- [Transaction Intents](./transaction-building/intents.md): Use high-level intents to simplify transaction building.
|
|
19
19
|
- [Key pairs](./cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1 keypairs for Sui transaction signing.
|
|
20
20
|
- [Multi-Signature Transactions](./cryptography/multisig.md): Create multi-signature transactions with multiple signers on Sui.
|
|
21
21
|
- [Passkey](./cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mysten/docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.22",
|
|
4
4
|
"description": "LLM-friendly documentation for the Sui TypeScript SDK ecosystem",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -14,6 +14,9 @@
|
|
|
14
14
|
"files": [
|
|
15
15
|
"dist/"
|
|
16
16
|
],
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=24"
|
|
19
|
+
},
|
|
17
20
|
"dependencies": {
|
|
18
21
|
"@tanstack/react-query": "^5.90.16",
|
|
19
22
|
"fast-glob": "^3.3.3",
|
|
@@ -22,28 +25,31 @@
|
|
|
22
25
|
"fumadocs-mdx": "14.2.5",
|
|
23
26
|
"fumadocs-typescript": "^5.2.0",
|
|
24
27
|
"fumadocs-ui": "16.4.7",
|
|
25
|
-
"
|
|
26
|
-
"next": "^16.2.3",
|
|
28
|
+
"next": "^16.2.4",
|
|
27
29
|
"react": "^19.2.3",
|
|
28
30
|
"react-dom": "^19.2.3",
|
|
29
|
-
"@mysten/
|
|
30
|
-
"@mysten/
|
|
31
|
-
"@mysten/dapp-kit-
|
|
32
|
-
"@mysten/dapp-kit-
|
|
33
|
-
"@mysten/
|
|
34
|
-
"@mysten/
|
|
35
|
-
"@mysten/enoki
|
|
36
|
-
"@mysten/
|
|
37
|
-
"@mysten/
|
|
38
|
-
"@mysten/
|
|
39
|
-
"@mysten/
|
|
40
|
-
"@mysten/
|
|
41
|
-
"@mysten/
|
|
42
|
-
"@mysten/
|
|
43
|
-
"@mysten/
|
|
44
|
-
"@mysten/wallet-standard": "0.20.
|
|
45
|
-
"@mysten/
|
|
46
|
-
"@mysten/
|
|
31
|
+
"@mysten/dapp-kit": "1.0.5",
|
|
32
|
+
"@mysten/bcs": "2.0.4",
|
|
33
|
+
"@mysten/dapp-kit-react": "2.0.2",
|
|
34
|
+
"@mysten/dapp-kit-core": "1.3.1",
|
|
35
|
+
"@mysten/aws-kms-signer": "0.1.1",
|
|
36
|
+
"@mysten/deepbook-v3": "1.3.5",
|
|
37
|
+
"@mysten/enoki": "1.0.6",
|
|
38
|
+
"@mysten/enoki-connect": "1.0.3",
|
|
39
|
+
"@mysten/gcp-kms-signer": "0.1.1",
|
|
40
|
+
"@mysten/kiosk": "1.2.5",
|
|
41
|
+
"@mysten/ledger-signer": "0.1.1",
|
|
42
|
+
"@mysten/payment-kit": "0.1.10",
|
|
43
|
+
"@mysten/seal": "1.1.2",
|
|
44
|
+
"@mysten/signers": "1.0.4",
|
|
45
|
+
"@mysten/slush-wallet": "1.0.4",
|
|
46
|
+
"@mysten/wallet-standard": "0.20.2",
|
|
47
|
+
"@mysten/utils": "0.3.2",
|
|
48
|
+
"@mysten/webcrypto-signer": "0.1.1",
|
|
49
|
+
"@mysten/suins": "1.1.3",
|
|
50
|
+
"@mysten/sui": "2.16.1",
|
|
51
|
+
"@mysten/zksend": "1.1.1",
|
|
52
|
+
"@mysten/walrus": "1.1.5"
|
|
47
53
|
},
|
|
48
54
|
"devDependencies": {
|
|
49
55
|
"@tailwindcss/postcss": "^4.1.18",
|
|
@@ -51,7 +57,7 @@
|
|
|
51
57
|
"@types/node": "^25.0.8",
|
|
52
58
|
"@types/react": "^19.2.8",
|
|
53
59
|
"@types/react-dom": "^19.2.3",
|
|
54
|
-
"postcss": "^8.5.
|
|
60
|
+
"postcss": "^8.5.14",
|
|
55
61
|
"tailwindcss": "^4.1.18",
|
|
56
62
|
"typedoc": "^0.28.16",
|
|
57
63
|
"typedoc-plugin-mermaid": "^1.12.0",
|
|
@@ -59,11 +65,11 @@
|
|
|
59
65
|
},
|
|
60
66
|
"scripts": {
|
|
61
67
|
"build": "typedoc && next build && pnpm run build:docs",
|
|
62
|
-
"build:docs": "
|
|
68
|
+
"build:docs": "node scripts/build-docs.ts --all",
|
|
63
69
|
"dev": "next dev",
|
|
64
70
|
"start": "next start",
|
|
65
71
|
"postinstall": "fumadocs-mdx",
|
|
66
|
-
"validate-docs": "
|
|
72
|
+
"validate-docs": "node scripts/validate-llm-docs.ts",
|
|
67
73
|
"prettier:check": "prettier -c --ignore-unknown .",
|
|
68
74
|
"prettier:fix": "prettier -w --ignore-unknown .",
|
|
69
75
|
"oxlint:check": "oxlint .",
|