Onchain OS Wallet

1. Translate user input into a CLI-recognized chain name or numeric ID (e.g. "币安链" → bsc, "以太坊" → ethereum). The CLI recognizes: ethereum/eth, solana/sol, bsc/bnb, polygon/matic, arbitrum/arb, base, xlayer/okb, avalanche/avax, optimism/op, fantom/ftm, sui, tron/trx, ton, linea, scroll, zksync, plus any numeric chain ID.
2. If <100% confident in the mapping → ask user to confirm before calling.
3. Pass the resolved name or ID to --chain.
4. If the command returns "unsupported chain: ...", the name was not in the CLI mapping. Ask the user to confirm, and run onchainos wallet chains to show the full supported list.

If no confident match: do NOT guess — ask the user. Display chain names as human-readable (e.g. "Ethereum", "BNB Chain"), never IDs.

Example flow:

# User says: "Show my balance on Ethereum"
          → onchainos wallet balance --chain ethereum
# Also valid: onchainos wallet balance --chain 1

Error handling:

# User says: "Show my balance on Fantom"
          → onchainos wallet balance --chain fantom
# If CLI returns "unsupported chain: fantom":
#   → Ask user: "The chain 'Fantom' was not recognized. Its chain ID is 250 — would you like me to try with that?"
#   → Or run `onchainos wallet chains` to check if the chain is supported

Amount

wallet send: pass --readable-amount <human_amount> — CLI auto-converts (native: EVM=18, SOL/SUI=9 decimals; ERC-20/SPL: fetched from API). Never compute minimal units manually. Use --amt only for raw minimal units.

wallet contract-call: --amt is the native token value attached to the call (payable functions only), in minimal units. Default "0" for non-payable. EVM=18 decimals, SOL=9.

Command Index

CLI Reference: For full parameter tables, return field schemas, and usage examples, see cli-reference.md.

A — Account Management

Login commands (wallet login, wallet verify) are covered in Step 2: Authentication.

B — Authenticated Balance

D — Transaction

The --force flag MUST ONLY be added when ALL of the following conditions are met:

1. You have already called the command without --force once.
2. The API returned a confirming response (exit code 2, "confirming": true).
3. You displayed the message to the user and the user explicitly confirmed they want to proceed.

Determine intent before executing (wrong command → loss of funds):

Intent	Command	Example
Send native token (ETH, SOL, BNB…)	wallet send --chain <chain>	"Send 0.1 ETH to 0xAbc"
Send ERC-20 / SPL token (USDC, USDT…)	wallet send --chain <chain> --contract-token	"Transfer 100 USDC to 0xAbc"
Interact with a smart contract (approve, deposit, withdraw, custom function call…)	wallet contract-call --chain <chain>	"Approve USDC for spender", "Call withdraw on contract 0xDef"

If the intent is ambiguous, always ask the user to clarify before proceeding. Never guess.

E — History

F — Sign Message

Confirming Response

Some commands return confirming (exit code 2) when backend requires user confirmation (e.g., high-risk tx).

Output format

{
  "confirming": true,
  "message": "The human-readable prompt to show the user.",
  "next": "Instructions for what the agent should do after user confirms."
}

How to handle

1. Display the message field to the user and ask for confirmation.
2. If the user confirms: follow the instructions in the next field (typically re-running the same command with --force flag appended).
3. If the user declines: do NOT proceed. Inform the user the operation was cancelled.

Example flow

# 1. Run command without --force
onchainos wallet send --readable-amount "0.1" --recipient "0xAbc..." --chain 1
# → exit code 2, confirming: true → show message to user

# 2. User confirms → re-run with --force
onchainos wallet send --readable-amount "0.1" --recipient "0xAbc..." --chain 1 --force

Authentication

For commands requiring auth (sections B, D, E), check login state:

