@mysten/docs 0.1.1

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

@@ -0,0 +1,465 @@
+# Deep Linking
+
+> Deep linking configuration for Slush Wallet
+
+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.
+
+## 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
+
+> **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.
+
+> **Warning:** Deep linking is not currently supported for the Slush browser extension.
+
+> **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
+
+Slush registers a custom URL scheme:
+
+| Scheme     | Description                         |
+| ---------- | ----------------------------------- |
+| `slush://` | Primary scheme for the Slush wallet |
+
+### Basic Format
+
+```
+slush://<path>?<parameters>
+```
+
+### Examples
+
+```
+slush://swap?fromCoinType=0x2::sui::SUI
+slush://browse/https://app.example.com
+```
+
+## Universal Links & App Links
+
+Slush responds to HTTPS links (Universal Links on iOS, App Links on Android) from the following
+domains:
+
+| Domain         | Supported Paths                              |
+| -------------- | -------------------------------------------- |
+| `my.slush.app` | `/browse/*`, `/claim/*`, `/swap/*`, `/pay/*` |
+
+### Cross-Platform Behavior
+
+The `my.slush.app` domain is recommended because it works across all platforms:
+
+| Environment                | Behavior                                           |
+| -------------------------- | -------------------------------------------------- |
+| Mobile (app installed)     | Opens directly in the Slush native app             |
+| 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
+> the native app or the web app, ensuring users can complete their intended action.
+
+### Examples
+
+```
+# 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
+https://my.slush.app/claim?claimUrl=abc123xyz
+```
+
+## Supported Routes
+
+### dApp Browser
+
+Open the in-app browser to load a specific URL:
+
+| Route         | Description                     |
+| ------------- | ------------------------------- |
+| `browse/:url` | Opens a URL in the dApp browser |
+
+**Parameters:**
+
+| Parameter | Type   | Required | Description                     |
+| --------- | ------ | -------- | ------------------------------- |
+| `url`     | string | Yes      | Full URL to load in the browser |
+
+**Examples:**
+
+```
+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://`).
+
+### Token Swap
+
+Open the token swap screen with optional pre-filled values:
+
+| Route  | Description              |
+| ------ | ------------------------ |
+| `swap` | Opens the swap interface |
+
+**Parameters:**
+
+| Parameter      | Type   | Required | Description                                 |
+| -------------- | ------ | -------- | ------------------------------------------- |
+| `fromCoinType` | string | No       | Source token type address (defaults to SUI) |
+| `toCoinType`   | string | No       | Destination token type address              |
+| `presetAmount` | string | No       | Pre-filled amount to swap                   |
+
+**Examples:**
+
+```
+# Open swap with SUI as source
+slush://swap
+
+# Pre-fill swap from SUI to USDC
+slush://swap?fromCoinType=0x2::sui::SUI&toCoinType=0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC
+
+# Pre-fill swap amount
+slush://swap?fromCoinType=0x2::sui::SUI&presetAmount=100
+```
+
+### Claim Assets
+
+Open the claim screen to receive stashed or gifted tokens:
+
+| Route   | Description               |
+| ------- | ------------------------- |
+| `claim` | Opens the claim interface |
+
+**Parameters:**
+
+| Parameter  | Type   | Required | Description                              |
+| ---------- | ------ | -------- | ---------------------------------------- |
+| `claimUrl` | string | Yes      | Full claim URL from zkSend or Getstashed |
+
+**Examples:**
+
+```
+slush://claim?claimUrl=https://zksend.com/claim/abc123xyz
+slush://claim?claimUrl=https://getstashed.com/claim/def456
+```
+
+### Token Details
+
+View details for a specific token:
+
+| Route    | Description             |
+| -------- | ----------------------- |
+| `tokens` | Opens token detail view |
+
+**Parameters:**
+
+| Parameter  | Type   | Required | Description                        |
+| ---------- | ------ | -------- | ---------------------------------- |
+| `coinType` | string | Yes      | Full token type address to display |
+
+**Examples:**
+
+```
+# View SUI token details
+slush://tokens?coinType=0x2::sui::SUI
+
+# View USDC token details
+slush://tokens?coinType=0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC
+```
+
+### Receive / QR Code
+
+Open the receive screen to display the wallet address or scan a QR code:
+
+| Route   | Description                        |
+| ------- | ---------------------------------- |
+| `suime` | Opens receive or QR scanner screen |
+
+**Parameters:**
+
+| Parameter | Type   | Required | Description                        |
+| --------- | ------ | -------- | ---------------------------------- |
+| `action`  | string | Yes      | Either `RECEIVE` or `SCAN_QR_CODE` |
+
+**Examples:**
+
+```
+# Show receive QR code
+slush://suime?action=RECEIVE
+
+# Open QR code scanner
+slush://suime?action=SCAN_QR_CODE
+```
+
+### DeFi Strategies
+
+Access yield strategies and DeFi opportunities:
+
+| Route                     | Description                         |
+| ------------------------- | ----------------------------------- |
+| `strategies`              | View all available strategies       |
+| `strategies/strategy/:id` | View details of a specific strategy |
+| `strategies/deposit/:id`  | Open deposit flow for a strategy    |
+| `strategies/withdraw/:id` | Open withdraw flow for a strategy   |
+
+**Path Parameters:**
+
+| Parameter | Type   | Required | Description         |
+| --------- | ------ | -------- | ------------------- |
+| `id`      | string | Yes      | Strategy identifier |
+
+**Examples:**
+
+```
+# View all strategies
+slush://strategies
+
+# View specific strategy details
+slush://strategies/strategy/lending-usdc
+
+# Deposit into a strategy
+slush://strategies/deposit/lending-usdc
+
+# Withdraw from a strategy
+slush://strategies/withdraw/lending-usdc
+```
+
+### Staking
+
+Access native and liquid staking features:
+
+| Route                    | Description            |
+| ------------------------ | ---------------------- |
+| `staking`                | Staking overview       |
+| `staking/native-stake`   | Native SUI staking     |
+| `staking/native-unstake` | Unstake native SUI     |
+| `staking/liquid-stake`   | Liquid staking         |
+| `staking/liquid-unstake` | Unstake liquid staking |
+
+**Examples:**
+
+```
+slush://staking
+slush://staking/native-stake
+slush://staking/liquid-stake
+```
+
+### Send Tokens
+
+Access the send flow:
+
+| Route               | Description              |
+| ------------------- | ------------------------ |
+| `send-coins`        | Open send flow           |
+| `send-coins/send`   | Send input screen        |
+| `send-coins/camera` | QR scanner for recipient |
+| `send-coins/review` | Review transaction       |
+
+**Examples:**
+
+```
+slush://send-coins
+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.
+
+| Route | Description                 |
+| ----- | --------------------------- |
+| `pay` | Opens the payment interface |
+
+**URI Format:**
+
+Payment Kit uses a special `sui:pay` (`slush:pay` is also supported) protocol that can be opened via
+Slush deep links:
+
+```
+https://my.slush.app/pay?receiver=<address>&amount=<amount>&coinType=<coinType>&nonce=<nonce>
+```
+
+**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              |
+
+**Examples:**
+
+```
+# Basic payment with SUI (using custom scheme)
+sui:pay?receiver=0x1234...abcd&amount=1000000000&coinType=0x2::sui::SUI&nonce=abc-123-xyz
+
+# Basic payment with SUI (using universal link)
+https://my.slush.app/pay?receiver=0x1234...abcd&amount=1000000000&coinType=0x2::sui::SUI&nonce=abc-123-xyz
+
+# Payment with registry and label
+https://my.slush.app/pay?receiver=0x1234...abcd&amount=1000000000&coinType=0x2::sui::SUI&nonce=abc-123-xyz&registry=my-registry&label=Coffee%20Payment
+
+# Payment with custom coin type
+https://my.slush.app/pay?receiver=0x1234...abcd&amount=5000000&coinType=0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC&nonce=def-456-uvw
+```
+
+> 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
+
+### Web Integration
+
+Link to Slush from any web page (mobile or desktop):
+
+```html
+<!-- Recommended: Works on all platforms -->
+<a href="https://my.slush.app/browse/https://your-dapp.com">Open in Slush</a>
+
+<!-- Mobile-only: Opens app if installed, fails otherwise -->
+<a href="slush://swap">Open Slush to Swap</a>
+<a href="slush://browse/https://your-dapp.com">Open in Slush</a>
+```
+
+### JavaScript / React Native
+
+Open Slush programmatically:
+
+```javascript
+
+// Recommended: Use my.slush.app links (works everywhere)
+Linking.openURL('https://my.slush.app/browse/https://your-dapp.com');
+
+// Alternative: Use custom schemes when you need app-specific behavior
+Linking.openURL('slush://swap?fromCoinType=0x2::sui::SUI');
+
+// Detect if native app is installed (only needed for custom schemes)
+const canOpen = await Linking.canOpenURL('slush://');
+if (canOpen) {
+	// Native app is installed
+	Linking.openURL('slush://swap');
+} else {
+	// Fall back to web app
+	Linking.openURL('https://my.slush.app/browse/https://your-dapp.com');
+}
+```
+
+### iOS (Swift)
+
+```swift
+
+// Recommended: Use my.slush.app links (works everywhere)
+if let url = URL(string: "https://my.slush.app/browse/https://your-dapp.com") {
+    UIApplication.shared.open(url)
+}
+
+// Alternative: Check for native app, fall back to web
+if let customUrl = URL(string: "slush://swap"),
+   UIApplication.shared.canOpenURL(customUrl) {
+    UIApplication.shared.open(customUrl)
+} else if let webUrl = URL(string: "https://my.slush.app/browse/https://your-dapp.com") {
+    UIApplication.shared.open(webUrl)
+}
+```
+
+### Android (Kotlin)
+
+```kotlin
+
+// Recommended: Use my.slush.app links (works everywhere)
+val intent = Intent(Intent.ACTION_VIEW, Uri.parse("https://my.slush.app/browse/https://your-dapp.com"))
+startActivity(intent)
+
+// Alternative: Use custom scheme for native app only
+val customIntent = Intent(Intent.ACTION_VIEW, Uri.parse("slush://swap"))
+startActivity(customIntent)
+```
+
+## Best Practices
+
+### 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.
+
+```html
+<!-- Recommended: Works on mobile (app or browser) and desktop -->
+<a href="https://my.slush.app/browse/https://your-dapp.com">Open in Slush</a>
+
+<!-- Alternative: Only works if mobile app is installed -->
+<a href="slush://browse/https://your-dapp.com">Open in Slush</a>
+```
+
+> 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
+
+Always URL-encode parameter values, especially token type addresses which contain special
+characters:
+
+```javascript
+const coinType = '0x2::sui::SUI';
+const encodedCoinType = encodeURIComponent(coinType);
+const url = `slush://swap?fromCoinType=${encodedCoinType}`;
+```
+
+### 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
+back to the web app.
+
+```javascript
+const canOpenSlush = await Linking.canOpenURL('slush://');
+if (canOpenSlush) {
+	Linking.openURL('slush://swap');
+} else {
+	// Fall back to my.slush.app which always works
+	Linking.openURL('https://my.slush.app/browse/https://your-dapp.com');
+}
+```
+
+### 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
+
+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
+
+### 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
+
+### Universal Links Open in Browser Instead of App
+
+This can happen if:
+
+- The link is typed directly into the address bar
+- The link domain is the same as the current page
+- The user has previously chosen to open links in Safari
+
+To ensure Universal Links work reliably, link from a different domain than the target domain.

package/dist/slush-wallet/index.md

@@ -0,0 +1,7 @@
+# Slush Wallet Integration
+
+> Integrate Slush Wallet into your Sui dApp
+
+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
+experience.

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

@@ -0,0 +1,6 @@
+# Slush Wallet
+> Slush Wallet Integration
+
+- [Slush Wallet Integration](./index.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

package/dist/sui/bcs.md

@@ -0,0 +1,134 @@
+# BCS
+
+> Binary Canonical Serialization for encoding Sui Move types
+
+The `@mysten/sui/bcs` package extends `@mysten/bcs` with Sui specific scheme definitions.
+
+To learn more about using BCS see the [BCS documentation](/bcs).
+
+the `bcs` export of `@mysten/sui/bcs` contains all the same exports as `bcs` from `@mysten/bcs` plus
+the following pre-defined schemes:
+
+- `U8`
+- `U16`
+- `U32`
+- `U64`
+- `U128`
+- `U256`
+- `ULEB128`
+- `Bool`
+- `String`
+- `Address`
+- `Argument`
+- `CallArg`
+- `CompressedSignature`
+- `GasData`
+- `MultiSig`
+- `MultiSigPkMap`
+- `MultiSigPublicKey`
+- `ObjectArg`
+- `ObjectDigest`
+- `ProgrammableMoveCall`
+- `ProgrammableTransaction`
+- `PublicKey`
+- `SenderSignedData`
+- `SharedObjectRef`
+- `StructTag`
+- `SuiObjectRef`
+- `Transaction`
+- `TransactionData`
+- `TransactionDataV1`
+- `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
+
+All the upper-cased values are `BcsType` instances, and can be used directly to parse and serialize
+data.
+
+```typescript
+
+bcs.U8.serialize(1);
+bcs.Address.serialize('0x1');
+bcs.TypeTag.serialize({
+	vector: {
+		u8: true,
+	},
+});
+```
+
+## Working with Objects
+
+To parse on-chain 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:
+
+```typescript
+
+const { object } = await client.core.getObject({
+	objectId: '0x123...',
+	include: { content: true },
+});
+
+const parsed = MyStruct.parse(object.content);
+```
+
+### `bcs.Object` — Full object envelope
+
+The `bcs.Object` schema represents the complete on-chain 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`.
+
+```typescript
+
+// Parse a full object envelope (from objectBcs include option)
+const envelope = bcs.Object.parse(object.objectBcs);
+console.log('Owner:', envelope.owner);
+console.log('Inner struct bytes:', envelope.data.Move.contents);
+
+// Serialize a full object envelope
+const serialized = bcs.Object.serialize({
+	data: {
+		Move: {
+			type: { GasCoin: null },
+			hasPublicTransfer: true,
+			version: '1',
+			contents: new Uint8Array([...]),
+		},
+	},
+	owner: { AddressOwner: '0x...' },
+	previousTransaction: '...',
+	storageRebate: '1000',
+});
+```
+
+> **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
+
+The `bcs.TransactionEffects` schema can be used to parse transaction effects:
+
+```typescript
+
+// Parse transaction effects
+const effects = bcs.TransactionEffects.parse(effectsBytes);
+
+// Check execution status
+if (effects.V2.status.$kind === 'Success') {
+	console.log('Transaction succeeded');
+} else {
+	console.log('Transaction failed:', effects.V2.status.Failure.error);
+}
+
+// Access changed objects
+for (const [objectId, change] of effects.V2.changedObjects) {
+	console.log('Object:', objectId);
+	console.log('Output state:', change.outputState.$kind);
+}
+```