@mysten/docs 0.1.47 → 0.1.49
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/actions/connect-wallet.md +1 -1
- package/dist/dapp-kit/actions/disconnect-wallet.md +1 -1
- package/dist/dapp-kit/actions/sign-personal-message.md +1 -1
- package/dist/dapp-kit/actions/sign-transaction.md +1 -1
- package/dist/dapp-kit/actions/switch-account.md +1 -1
- package/dist/dapp-kit/actions/switch-network.md +1 -1
- package/dist/dapp-kit/llms-index.md +10 -10
- package/dist/dapp-kit/react/dapp-kit-provider.md +1 -1
- package/dist/dapp-kit/web-components/connect-button.md +1 -1
- package/dist/dapp-kit/web-components/connect-modal.md +1 -1
- package/dist/kiosk/kiosk-client/introduction.md +1 -1
- package/dist/kiosk/kiosk-client/kiosk-transaction/examples.md +1 -1
- package/dist/kiosk/kiosk-client/kiosk-transaction/managing.md +1 -1
- package/dist/kiosk/kiosk-client/querying.md +1 -1
- package/dist/kiosk/llms-index.md +4 -4
- package/dist/llms-index.md +32 -32
- package/dist/payment-kit/index.md +1 -1
- package/dist/payment-kit/llms-index.md +3 -3
- package/dist/payment-kit/payment-processing.md +1 -1
- package/dist/payment-kit/registry-management.md +1 -1
- package/dist/slush-wallet/dapp.md +1 -1
- package/dist/slush-wallet/deep-linking.md +1 -1
- package/dist/slush-wallet/index.md +1 -1
- package/dist/slush-wallet/llms-index.md +3 -3
- package/dist/sui/clients/grpc.md +1 -1
- package/dist/sui/clients/index.md +1 -1
- package/dist/sui/cryptography/index.md +1 -1
- package/dist/sui/cryptography/keypairs.md +1 -1
- package/dist/sui/cryptography/signers/index.md +1 -1
- package/dist/sui/cryptography/signers/webcrypto.md +1 -1
- package/dist/sui/llms-index.md +11 -11
- package/dist/sui/migrations/0.38.md +1 -1
- package/dist/sui/migrations/sui-2.0/kiosk.md +1 -1
- package/dist/sui/migrations/sui-2.0/sui.md +1 -1
- package/dist/sui/utils/derived_objects.md +1 -1
- package/dist/sui/utils/index.md +1 -1
- package/dist/walrus/index.md +1 -1
- package/dist/walrus/llms-index.md +1 -1
- package/package.json +21 -21
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Connect Wallet
|
|
2
2
|
|
|
3
|
-
> Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
|
|
3
|
+
> >- Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
|
|
4
4
|
|
|
5
5
|
The dApp Kit SDK provides an action for wallet connection, allowing users to connect, disconnect,
|
|
6
6
|
and switch between wallets and accounts.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Disconnect Wallet
|
|
2
2
|
|
|
3
|
-
> Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
|
|
3
|
+
> >- Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
|
|
4
4
|
|
|
5
5
|
The `disconnectWallet` action terminates the connection with the currently connected wallet.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Sign Personal Message
|
|
2
2
|
|
|
3
|
-
> Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
|
|
3
|
+
> >- Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
|
|
4
4
|
|
|
5
5
|
The `signPersonalMessage` action prompts the connected wallet to sign a personal message. This is
|
|
6
6
|
useful for authentication, proof of ownership, or other scenarios where you need cryptographic proof
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Sign Transaction
|
|
2
2
|
|
|
3
|
-
> Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
|
|
3
|
+
> >- Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
|
|
4
4
|
|
|
5
5
|
The `signTransaction` action prompts the connected wallet to sign a transaction without executing
|
|
6
6
|
it. This is useful when you need a signed transaction for later execution or for multi-signature
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Switch Account
|
|
2
2
|
|
|
3
|
-
> Switch the active account in the connected wallet using the dApp Kit switchAccount action.
|
|
3
|
+
> >- Switch the active account in the connected wallet using the dApp Kit switchAccount action.
|
|
4
4
|
|
|
5
5
|
The `switchAccount` action changes the currently selected account to a different account from the
|
|
6
6
|
connected wallet.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Switch Network
|
|
2
2
|
|
|
3
|
-
> Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
|
|
3
|
+
> >- Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
|
|
4
4
|
|
|
5
5
|
The `switchNetwork` action changes the currently selected network that the dApp Kit client is
|
|
6
6
|
configured to use.
|
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
- [Vue](./getting-started/vue.md): Set up dApp Kit in a Vue application
|
|
9
9
|
- [DApp Kit Instance](./dapp-kit-instance.md): Create and configure a DAppKit instance for wallet and client management
|
|
10
10
|
- [State](./state.md): Access and subscribe to wallet connection state in dApp Kit
|
|
11
|
-
- [Connect Wallet](./actions/connect-wallet.md): Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
|
|
12
|
-
- [Disconnect Wallet](./actions/disconnect-wallet.md): Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
|
|
11
|
+
- [Connect Wallet](./actions/connect-wallet.md): >- Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
|
|
12
|
+
- [Disconnect Wallet](./actions/disconnect-wallet.md): >- Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
|
|
13
13
|
- [Sign and Execute Transaction](./actions/sign-and-execute-transaction.md): Sign and execute a transaction on the Sui network using the connected wallet.
|
|
14
|
-
- [Sign Personal Message](./actions/sign-personal-message.md): Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
|
|
15
|
-
- [Sign Transaction](./actions/sign-transaction.md): Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
|
|
16
|
-
- [Switch Account](./actions/switch-account.md): Switch the active account in the connected wallet using the dApp Kit switchAccount action.
|
|
17
|
-
- [Switch Network](./actions/switch-network.md): Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
|
|
18
|
-
- [DAppKitProvider](./react/dapp-kit-provider.md): React context provider that makes dApp Kit available throughout your application.
|
|
14
|
+
- [Sign Personal Message](./actions/sign-personal-message.md): >- Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
|
|
15
|
+
- [Sign Transaction](./actions/sign-transaction.md): >- Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
|
|
16
|
+
- [Switch Account](./actions/switch-account.md): >- Switch the active account in the connected wallet using the dApp Kit switchAccount action.
|
|
17
|
+
- [Switch Network](./actions/switch-network.md): >- Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
|
|
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
21
|
- [useCurrentAccount](./react/hooks/use-current-account.md): React hook to get the currently selected wallet account in a Sui dApp.
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
- [React Components](./react/components.md): Pre-built React UI components for wallet interaction in Sui dApps.
|
|
28
28
|
- [Connect Button](./react/components/connect-button.md): React button component for connecting and disconnecting Sui wallets.
|
|
29
29
|
- [Connect Modal](./react/components/connect-modal.md): React modal component for selecting and connecting to a Sui wallet.
|
|
30
|
-
- [Connect Button](./web-components/connect-button.md): Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
|
|
31
|
-
- [Connect Modal](./web-components/connect-modal.md): Framework-agnostic web component for wallet selection and connection in Sui dApps.
|
|
30
|
+
- [Connect Button](./web-components/connect-button.md): >- Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
|
|
31
|
+
- [Connect Modal](./web-components/connect-modal.md): >- Framework-agnostic web component for wallet selection and connection in Sui dApps.
|
|
32
32
|
- [Theming](./theming.md): Customize the appearance of dApp Kit UI components.
|
|
33
|
-
- [Sui dApp Kit (Legacy)](./legacy.md): Legacy dApp Kit API reference for the deprecated @mysten/dapp-kit package using JSON RPC.
|
|
33
|
+
- [Sui dApp Kit (Legacy)](./legacy.md): >- Legacy dApp Kit API reference for the deprecated @mysten/dapp-kit package using JSON RPC.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# DAppKitProvider
|
|
2
2
|
|
|
3
|
-
> React context provider that makes dApp Kit available throughout your application.
|
|
3
|
+
> >- React context provider that makes dApp Kit available throughout your application.
|
|
4
4
|
|
|
5
5
|
The `DAppKitProvider` is a React context provider that makes your dApp Kit instance available
|
|
6
6
|
throughout your React application. It must wrap any components that use dApp Kit hooks.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Connect Button
|
|
2
2
|
|
|
3
|
-
> Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
|
|
3
|
+
> >- Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
|
|
4
4
|
|
|
5
5
|
The `<mysten-dapp-kit-connect-button>` Web Component provides a complete wallet connection UI. It
|
|
6
6
|
displays a "Connect Wallet" button when no wallet is connected, and shows the connected account with
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Connect Modal
|
|
2
2
|
|
|
3
|
-
> Framework-agnostic web component for wallet selection and connection in Sui dApps.
|
|
3
|
+
> >- Framework-agnostic web component for wallet selection and connection in Sui dApps.
|
|
4
4
|
|
|
5
5
|
The `<mysten-dapp-kit-connect-modal>` Web Component provides a modal dialog for wallet connection.
|
|
6
6
|
While most apps should use the [`Connect Button`](./connect-button) which includes an integrated
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Kiosk Client
|
|
2
2
|
|
|
3
|
-
> Introduction to the KioskClient extension for querying and managing kiosks on Sui
|
|
3
|
+
> >- Introduction to the KioskClient extension for querying and managing kiosks on Sui
|
|
4
4
|
|
|
5
5
|
The Kiosk SDK exports a client extension that provides all Kiosk functionality.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Examples
|
|
2
2
|
|
|
3
|
-
> Practical code examples for kiosk transactions including minting, listing, and purchasing.
|
|
3
|
+
> >- Practical code examples for kiosk transactions including minting, listing, and purchasing.
|
|
4
4
|
|
|
5
5
|
The following app-focused examples demonstrate how to use the SDK to interact with Kiosk.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Managing Owned Kiosk
|
|
2
2
|
|
|
3
|
-
> Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
3
|
+
> >- Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
4
4
|
|
|
5
5
|
The kiosk extension (`client.kiosk`) helps in managing a kiosk.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Querying
|
|
2
2
|
|
|
3
|
-
> Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
|
|
3
|
+
> >- Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
|
|
4
4
|
|
|
5
5
|
You can use `client.kiosk` to query kiosk data. It helps you get owned kiosks for an address, as
|
|
6
6
|
well as fetching all the contents of a specified kiosk.
|
package/dist/kiosk/llms-index.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
> Interact with on-chain commerce applications
|
|
3
3
|
|
|
4
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
|
-
- [Querying](./kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
|
|
5
|
+
- [Kiosk Client](./kiosk-client/introduction.md): >- Introduction to the KioskClient extension for querying and managing kiosks on Sui
|
|
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
|
-
- [Managing Owned Kiosk](./kiosk-client/kiosk-transaction/managing.md): Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
8
|
+
- [Managing Owned Kiosk](./kiosk-client/kiosk-transaction/managing.md): >- Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
9
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.
|
|
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
13
|
- [Advanced Examples](./advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios
|
package/dist/llms-index.md
CHANGED
|
@@ -21,14 +21,14 @@
|
|
|
21
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
23
|
- [State](./dapp-kit/state.md): Access and subscribe to wallet connection state in dApp Kit
|
|
24
|
-
- [Connect Wallet](./dapp-kit/actions/connect-wallet.md): Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
|
|
25
|
-
- [Disconnect Wallet](./dapp-kit/actions/disconnect-wallet.md): Programmatically disconnect from a Sui wallet using the dApp Kit disconnectWallet action.
|
|
24
|
+
- [Connect Wallet](./dapp-kit/actions/connect-wallet.md): >- Programmatically connect to a Sui wallet using the dApp Kit connectWallet action.
|
|
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.
|
|
27
|
-
- [Sign Personal Message](./dapp-kit/actions/sign-personal-message.md): Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
|
|
28
|
-
- [Sign Transaction](./dapp-kit/actions/sign-transaction.md): Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
|
|
29
|
-
- [Switch Account](./dapp-kit/actions/switch-account.md): Switch the active account in the connected wallet using the dApp Kit switchAccount action.
|
|
30
|
-
- [Switch Network](./dapp-kit/actions/switch-network.md): Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
|
|
31
|
-
- [DAppKitProvider](./dapp-kit/react/dapp-kit-provider.md): React context provider that makes dApp Kit available throughout your application.
|
|
27
|
+
- [Sign Personal Message](./dapp-kit/actions/sign-personal-message.md): >- Sign an arbitrary message with the connected wallet for authentication or proof of ownership.
|
|
28
|
+
- [Sign Transaction](./dapp-kit/actions/sign-transaction.md): >- Sign a Sui transaction without executing it for deferred or multi-signature scenarios.
|
|
29
|
+
- [Switch Account](./dapp-kit/actions/switch-account.md): >- Switch the active account in the connected wallet using the dApp Kit switchAccount action.
|
|
30
|
+
- [Switch Network](./dapp-kit/actions/switch-network.md): >- Switch the active network for the dApp Kit instance between mainnet, testnet, and other networks.
|
|
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
34
|
- [useCurrentAccount](./dapp-kit/react/hooks/use-current-account.md): React hook to get the currently selected wallet account in a Sui dApp.
|
|
@@ -40,21 +40,21 @@
|
|
|
40
40
|
- [React Components](./dapp-kit/react/components.md): Pre-built React UI components for wallet interaction in Sui dApps.
|
|
41
41
|
- [Connect Button](./dapp-kit/react/components/connect-button.md): React button component for connecting and disconnecting Sui wallets.
|
|
42
42
|
- [Connect Modal](./dapp-kit/react/components/connect-modal.md): React modal component for selecting and connecting to a Sui wallet.
|
|
43
|
-
- [Connect Button](./dapp-kit/web-components/connect-button.md): Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
|
|
44
|
-
- [Connect Modal](./dapp-kit/web-components/connect-modal.md): Framework-agnostic web component for wallet selection and connection in Sui dApps.
|
|
43
|
+
- [Connect Button](./dapp-kit/web-components/connect-button.md): >- Framework-agnostic web component providing a complete wallet connection UI for Sui dApps.
|
|
44
|
+
- [Connect Modal](./dapp-kit/web-components/connect-modal.md): >- Framework-agnostic web component for wallet selection and connection in Sui dApps.
|
|
45
45
|
- [Theming](./dapp-kit/theming.md): Customize the appearance of dApp Kit UI components.
|
|
46
|
-
- [Sui dApp Kit (Legacy)](./dapp-kit/legacy.md): Legacy dApp Kit API reference for the deprecated @mysten/dapp-kit package using JSON RPC.
|
|
46
|
+
- [Sui dApp Kit (Legacy)](./dapp-kit/legacy.md): >- Legacy dApp Kit API reference for the deprecated @mysten/dapp-kit package using JSON RPC.
|
|
47
47
|
|
|
48
48
|
## Kiosk
|
|
49
49
|
> Interact with on-chain commerce applications
|
|
50
50
|
|
|
51
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
|
-
- [Querying](./kiosk/kiosk-client/querying.md): Query kiosk contents, owned kiosks, items, and transfer policies using the Kiosk SDK.
|
|
52
|
+
- [Kiosk Client](./kiosk/kiosk-client/introduction.md): >- Introduction to the KioskClient extension for querying and managing kiosks on Sui
|
|
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
|
-
- [Managing Owned Kiosk](./kiosk/kiosk-client/kiosk-transaction/managing.md): Manage kiosk items by placing, listing, delisting, and withdrawing using the Kiosk SDK.
|
|
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
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.
|
|
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
60
|
- [Advanced Examples](./kiosk/advanced-examples.md): Advanced Kiosk SDK usage patterns and code examples for complex scenarios
|
|
@@ -63,11 +63,11 @@
|
|
|
63
63
|
## Payment Kit
|
|
64
64
|
> Accept P2P and merchant payments in any coin type on Sui with @mysten/payment-kit
|
|
65
65
|
|
|
66
|
-
- [Payment Kit](./payment-kit.md): Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
|
|
66
|
+
- [Payment Kit](./payment-kit.md): >- Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
|
|
67
67
|
- [Getting Started](./payment-kit/getting-started.md): Install and set up Payment Kit for your Sui application.
|
|
68
68
|
- [Payment Kit SDK](./payment-kit/payment-kit-sdk.md): Payment Kit SDK API reference and configuration for the PaymentKitClient.
|
|
69
|
-
- [Payment Processing](./payment-kit/payment-processing.md): Process registry-based and ephemeral payments and handle transaction results on Sui.
|
|
70
|
-
- [Registry Management](./payment-kit/registry-management.md): Create, configure, and manage payment registries and accepted coin types on Sui.
|
|
69
|
+
- [Payment Processing](./payment-kit/payment-processing.md): >- Process registry-based and ephemeral payments and handle transaction results on Sui.
|
|
70
|
+
- [Registry Management](./payment-kit/registry-management.md): >- Create, configure, and manage payment registries and accepted coin types on Sui.
|
|
71
71
|
|
|
72
72
|
## Seal
|
|
73
73
|
> Use Seal, a decentralized secrets management service that secures your data using threshold encryption and on-chain access control.
|
|
@@ -77,9 +77,9 @@
|
|
|
77
77
|
## Slush Wallet
|
|
78
78
|
> Slush Wallet Integration
|
|
79
79
|
|
|
80
|
-
- [Slush Wallet Integration](./slush-wallet.md): Integrate Slush Wallet into your Sui application for mobile and web wallet support.
|
|
81
|
-
- [App Integration](./slush-wallet/dapp.md): Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
|
|
82
|
-
- [Deep Linking](./slush-wallet/deep-linking.md): Configure deep links to open Slush Wallet directly to specific screens or actions.
|
|
80
|
+
- [Slush Wallet Integration](./slush-wallet.md): >- Integrate Slush Wallet into your Sui application for mobile and web wallet support.
|
|
81
|
+
- [App Integration](./slush-wallet/dapp.md): >- Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
|
|
82
|
+
- [Deep Linking](./slush-wallet/deep-linking.md): >- Configure deep links to open Slush Wallet directly to specific screens or actions.
|
|
83
83
|
|
|
84
84
|
## Sponsor
|
|
85
85
|
> Build gas sponsorship services with pluggable validation
|
|
@@ -94,10 +94,10 @@
|
|
|
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 between SuiGrpcClient and SuiGraphQLClient and understand their shared API
|
|
97
|
+
- [Sui Clients](./sui/clients.md): >- Choose between SuiGrpcClient and SuiGraphQLClient and understand their shared API
|
|
98
98
|
- [Querying Data](./sui/clients/querying.md): Read objects, coins, balances, dynamic fields, and history with any Sui client
|
|
99
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
|
|
100
|
+
- [SuiGrpcClient](./sui/clients/grpc.md): >- Connect to Sui over gRPC, with native service clients and real-time subscriptions
|
|
101
101
|
- [SuiGraphQLClient](./sui/clients/graphql.md): Connect to Sui over GraphQL and write type-safe custom queries
|
|
102
102
|
- [Core API](./sui/clients/core.md): The transport-agnostic client contract that SDKs and libraries build against
|
|
103
103
|
- [Building Transactions](./sui/transactions/basics.md): Construct programmable transaction blocks with the Transaction API
|
|
@@ -105,17 +105,17 @@
|
|
|
105
105
|
- [Coins and Balances](./sui/transactions/coins-and-balances.md): Work with coin objects and address balances in transactions
|
|
106
106
|
- [Commands and Inputs Reference](./sui/transactions/reference.md): Complete reference for transaction commands and input types
|
|
107
107
|
- [Building Offline](./sui/transactions/offline.md): Build transactions without a network connection
|
|
108
|
-
- [Cryptography](./sui/cryptography.md): Sign and verify Sui transactions and messages with keypairs and external signers
|
|
109
|
-
- [Key pairs](./sui/cryptography/keypairs.md): Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
|
|
110
|
-
- [Signers](./sui/cryptography/signers.md): Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
|
|
108
|
+
- [Cryptography](./sui/cryptography.md): >- Sign and verify Sui transactions and messages with keypairs and external signers
|
|
109
|
+
- [Key pairs](./sui/cryptography/keypairs.md): >- Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
|
|
110
|
+
- [Signers](./sui/cryptography/signers.md): >- Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
|
|
111
111
|
- [AWS KMS Signer](./sui/cryptography/signers/aws-kms.md): Sign Sui transactions with a key stored in AWS Key Management Service
|
|
112
112
|
- [GCP KMS Signer](./sui/cryptography/signers/gcp-kms.md): Sign Sui transactions with a key stored in Google Cloud Key Management Service
|
|
113
113
|
- [Ledger Signer](./sui/cryptography/signers/ledger.md): Sign Sui transactions with a Ledger hardware wallet
|
|
114
|
-
- [Web Crypto Signer](./sui/cryptography/signers/webcrypto.md): Sign transactions using the Web Crypto API for secure browser-based key management
|
|
114
|
+
- [Web Crypto Signer](./sui/cryptography/signers/webcrypto.md): >- Sign transactions using the Web Crypto API for secure browser-based key management
|
|
115
115
|
- [Passkey](./sui/cryptography/signers/passkey.md): Use WebAuthn passkeys for Sui transaction signing.
|
|
116
116
|
- [Multi-Signature Transactions](./sui/cryptography/signers/multisig.md): Create multi-signature transactions with multiple signers on Sui.
|
|
117
|
-
- [The `@mysten/sui/utils` package](./sui/utils.md): Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
|
|
118
|
-
- [Derived Objects](./sui/utils/derived_objects.md): Compute derived object IDs from parent objects for deterministic offline derivation.
|
|
117
|
+
- [The `@mysten/sui/utils` package](./sui/utils.md): >- Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
|
|
118
|
+
- [Derived Objects](./sui/utils/derived_objects.md): >- Compute derived object IDs from parent objects for deterministic offline derivation.
|
|
119
119
|
- [BCS](./sui/bcs.md): Binary Canonical Serialization for encoding Sui Move types.
|
|
120
120
|
- [ZkLogin](./sui/zklogin.md): Zero-knowledge authentication with OAuth providers on Sui.
|
|
121
121
|
- [Transaction Executors](./sui/executors.md): Manage transaction execution with queuing and parallel strategies
|
|
@@ -123,10 +123,10 @@
|
|
|
123
123
|
- [Building SDKs](./sui/sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
|
|
124
124
|
- [Migrate to 2.0](./sui/migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages
|
|
125
125
|
- [Agent Migration Prompt](./sui/migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration of your codebase.
|
|
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
|
|
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
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
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
|
|
129
|
+
- [@mysten/kiosk](./sui/migrations/sui-2.0/kiosk.md): >- Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
|
|
130
130
|
- [@mysten/zksend](./sui/migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API
|
|
131
131
|
- [@mysten/suins](./sui/migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0 with client extension pattern
|
|
132
132
|
- [@mysten/deepbook-v3](./sui/migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern
|
|
@@ -135,12 +135,12 @@
|
|
|
135
135
|
- [Wallet Builders](./sui/migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers upgrading to 2.0.
|
|
136
136
|
- [SDK Maintainers](./sui/migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors upgrading to 2.0
|
|
137
137
|
- [Migrate to 1.0](./sui/migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0 with new features and API changes.
|
|
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
|
+
- [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.
|
|
139
139
|
|
|
140
140
|
## Walrus
|
|
141
141
|
> Publish and Read blobs directly from walrus storage nodes
|
|
142
142
|
|
|
143
|
-
- [Walrus SDK](./walrus.md): Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
|
|
143
|
+
- [Walrus SDK](./walrus.md): >- Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
|
|
144
144
|
|
|
145
145
|
## ZkSend
|
|
146
146
|
> Send Sui with a link
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Payment Kit
|
|
2
2
|
|
|
3
|
-
> Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
|
|
3
|
+
> >- Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
|
|
4
4
|
|
|
5
5
|
> **Note:** This package is in active development and should be used with caution. APIs are experimental and
|
|
6
6
|
> subject to breaking changes without notice. We recommend thoroughly testing any implementation
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Payment Kit
|
|
2
2
|
> Accept P2P and merchant payments in any coin type on Sui with @mysten/payment-kit
|
|
3
3
|
|
|
4
|
-
- [Payment Kit](..md): Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
|
|
4
|
+
- [Payment Kit](..md): >- Accept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
|
|
5
5
|
- [Getting Started](./getting-started.md): Install and set up Payment Kit for your Sui application.
|
|
6
6
|
- [Payment Kit SDK](./payment-kit-sdk.md): Payment Kit SDK API reference and configuration for the PaymentKitClient.
|
|
7
|
-
- [Payment Processing](./payment-processing.md): Process registry-based and ephemeral payments and handle transaction results on Sui.
|
|
8
|
-
- [Registry Management](./registry-management.md): Create, configure, and manage payment registries and accepted coin types on Sui.
|
|
7
|
+
- [Payment Processing](./payment-processing.md): >- Process registry-based and ephemeral payments and handle transaction results on Sui.
|
|
8
|
+
- [Registry Management](./registry-management.md): >- Create, configure, and manage payment registries and accepted coin types on Sui.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Payment Processing
|
|
2
2
|
|
|
3
|
-
> Process registry-based and ephemeral payments and handle transaction results on Sui.
|
|
3
|
+
> >- Process registry-based and ephemeral payments and handle transaction results on Sui.
|
|
4
4
|
|
|
5
5
|
> **Note:** This package is in active development and should be used with caution. APIs are experimental and
|
|
6
6
|
> subject to breaking changes without notice. We recommend thoroughly testing any implementation
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Registry Management
|
|
2
2
|
|
|
3
|
-
> Create, configure, and manage payment registries and accepted coin types on Sui.
|
|
3
|
+
> >- Create, configure, and manage payment registries and accepted coin types on Sui.
|
|
4
4
|
|
|
5
5
|
> **Note:** This package is in active development and should be used with caution. APIs are experimental and
|
|
6
6
|
> subject to breaking changes without notice. We recommend thoroughly testing any implementation
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# App Integration
|
|
2
2
|
|
|
3
|
-
> Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
|
|
3
|
+
> >- Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
|
|
4
4
|
|
|
5
5
|
> **Note:** If you are using `dapp-kit`, you do not need to install any additional packages to integrate with
|
|
6
6
|
> the Slush wallet. [Read how to integrate with dapp-kit.](/dapp-kit/legacy/slush)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Deep Linking
|
|
2
2
|
|
|
3
|
-
> Configure deep links to open Slush Wallet directly to specific screens or actions.
|
|
3
|
+
> >- Configure deep links to open Slush Wallet directly to specific screens or actions.
|
|
4
4
|
|
|
5
5
|
Deep linking allows external applications, websites, and services to open Slush directly to specific
|
|
6
6
|
screens or trigger specific actions. This enables seamless integrations where users can be directed
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Slush Wallet Integration
|
|
2
2
|
|
|
3
|
-
> Integrate Slush Wallet into your Sui application for mobile and web wallet support.
|
|
3
|
+
> >- Integrate Slush Wallet into your Sui application for mobile and web wallet support.
|
|
4
4
|
|
|
5
5
|
This section covers integration with [Slush Wallet](https://slush.app), a mobile wallet for the Sui
|
|
6
6
|
blockchain. You'll find guides for wallet-specific functionality to enhance your app's user
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Slush Wallet
|
|
2
2
|
> Slush Wallet Integration
|
|
3
3
|
|
|
4
|
-
- [Slush Wallet Integration](..md): Integrate Slush Wallet into your Sui application for mobile and web wallet support.
|
|
5
|
-
- [App Integration](./dapp.md): Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
|
|
6
|
-
- [Deep Linking](./deep-linking.md): Configure deep links to open Slush Wallet directly to specific screens or actions.
|
|
4
|
+
- [Slush Wallet Integration](..md): >- Integrate Slush Wallet into your Sui application for mobile and web wallet support.
|
|
5
|
+
- [App Integration](./dapp.md): >- Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
|
|
6
|
+
- [Deep Linking](./deep-linking.md): >- Configure deep links to open Slush Wallet directly to specific screens or actions.
|
package/dist/sui/clients/grpc.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SuiGrpcClient
|
|
2
2
|
|
|
3
|
-
> Connect to Sui over gRPC, with native service clients and real-time subscriptions
|
|
3
|
+
> >- Connect to Sui over gRPC, with native service clients and real-time subscriptions
|
|
4
4
|
|
|
5
5
|
`SuiGrpcClient` talks to the full node gRPC API. It is the recommended default for application code
|
|
6
6
|
and SDK integrations: it reads directly from a full node, and it is the only client with real-time
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Sui Clients
|
|
2
2
|
|
|
3
|
-
> Choose between SuiGrpcClient and SuiGraphQLClient and understand their shared API
|
|
3
|
+
> >- Choose between SuiGrpcClient and SuiGraphQLClient and understand their shared API
|
|
4
4
|
|
|
5
5
|
A client is how your code reads from and writes to the Sui network. There are two to choose from,
|
|
6
6
|
and they implement the same API (the same method names, options, and response shapes), so the choice
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Cryptography
|
|
2
2
|
|
|
3
|
-
> Sign and verify Sui transactions and messages with keypairs and external signers
|
|
3
|
+
> >- Sign and verify Sui transactions and messages with keypairs and external signers
|
|
4
4
|
|
|
5
5
|
A signature authorizes every transaction and personal message on Sui. The Sui TypeScript SDK exposes
|
|
6
6
|
a single abstraction for producing those signatures, the `Signer`, along with several
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Key pairs
|
|
2
2
|
|
|
3
|
-
> Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
|
|
3
|
+
> >- Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
|
|
4
4
|
|
|
5
5
|
A `Keypair` holds a Sui private key in process and signs with it. It is the easiest
|
|
6
6
|
[`Signer`](/sui/cryptography) to use. It is ideal for scripts, backends, and tests where you manage
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Signers
|
|
2
2
|
|
|
3
|
-
> Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
|
|
3
|
+
> >- Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
|
|
4
4
|
|
|
5
5
|
In addition to the in-process [keypairs](/sui/cryptography/keypairs) built into `@mysten/sui`, the
|
|
6
6
|
SDK ecosystem ships more implementations of the [`Signer`](/sui/cryptography) interface. Some keep
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Web Crypto Signer
|
|
2
2
|
|
|
3
|
-
> Sign transactions using the Web Crypto API for secure browser-based key management
|
|
3
|
+
> >- Sign transactions using the Web Crypto API for secure browser-based key management
|
|
4
4
|
|
|
5
5
|
For cases where you need to create keypairs directly within client apps, you can use the Web Crypto
|
|
6
6
|
Signer. This signer leverages the
|
package/dist/sui/llms-index.md
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
- [Sui TypeScript SDK](..md): TypeScript SDK for building on the Sui blockchain
|
|
5
5
|
- [LLM Documentation](./llm-docs.md): Give AI agents access to Sui SDK documentation in your project.
|
|
6
|
-
- [Sui Clients](./clients.md): Choose between SuiGrpcClient and SuiGraphQLClient and understand their shared API
|
|
6
|
+
- [Sui Clients](./clients.md): >- Choose between SuiGrpcClient and SuiGraphQLClient and understand their shared API
|
|
7
7
|
- [Querying Data](./clients/querying.md): Read objects, coins, balances, dynamic fields, and history with any Sui client
|
|
8
8
|
- [Executing Transactions](./clients/executing.md): Simulate, execute, and wait for transactions with any Sui client
|
|
9
|
-
- [SuiGrpcClient](./clients/grpc.md): Connect to Sui over gRPC, with native service clients and real-time subscriptions
|
|
9
|
+
- [SuiGrpcClient](./clients/grpc.md): >- Connect to Sui over gRPC, with native service clients and real-time subscriptions
|
|
10
10
|
- [SuiGraphQLClient](./clients/graphql.md): Connect to Sui over GraphQL and write type-safe custom queries
|
|
11
11
|
- [Core API](./clients/core.md): The transport-agnostic client contract that SDKs and libraries build against
|
|
12
12
|
- [Building Transactions](./transactions/basics.md): Construct programmable transaction blocks with the Transaction API
|
|
@@ -14,17 +14,17 @@
|
|
|
14
14
|
- [Coins and Balances](./transactions/coins-and-balances.md): Work with coin objects and address balances in transactions
|
|
15
15
|
- [Commands and Inputs Reference](./transactions/reference.md): Complete reference for transaction commands and input types
|
|
16
16
|
- [Building Offline](./transactions/offline.md): Build transactions without a network connection
|
|
17
|
-
- [Cryptography](./cryptography.md): Sign and verify Sui transactions and messages with keypairs and external signers
|
|
18
|
-
- [Key pairs](./cryptography/keypairs.md): Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
|
|
19
|
-
- [Signers](./cryptography/signers.md): Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
|
|
17
|
+
- [Cryptography](./cryptography.md): >- Sign and verify Sui transactions and messages with keypairs and external signers
|
|
18
|
+
- [Key pairs](./cryptography/keypairs.md): >- Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
|
|
19
|
+
- [Signers](./cryptography/signers.md): >- Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
|
|
20
20
|
- [AWS KMS Signer](./cryptography/signers/aws-kms.md): Sign Sui transactions with a key stored in AWS Key Management Service
|
|
21
21
|
- [GCP KMS Signer](./cryptography/signers/gcp-kms.md): Sign Sui transactions with a key stored in Google Cloud Key Management Service
|
|
22
22
|
- [Ledger Signer](./cryptography/signers/ledger.md): Sign Sui transactions with a Ledger hardware wallet
|
|
23
|
-
- [Web Crypto Signer](./cryptography/signers/webcrypto.md): Sign transactions using the Web Crypto API for secure browser-based key management
|
|
23
|
+
- [Web Crypto Signer](./cryptography/signers/webcrypto.md): >- Sign transactions using the Web Crypto API for secure browser-based key management
|
|
24
24
|
- [Passkey](./cryptography/signers/passkey.md): Use WebAuthn passkeys for Sui transaction signing.
|
|
25
25
|
- [Multi-Signature Transactions](./cryptography/signers/multisig.md): Create multi-signature transactions with multiple signers on Sui.
|
|
26
|
-
- [The `@mysten/sui/utils` package](./utils.md): Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
|
|
27
|
-
- [Derived Objects](./utils/derived_objects.md): Compute derived object IDs from parent objects for deterministic offline derivation.
|
|
26
|
+
- [The `@mysten/sui/utils` package](./utils.md): >- Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
|
|
27
|
+
- [Derived Objects](./utils/derived_objects.md): >- Compute derived object IDs from parent objects for deterministic offline derivation.
|
|
28
28
|
- [BCS](./bcs.md): Binary Canonical Serialization for encoding Sui Move types.
|
|
29
29
|
- [ZkLogin](./zklogin.md): Zero-knowledge authentication with OAuth providers on Sui.
|
|
30
30
|
- [Transaction Executors](./executors.md): Manage transaction execution with queuing and parallel strategies
|
|
@@ -32,10 +32,10 @@
|
|
|
32
32
|
- [Building SDKs](./sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
|
|
33
33
|
- [Migrate to 2.0](./migrations/sui-2.0.md): Migration guide for Sui TypeScript SDK 2.0 covering all @mysten packages
|
|
34
34
|
- [Agent Migration Prompt](./migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK 2.0 migration of your codebase.
|
|
35
|
-
- [@mysten/sui](./migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0 with gRPC clients, Core API, and BCS changes
|
|
35
|
+
- [@mysten/sui](./migrations/sui-2.0/sui.md): >- Migrate @mysten/sui from 1.x to 2.0 with gRPC clients, Core API, and BCS changes
|
|
36
36
|
- [Migrating from JSON-RPC](./migrations/sui-2.0/json-rpc-migration.md): Migrate deprecated JSON-RPC code to shared gRPC and GraphQL top-level methods
|
|
37
37
|
- [@mysten/dapp-kit](./migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to the new dapp-kit-react package in 2.0
|
|
38
|
-
- [@mysten/kiosk](./migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
|
|
38
|
+
- [@mysten/kiosk](./migrations/sui-2.0/kiosk.md): >- Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
|
|
39
39
|
- [@mysten/zksend](./migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0 with client extension pattern and simplified API
|
|
40
40
|
- [@mysten/suins](./migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0 with client extension pattern
|
|
41
41
|
- [@mysten/deepbook-v3](./migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0 with client extension pattern
|
|
@@ -44,4 +44,4 @@
|
|
|
44
44
|
- [Wallet Builders](./migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension developers upgrading to 2.0.
|
|
45
45
|
- [SDK Maintainers](./migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers and library authors upgrading to 2.0
|
|
46
46
|
- [Migrate to 1.0](./migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0 with new features and API changes.
|
|
47
|
-
- [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.
|
|
47
|
+
- [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.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Migrate to 0.38.0
|
|
2
2
|
|
|
3
|
-
> Migrate from SDK version 0.37 to 0.38 with updated module structure and API changes.
|
|
3
|
+
> >- Migrate from SDK version 0.37 to 0.38 with updated module structure and API changes.
|
|
4
4
|
|
|
5
5
|
> **Warning:** The 1.0 release of the SDK contains many additional changes. This document might help as an
|
|
6
6
|
> intermediate step when upgrading from older versions of the SDK, but all apps should be upgraded to
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @mysten/kiosk
|
|
2
2
|
|
|
3
|
-
> Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
|
|
3
|
+
> >- Migrate @mysten/kiosk to 2.0 with client extension pattern and KioskTransaction
|
|
4
4
|
|
|
5
5
|
This package now exports a client extension that integrates with Sui clients.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Derived Objects
|
|
2
2
|
|
|
3
|
-
> Compute derived object IDs from parent objects for deterministic offline derivation.
|
|
3
|
+
> >- Compute derived object IDs from parent objects for deterministic offline derivation.
|
|
4
4
|
|
|
5
5
|
Derived objects enable deterministic IDs for objects, enabling offline derivation of object IDs.
|
|
6
6
|
[Click here to read more.](https://docs.sui.io/concepts/sui-move-concepts/derived-objects)
|
package/dist/sui/utils/index.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The `@mysten/sui/utils` package
|
|
2
2
|
|
|
3
|
-
> Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
|
|
3
|
+
> >- Utility functions for addresses, coins, and common operations in the Sui TypeScript SDK.
|
|
4
4
|
|
|
5
5
|
This package contains some utilities that simplify common operations when working with the Sui
|
|
6
6
|
TypeScript SDK.
|
package/dist/walrus/index.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Walrus SDK
|
|
2
2
|
|
|
3
|
-
> Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
|
|
3
|
+
> >- Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
|
|
4
4
|
|
|
5
5
|
The Walrus TypeScript SDK works directly with Walrus storage nodes or with the Walrus upload relay.
|
|
6
6
|
When you use the Walrus SDK without an upload relay, reading and writing Walrus blobs requires many
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
# Walrus
|
|
2
2
|
> Publish and Read blobs directly from walrus storage nodes
|
|
3
3
|
|
|
4
|
-
- [Walrus SDK](..md): Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
|
|
4
|
+
- [Walrus SDK](..md): >- Store and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mysten/docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.49",
|
|
4
4
|
"description": "LLM-friendly documentation for the Sui TypeScript SDK ecosystem",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -28,28 +28,28 @@
|
|
|
28
28
|
"next": "^16.2.12",
|
|
29
29
|
"react": "^19.2.7",
|
|
30
30
|
"react-dom": "^19.2.7",
|
|
31
|
-
"@mysten/aws-kms-signer": "0.3.
|
|
31
|
+
"@mysten/aws-kms-signer": "0.3.14",
|
|
32
|
+
"@mysten/dapp-kit": "1.1.17",
|
|
32
33
|
"@mysten/bcs": "2.1.0",
|
|
33
|
-
"@mysten/dapp-kit": "1.
|
|
34
|
-
"@mysten/dapp-kit-react": "2.1.
|
|
35
|
-
"@mysten/
|
|
36
|
-
"@mysten/
|
|
37
|
-
"@mysten/
|
|
38
|
-
"@mysten/
|
|
39
|
-
"@mysten/kiosk": "1.4.
|
|
40
|
-
"@mysten/
|
|
41
|
-
"@mysten/
|
|
42
|
-
"@mysten/
|
|
43
|
-
"@mysten/signers": "1.1.
|
|
44
|
-
"@mysten/
|
|
45
|
-
"@mysten/
|
|
46
|
-
"@mysten/
|
|
34
|
+
"@mysten/dapp-kit-core": "1.6.17",
|
|
35
|
+
"@mysten/dapp-kit-react": "2.1.19",
|
|
36
|
+
"@mysten/deepbook-v3": "2.0.0",
|
|
37
|
+
"@mysten/enoki": "1.2.15",
|
|
38
|
+
"@mysten/enoki-connect": "1.1.17",
|
|
39
|
+
"@mysten/gcp-kms-signer": "0.2.17",
|
|
40
|
+
"@mysten/kiosk": "1.4.3",
|
|
41
|
+
"@mysten/ledger-signer": "0.2.17",
|
|
42
|
+
"@mysten/payment-kit": "0.2.17",
|
|
43
|
+
"@mysten/slush-wallet": "1.1.17",
|
|
44
|
+
"@mysten/signers": "1.1.17",
|
|
45
|
+
"@mysten/seal": "1.4.3",
|
|
46
|
+
"@mysten/sui": "2.26.1",
|
|
47
|
+
"@mysten/suins": "1.2.17",
|
|
48
|
+
"@mysten/wallet-standard": "0.21.17",
|
|
49
|
+
"@mysten/walrus": "1.2.17",
|
|
50
|
+
"@mysten/webcrypto-signer": "0.2.17",
|
|
47
51
|
"@mysten/utils": "0.4.0",
|
|
48
|
-
"@mysten/
|
|
49
|
-
"@mysten/sui": "2.26.0",
|
|
50
|
-
"@mysten/walrus": "1.2.16",
|
|
51
|
-
"@mysten/webcrypto-signer": "0.2.16",
|
|
52
|
-
"@mysten/zksend": "1.2.16"
|
|
52
|
+
"@mysten/zksend": "1.2.17"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@tailwindcss/postcss": "^4.3.1",
|