1. Run onchainos wallet status. If loggedIn: true, proceed.
2. If not logged in, or the user explicitly requests to re-login:
   • 2a. Display the following message to the user verbatim (translated to the user's language):

     You need to log in with your email first before adding a wallet. What is your email address? We also offer an API Key login method that doesn't require an email. If interested, visit https://web3.okx.com/onchainos/dev-docs/home/api-access-and-usage

   • 2b. Once the user provides their email, run: onchainos wallet login <email> --locale <locale>. Then display the following message verbatim (translated to the user's language):

     English: "A verification code has been sent to {email}. Please check your inbox and tell me the code." Chinese: "验证码已发送到 {email}，请查收邮件并告诉我验证码。" Once the user provides the code, run: onchainos wallet verify <code>. AI should always infer --locale from conversation context and include it:

     • Chinese (简体/繁体, or user writes in Chinese) → zh-CN
     • Japanese (user writes in Japanese) → ja-JP
     • English or any other language → en-US (default)

     If you cannot confidently determine the user's language, default to en-US.

3. If the user declines to provide an email:
   • 3a. Display the following message to the user verbatim (translated to the user's language):

     We also offer an API Key login method that doesn't require an email. If interested, visit https://web3.okx.com/onchainos/dev-docs/home/api-access-and-usage

   • 3b. If the user confirms they want to use API Key, first check whether an API Key switch is needed: Use the wallet status result (from step 1 or re-run). If loginType is "ak" and the returned apiKey differs from the current environment variable OKX_API_KEY, show both keys to the user and ask to confirm the switch. If the user confirms, run onchainos wallet login --force. If apiKey is absent, empty, or identical, skip the confirmation and run onchainos wallet login directly.
   • 3c. After silent login succeeds, inform the user that they have been logged in via the API Key method.
4. After login succeeds, display the full account list with addresses by running onchainos wallet balance.
5. New user check: If the wallet verify or wallet login response contains "isNew": true, read and follow references/new-user-guide.md to display the new-user guidance. If "isNew": false, skip this step.

After successful login: a wallet account is created automatically — never call wallet add unless the user is already logged in and explicitly requests an additional account.

MEV Protection

The contract-call command supports MEV (Maximal Extractable Value) protection via the --mev-protection flag. When enabled, the broadcast API passes isMEV: true in extraData to route the transaction through MEV-protected channels, preventing front-running, sandwich attacks, and other MEV exploitation.

⚠️ Solana MEV Protection: On Solana, enabling --mev-protection also requires the --jito-unsigned-tx parameter. Without it, the command will fail. This parameter provides the Jito bundle unsigned transaction data needed for Solana MEV-protected routing.

🚨 Never substitute --unsigned-tx for --jito-unsigned-tx — they are completely different parameters. If Jito bundle data is unavailable, stop and ask the user: proceed without MEV protection, or cancel.

Supported Chains

When to Enable

• High-value transfers or swaps where front-running risk is significant
• DEX swap transactions executed via contract-call
• When the user explicitly requests MEV protection

Usage

# EVM contract call with MEV protection (Ethereum/BSC/Base)
onchainos wallet contract-call --to 0xDef... --chain 1 --input-data 0x... --mev-protection

# Solana contract call with MEV protection (requires --jito-unsigned-tx)
onchainos wallet contract-call --to <program_id> --chain 501 --unsigned-tx <base58_tx> --mev-protection --jito-unsigned-tx <jito_base58_tx>

Amount Display Rules

• Token amounts always in UI units (1.5 ETH), never base units (1500000000000000000)
• USD values with 2 decimal places
• Large amounts in shorthand ($1.2M, $340K)
• Sort by USD value descending
• Always show abbreviated contract address alongside token symbol (format: 0x1234...abcd). For native tokens with empty tokenContractAddress, display (native).
• Flag suspicious prices: if the token appears to be a wrapped/bridged variant (e.g., symbol like wETH, stETH, wBTC, xOKB) AND the reported price differs >50% from the known base token price, add an inline price unverified flag and suggest running onchainos token price-info to cross-check.

Security Notes

• TEE signing: Private key never leaves the secure enclave.
• Transaction simulation: CLI runs pre-execution simulation. If executeResult is false → show executeErrorMsg, do NOT broadcast.
• Sensitive fields never to expose: accessToken, refreshToken, apiKey, secretKey, passphrase, sessionKey, sessionCert, teeId, encryptedSessionSk, signingKey, raw tx data. Only show: email, accountId, accountName, isNew, addressList, txHash.
• Recipient address validation: EVM: 0x-prefixed, 42 chars. Solana: Base58, 32-44 chars. Validate before sending.
• Risk action priority: block > warn > empty (safe). Top-level action = highest priority from riskItemDetail.
• Approve calls:

• Do NOT set approve amount to type(uint256).max or 2^256-1 or any equivalent "infinite" value.
• Do NOT call setApprovalForAll(operator, true) — this grants full control over all tokens of that type.
• If the user explicitly requests unlimited approval, you MUST:
  1. Warn that this is irreversible and allows the spender to drain all tokens at any time.
  2. Wait for explicit secondary confirmation ("I understand the risk, proceed").
  3. Even after confirmation, cap the approve amount to the actual needed amount (e.g. swap amount + 10% buffer), never unlimited.
• If the user insists on unlimited after the warning, refuse and suggest they execute manually via a block explorer. </NEVER>

Agent Policy Guidance

Policy configuration must be completed by the user on the Web portal. The Agent only detects the scenario, provides guidance, and gives the jump link.

Available Policy Rules

Policy only includes the following rules. Do NOT invent or mention any rules beyond this list (e.g., no "transaction count limit", no "gas limit", no "token blacklist"):

The following three subsections are trigger conditions — when any condition is met, the Agent MUST output the corresponding guidance. Do not skip or omit.

New user login (isNew: true)

Handled in Authentication step 5

New account via wallet add

After a successful wallet add, MUST output the following message (translated to the user's language):

New account created. You can configure spending limits and transfer whitelist in Policy Settings → https://web3.okx.com/portfolio/agentic-wallet-policy

User asks about Policy

e.g., "How do I set a spending limit?", "What's my daily limit?", "How to configure whitelist?"

• Run onchainos wallet status and check the policy field.
• policy is null or all flags are false: explain what Policy offers (per-tx limit, daily transfer/trade limit, transfer whitelist) and provide the link: https://web3.okx.com/portfolio/agentic-wallet-policy
• Any flag is true: display the current settings (limits, used amounts) and provide the same link for modifications.

Wallet Export Guidance

The Agent must never display any mnemonic phrase or private key content in the conversation. The Agent's role is limited to: recognizing user intent, explaining the risks, and providing the Web portal link.

User asks about wallet export

e.g., "How do I export my mnemonic?", "I want to migrate my wallet", "How do I import my wallet into a hardware wallet?"

When triggered, output the following message (translated to the user's language):

Wallet export must be completed on the Web portal. Please note: once the export is complete, your current wallet will be permanently unbound from your email, and the Agent will no longer be able to operate this wallet. The system will automatically create a new empty wallet for your account. Before exporting, please transfer your assets to a safe address and stop any running strategies. [Go to Wallet Export → https://web3.okx.com] Log in to your Agentic Wallet, then hover over your profile in the top-right corner and select "Export Wallet" from the dropdown menu.

Edge Cases

Load on error: references/troubleshooting.md

Global Notes

FAQ

Q: The agent cannot autonomously sign and execute transactions — it says local signing is required or asks the user to sign manually. How does signing work?

A: OKX Agentic Wallet uses TEE (Trusted Execution Environment) for transaction signing. The private key is generated and stored inside a server-side secure enclave — it never leaves the TEE.