HTTP API

{
  "success": true,
  "data": { /* endpoint payload */ },
  "meta": {
    "command": "health.shallow",
    "chainId": 4663,
    "timestamp": "2026-10-11T14:56:14.292Z"
  }
}

interface PreparedAction {
  txs: Array<{
    to: `0x${string}`;
    data: `0x${string}`;
    value: `0x${string}`;     // hex-encoded (matches EIP-5792 / wallet_sendCalls)
    chainId: number;
  }>;
  preconditions: Array<           // things to verify before broadcasting
    | { type: "balance"; asset; assetSymbol; min; minDecimal }
    | { type: "allowance"; token; spender; min; minDecimal }
    | { type: "vault-not-locked"; vault }
    | { type: "depositor-approved"; vault; depositor }
  >;
  description: string;
  note?: string;
}

# 1. Look up the vault to confirm it's open + read the asset
curl -s 'https://api.sherwood.sh/vaults/0xVaultAddress?chain=4663' | jq

# 2. Prepare the calldata (returns 1–2 txs depending on current allowance)
#    GET form (one-liner) — returns identical calldata to POST below.
curl -s 'https://api.sherwood.sh/prepare/deposit?chainId=4663&vault=0xVaultAddress&receiver=0xYourAddress&amountDecimal=1' | jq

# Or POST form — useful when args are dynamic / programmatically built.
curl -sX POST https://api.sherwood.sh/prepare/deposit \
  -H 'content-type: application/json' \
  -d '{
    "chainId": 4663,
    "vault": "0xVaultAddress",
    "receiver": "0xYourAddress",
    "amountDecimal": "1"
  }' | jq

{
  "success": true,
  "data": {
    "txs": [
      { "to": "0x5fc5360D0400a0Fd4f2af552ADD042D716F1d168", "data": "0x095ea7b3...", "value": "0x0", "chainId": 4663 },
      { "to": "0xVaultAddress", "data": "0x6e553f65...", "value": "0x0", "chainId": 4663 }
    ],
    "preconditions": [
      { "type": "balance",   "asset": "0x5fc5360D0400a0Fd4f2af552ADD042D716F1d168", "assetSymbol": "USDG", "min": "1000000", "minDecimal": "1" },
      { "type": "allowance", "token": "0x5fc5360D0400a0Fd4f2af552ADD042D716F1d168", "spender": "0xVaultAddress", "min": "1000000", "minDecimal": "1" },
      { "type": "vault-not-locked",  "vault": "0xVaultAddress" },
      { "type": "depositor-approved","vault": "0xVaultAddress", "depositor": "0xYourAddress" }
    ],
    "description": "Approve USDG for 0xVaultAddress, then deposit 1 USDG.",
    "note": "Both txs are gated by vault state. If `depositsLocked()` is true (a proposal is open) the deposit reverts; queue it with /prepare/request-deposit instead. The receiver must be an approved depositor while the factory's depositsRestricted flag is on."
  },
  "meta": { "command": "prepare.deposit", "chainId": 4663, "timestamp": "..." }
}