@mysten/docs 0.1.17 → 0.1.19

package/dist/slush-wallet/deep-linking.md

@@ -1,17 +1,17 @@
 # Deep Linking
 
-> Deep linking configuration for Slush Wallet
+> Configure deep links to open Slush Wallet directly to specific screens or actions.
 
 Deep linking allows external applications, websites, and services to open Slush directly to specific
 screens or trigger specific actions. This enables seamless integrations where users can be directed
-into the wallet to perform actions like swapping tokens, claiming assets, or browsing dApps.
+into the wallet to perform actions like swapping tokens, claiming assets, or browsing apps.
 
 ## Overview
 
 Slush supports two types of deep linking:
 
-1. **Custom URL Schemes** - Direct links using `slush://` (mobile app only)
-2. **Universal Links & App Links** - HTTPS links that work across mobile and desktop
+1. **Custom URL schemes**: Direct links using `slush://` (mobile app only)
+2. **Universal links and app links**: HTTPS links that work across mobile and desktop
 
 > **Note:** For most integrations, use `my.slush.app` HTTPS links. They work on iOS, Android, and desktop
 > browsers, opening the native app when installed or falling back to the web app.
@@ -21,7 +21,7 @@ Slush supports two types of deep linking:
 > **Warning:** Always URL-encode parameter values, especially token type addresses which contain special
 > characters like colons (`:`). See [URL Encode Parameters](#url-encode-parameters) for examples.
 
-## URL Schemes
+## URL schemes
 
 Slush registers a custom URL scheme:
 
@@ -29,7 +29,7 @@ Slush registers a custom URL scheme:
 | ---------- | ----------------------------------- |
 | `slush://` | Primary scheme for the Slush wallet |
 
-### Basic Format
+### Basic format
 
 ```
 slush://<path>?<parameters>
@@ -42,7 +42,7 @@ slush://swap?fromCoinType=0x2::sui::SUI
 slush://browse/https://app.example.com
 ```
 
-## Universal Links & App Links
+## Universal links and app links
 
 Slush responds to HTTPS links (Universal Links on iOS, App Links on Android) from the following
 domains:
@@ -51,7 +51,7 @@ domains:
 | -------------- | -------------------------------------------- |
 | `my.slush.app` | `/browse/*`, `/claim/*`, `/swap/*`, `/pay/*` |
 
-### Cross-Platform Behavior
+### Cross-platform behavior
 
 The `my.slush.app` domain is recommended because it works across all platforms:
 
@@ -61,28 +61,28 @@ The `my.slush.app` domain is recommended because it works across all platforms:
 | Mobile (app not installed) | Opens in the mobile browser with the Slush web app |
 | Desktop browser            | Opens the Slush web app                            |
 
-> **Note:** Unlike custom URL schemes (`slush://`), `my.slush.app` links never fail - they always open either
+> **Note:** Unlike custom URL schemes (`slush://`), `my.slush.app` links never fail. They always open either
 > the native app or the web app, ensuring users can complete their intended action.
 
 ### Examples
 
 ```
-# Opens dApp browser - works on mobile and desktop
+# Opens dApp browser: works on mobile and desktop
 https://my.slush.app/browse/https://app.turbos.finance
 
-# Opens claim flow - works on mobile and desktop
+# Opens claim flow: works on mobile and desktop
 https://my.slush.app/claim?claimUrl=abc123xyz
 ```
 
-## Supported Routes
+## Supported routes
 
-### dApp Browser
+### App browser
 
 Open the in-app browser to load a specific URL:
 
-| Route         | Description                     |
-| ------------- | ------------------------------- |
-| `browse/:url` | Opens a URL in the dApp browser |
+| Route         | Description                    |
+| ------------- | ------------------------------ |
+| `browse/:url` | Opens a URL in the app browser |
 
 **Parameters:**
 
@@ -97,9 +97,9 @@ slush://browse/https://app.turbos.finance
 https://my.slush.app/browse/https://app.cetus.zone
 ```
 
-> The URL must be a complete, valid URL including the protocol (e.g., `https://`).
+> The URL must be a complete, valid URL including the protocol (for example, `https://`).
 
-### Token Swap
+### Token swap
 
 Open the token swap screen with optional pre-filled values:
 
@@ -128,7 +128,7 @@ slush://swap?fromCoinType=0x2::sui::SUI&toCoinType=0xdba34672e30cb065b1f93e3ab55
 slush://swap?fromCoinType=0x2::sui::SUI&presetAmount=100
 ```
 
-### Claim Assets
+### Claim assets
 
 Open the claim screen to receive stashed or gifted tokens:
 
@@ -149,7 +149,7 @@ slush://claim?claimUrl=https://zksend.com/claim/abc123xyz
 slush://claim?claimUrl=https://getstashed.com/claim/def456
 ```
 
-### Token Details
+### Token details
 
 View details for a specific token:
 
@@ -173,7 +173,7 @@ slush://tokens?coinType=0x2::sui::SUI
 slush://tokens?coinType=0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC
 ```
 
-### Receive / QR Code
+### Receive / QR code
 
 Open the receive screen to display the wallet address or scan a QR code:
 
@@ -197,7 +197,7 @@ slush://suime?action=RECEIVE
 slush://suime?action=SCAN_QR_CODE
 ```
 
-### DeFi Strategies
+### DeFi strategies
 
 Access yield strategies and DeFi opportunities:
 
@@ -250,7 +250,7 @@ slush://staking/native-stake
 slush://staking/liquid-stake
 ```
 
-### Send Tokens
+### Send tokens
 
 Access the send flow:
 
@@ -271,7 +271,7 @@ slush://send-coins/camera
 ### Payment Kit
 
 Open the payment flow using Payment Kit URIs. Slush supports the `sui:pay` protocol for processing
-on-chain payments with optional registry support.
+onchain payments with optional registry support.
 
 | Route | Description                 |
 | ----- | --------------------------- |
@@ -288,16 +288,16 @@ https://my.slush.app/pay?receiver=<address>&amount=<amount>&coinType=<coinType>&
 
 **Parameters:**
 
-| Parameter  | Type   | Required | Description                                            |
-| ---------- | ------ | -------- | ------------------------------------------------------ |
-| `receiver` | string | Yes      | Recipient Sui address                                  |
-| `amount`   | string | Yes      | Payment amount in smallest unit (e.g., MIST for SUI)   |
-| `coinType` | string | Yes      | Coin type (e.g., `0x2::sui::SUI`)                      |
-| `nonce`    | string | Yes      | Unique payment identifier (max 36 characters)          |
-| `registry` | string | No       | Registry name or object ID for registry-based payments |
-| `label`    | string | No       | Human-readable label for the payment                   |
-| `message`  | string | No       | Message or memo for the payment                        |
-| `iconUrl`  | string | No       | URL to an icon image for display purposes              |
+| Parameter  | Type   | Required | Description                                                 |
+| ---------- | ------ | -------- | ----------------------------------------------------------- |
+| `receiver` | string | Yes      | Recipient Sui address                                       |
+| `amount`   | string | Yes      | Payment amount in smallest unit (for example, MIST for SUI) |
+| `coinType` | string | Yes      | Coin type (for example, `0x2::sui::SUI`)                    |
+| `nonce`    | string | Yes      | Unique payment identifier (max 36 characters)               |
+| `registry` | string | No       | Registry name or object ID for registry-based payments      |
+| `label`    | string | No       | Human-readable label for the payment                        |
+| `message`  | string | No       | Message or memo for the payment                             |
+| `iconUrl`  | string | No       | URL to an icon image for display purposes                   |
 
 **Examples:**
 
@@ -318,9 +318,9 @@ https://my.slush.app/pay?receiver=0x1234...abcd&amount=5000000&coinType=0xdba346
 > Use the `@mysten/payment-kit` SDK to generate properly formatted payment URIs. See the [Payment
 > Kit documentation](/payment-kit/getting-started) for more details.
 
-## Implementation Examples
+## Implementation examples
 
-### Web Integration
+### Web integration
 
 Link to Slush from any web page (mobile or desktop):
 
@@ -387,13 +387,13 @@ val customIntent = Intent(Intent.ACTION_VIEW, Uri.parse("slush://swap"))
 startActivity(customIntent)
 ```
 
-## Best Practices
+## Best practices
 
-### Use my.slush.app Links for Maximum Compatibility
+### Use my.slush.app links for maximum compatibility
 
 When linking from any platform, prefer `my.slush.app` links over custom URL schemes. These links
-work everywhere - mobile apps, mobile browsers, and desktop browsers - providing a seamless
-experience for all users.
+work everywhere, mobile apps, mobile browsers, and desktop browsers, providing a seamless experience
+for all users.
 
 ```html
 <!-- Recommended: Works on mobile (app or browser) and desktop -->
@@ -406,7 +406,7 @@ experience for all users.
 > Use `my.slush.app` links as your default choice. Only use custom URL schemes (`slush://`) when you
 > specifically need to detect whether the mobile app is installed.
 
-### URL Encode Parameters
+### URL encode parameters
 
 Always URL-encode parameter values, especially token type addresses which contain special
 characters:
@@ -417,7 +417,7 @@ const encodedCoinType = encodeURIComponent(coinType);
 const url = `slush://swap?fromCoinType=${encodedCoinType}`;
 ```
 
-### Check App Installation (Custom Schemes Only)
+### Check app installation (custom schemes only)
 
 If you're using custom URL schemes (`slush://`), check if the app is installed to provide
 appropriate fallbacks. This is not needed when using `my.slush.app` links, which automatically fall
@@ -433,28 +433,28 @@ if (canOpenSlush) {
 }
 ```
 
-### Handle Missing Parameters Gracefully
+### Handle missing parameters gracefully
 
 Slush will attempt to open the requested screen even if optional parameters are missing. Required
 parameters that are missing will result in the app opening to a default or error state.
 
 ## Troubleshooting
 
-### Link Not Opening the App
+### Link not opening the app
 
-1. **Verify the app is installed** - Custom URL schemes only work if Slush is installed
-2. **Check URL format** - Ensure the URL is properly formatted and encoded
-3. **iOS Universal Links** - Must be clicked from Safari or apps that support Universal Links;
-   copied/pasted URLs may not trigger the app
-4. **Android App Links** - Ensure the device has verified the app link association
+1. **Verify the app is installed**: Custom URL schemes only work if Slush is installed
+2. **Check URL format**: Ensure the URL is properly formatted and encoded
+3. **iOS Universal Links**: Must be clicked from Safari or apps that support Universal Links; copied
+   or pasted URLs might not trigger the app
+4. **Android App Links**: Ensure the device has verified the app link association
 
-### Wrong Screen Opens
+### Wrong screen opens
 
-1. **Check the path** - Verify the route matches one of the supported routes above
-2. **Check parameters** - Ensure all required parameters are provided
-3. **Check parameter encoding** - Special characters in coin types must be URL-encoded
+1. **Check the path**: Verify the route matches one of the supported routes above
+2. **Check parameters**: Ensure all required parameters are provided
+3. **Check parameter encoding**: Special characters in coin types must be URL-encoded
 
-### Universal Links Open in Browser Instead of App
+### Universal links open in browser instead of app
 
 This can happen if:
 

package/dist/slush-wallet/index.md

@@ -1,7 +1,7 @@
 # Slush Wallet Integration
 
-> Integrate Slush Wallet into your Sui dApp
+> Integrate Slush Wallet into your Sui application for mobile and web wallet support.
 
 This section covers integration with [Slush Wallet](https://slush.app), a mobile wallet for the Sui
-blockchain. You'll find guides for wallet-specific functionality to enhance your dApp's user
+blockchain. You'll find guides for wallet-specific functionality to enhance your app's user
 experience.

package/dist/slush-wallet/llms-index.md

@@ -1,6 +1,6 @@
 # Slush Wallet
 > Slush Wallet Integration
 
-- [Slush Wallet Integration](..md): Integrate Slush Wallet into your Sui dApp
-- [dApp Integration](./dapp.md): Connect your dApp to Slush Wallet
-- [Deep Linking](./deep-linking.md): Deep linking configuration for Slush Wallet
+- [Slush Wallet Integration](..md): Integrate Slush Wallet into your Sui application for mobile and web wallet support.
+- [App Integration](./dapp.md): Connect your app to Slush Wallet using the Slush Wallet SDK and wallet standard.
+- [Deep Linking](./deep-linking.md): Configure deep links to open Slush Wallet directly to specific screens or actions.

package/dist/sui/bcs.md

@@ -1,6 +1,6 @@
 # BCS
 
-> Binary Canonical Serialization for encoding Sui Move types
+> Binary Canonical Serialization for encoding Sui Move types.
 
 The `@mysten/sui/bcs` package extends `@mysten/bcs` with Sui specific scheme definitions.
 
@@ -41,10 +41,10 @@ the following pre-defined schemes:
 - `TransactionExpiration`
 - `TransactionKind`
 - `TypeTag`
-- `Object` - Complete object with data, owner, previousTransaction, and storageRebate
-- `TransactionEffects` - Transaction execution effects (supports both V1 and V2)
-- `TransactionEffectsV1` - Legacy transaction effects format
-- `TransactionEffectsV2` - Current transaction effects format with detailed object changes
+- `Object`: Complete object with data, owner, previousTransaction, and storageRebate
+- `TransactionEffects`: Transaction execution effects (supports both V1 and V2)
+- `TransactionEffectsV1`: Legacy transaction effects format
+- `TransactionEffectsV2`: Current transaction effects format with detailed object changes
 
 All the upper-cased values are `BcsType` instances, and can be used directly to parse and serialize
 data.
@@ -60,9 +60,9 @@ bcs.TypeTag.serialize({
 });
 ```
 
-## Working with Objects
+## Working with objects
 
-To parse on-chain objects, fetch them with `include: { content: true }` and pass `object.content` to
+To parse onchain objects, fetch them with `include: { content: true }` and pass `object.content` to
 a generated BCS type or a manual struct definition. The `content` field contains only the inner Move
 struct bytes:
 
@@ -76,9 +76,9 @@ const { object } = await client.core.getObject({
 const parsed = MyStruct.parse(object.content);
 ```
 
-### `bcs.Object` — Full object envelope
+### `bcs.Object`: Full object envelope
 
-The `bcs.Object` schema represents the complete on-chain object, including metadata (type, owner,
+The `bcs.Object` schema represents the complete onchain object, including metadata (type, owner,
 version, previous transaction, storage rebate) wrapping the inner struct bytes. This is what the
 `objectBcs` include option returns. Most of this metadata is already available as fields on the
 object response, so you typically only need `content`.
@@ -106,11 +106,11 @@ const serialized = bcs.Object.serialize({
 });
 ```
 
-> **Warning:** Do not pass `objectBcs` bytes to a Move struct parser — it contains wrapping metadata that will
+> **Warning:** Do not pass `objectBcs` bytes to a Move struct parser. It contains wrapping metadata that will
 > cause parsing to fail. Use `content` for parsing Move struct fields. See the [Core API
 > docs](/sui/clients/core#objectbcs) for details.
 
-## Working with Transaction Effects
+## Working with transaction effects
 
 The `bcs.TransactionEffects` schema can be used to parse transaction effects: