@axonfi/sdk 0.4.3 → 0.4.4

package/README.md

@@ -139,7 +139,7 @@ const result = await axon.swap({
 
 ### DeFi Protocol Execution
 
-Interact with DeFi and Web3 protocols (Uniswap, Aave, GMX, etc.) that need permission to access collateral from your vault. The bot signs an `ExecuteIntent` specifying the target contract and calldata. The relayer handles token approvals, execution, and revocation in a single atomic transaction. All executions are subject to the bot's per-transaction and daily spending limits.
+Interact with DeFi and Web3 protocols (Uniswap, Aave, GMX, Ostium, etc.) from your vault. The bot signs an `ExecuteIntent` specifying the target contract and calldata. The relayer handles token approvals, execution, and revocation in a single atomic transaction. All executions are subject to the bot's per-transaction and daily spending limits.
 
 ```typescript
 const result = await axon.execute({
@@ -150,6 +150,69 @@ const result = await axon.execute({
 });
 ```
 
+#### When the approval target differs from the call target
+
+In simple cases (Uniswap, Aave), the contract you call is the same contract that pulls your tokens — `execute()` handles this automatically in a single call.
+
+But many DeFi protocols split these into two contracts:
+
+- **Call target** (`protocol`) — the contract you send the transaction to (e.g., Ostium's `Trading` for `openTrade()`)
+- **Approval target** — the contract that actually calls `transferFrom()` to pull tokens from your vault (e.g., Ostium's `TradingStorage`)
+
+When these differ, you need a **two-step pattern**: first give the approval target a persistent token allowance, then call the action.
+
+**Example — Ostium perpetual futures:**
+
+Ostium's `openTrade()` lives on the Trading contract, but collateral gets pulled by TradingStorage. The vault must approve TradingStorage, not Trading.
+
+```typescript
+const USDC = '0x...';                // USDC on your chain
+const OSTIUM_TRADING = '0x...';      // calls openTrade()
+const OSTIUM_TRADING_STORAGE = '0x...'; // pulls USDC via transferFrom()
+
+// Step 1: Persistent approval (one-time) — call approve() on the token contract
+// This tells USDC to let TradingStorage spend from the vault.
+await axon.execute({
+  protocol: USDC,                    // call target: the token contract itself
+  callData: encodeApprove(OSTIUM_TRADING_STORAGE, MaxUint256),
+  token: USDC,
+  amount: 0,                         // no token spend, just setting an allowance
+  protocolName: 'USDC Approve',
+});
+
+// Step 2: Open trade — call the action contract
+await axon.execute({
+  protocol: OSTIUM_TRADING,          // call target: the Trading contract
+  callData: encodeOpenTrade(...),
+  token: USDC,
+  amount: 50_000_000,                // 50 USDC — passed for dashboard/AI visibility
+  protocolName: 'Ostium',
+});
+```
+
+**Vault setup (owner, one-time):** Two contracts must be approved via `approveProtocol()`:
+1. **USDC** (the token contract) — because the vault calls `approve()` on it directly
+2. **Trading** — because the vault calls `openTrade()` on it
+
+TradingStorage does *not* need to be approved — it's just an argument to `approve()`, not a contract the vault calls.
+
+> **Note:** Common tokens (USDC, USDT, WETH, etc.) are pre-approved globally via the Axon registry as default tokens, so you typically only need to approve the DeFi protocol contract itself. You only need to approve a token if it's uncommon and not in the registry defaults.
+
+> **Testnet note:** If the protocol uses a custom token that isn't on Uniswap (e.g., Ostium's testnet USDC), set the bot's `maxPerTxAmount` to `0` to skip TWAP oracle pricing.
+
+This pattern applies to any protocol where the approval target differs from the call target (GMX, some lending protocols, etc.).
+
+#### `ContractNotApproved` error
+
+If `execute()` reverts with `ContractNotApproved`, the `protocol` address you're calling isn't approved. Two possible causes:
+
+1. **The DeFi protocol contract isn't approved** — the vault owner must call `approveProtocol(address)` on the vault for the protocol contract (e.g., Uniswap Router, Ostium Trading, Lido stETH).
+2. **The token contract isn't approved** — when doing a token approval (Step 1 above), the token must either be approved on the vault via `approveProtocol(tokenAddress)` or be a registry default token. Common tokens (USDC, USDT, WETH, DAI, etc.) are pre-approved globally by Axon, but uncommon tokens (e.g., stETH, aUSDC, cTokens) may need manual approval.
+
+**Example — Lido staking/unstaking:** To unstake stETH, Lido's withdrawal contract calls `transferFrom()` to pull stETH from your vault. You need:
+- `approveProtocol(stETH)` — so the vault can call `approve()` on the stETH token to grant Lido an allowance
+- `approveProtocol(lidoWithdrawalQueue)` — so the vault can call `requestWithdrawals()` on Lido
+
 ### Vault Reads
 
 Query your vault's on-chain state — balances, bot status, pause state, and destination checks. All reads go through the relayer (no RPC connection needed).

package/dist/index.cjs

@@ -439,12 +439,12 @@ var AxonVaultAbi = [
   },
   {
     "type": "function",
-    "name": "addProtocol",
+    "name": "addRebalanceTokens",
     "inputs": [
       {
-        "name": "protocol",
-        "type": "address",
-        "internalType": "address"
+        "name": "tokens",
+        "type": "address[]",
+        "internalType": "address[]"
       }
     ],
     "outputs": [],
@@ -452,12 +452,12 @@ var AxonVaultAbi = [
   },
   {
     "type": "function",
-    "name": "addRebalanceTokens",
+    "name": "approveProtocol",
     "inputs": [
       {
-        "name": "tokens",
-        "type": "address[]",
-        "internalType": "address[]"
+        "name": "protocol",
+        "type": "address",
+        "internalType": "address"
       }
     ],
     "outputs": [],
@@ -1015,7 +1015,7 @@ var AxonVaultAbi = [
   },
   {
     "type": "function",
-    "name": "isProtocolApproved",
+    "name": "isContractApproved",
     "inputs": [
       {
         "name": "protocol",
@@ -1239,19 +1239,6 @@ var AxonVaultAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
-  {
-    "type": "function",
-    "name": "removeProtocol",
-    "inputs": [
-      {
-        "name": "protocol",
-        "type": "address",
-        "internalType": "address"
-      }
-    ],
-    "outputs": [],
-    "stateMutability": "nonpayable"
-  },
   {
     "type": "function",
     "name": "removeRebalanceTokens",
@@ -1272,6 +1259,19 @@ var AxonVaultAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "revokeProtocol",
+    "inputs": [
+      {
+        "name": "protocol",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setOperator",
@@ -1782,7 +1782,7 @@ var AxonVaultAbi = [
   },
   {
     "type": "event",
-    "name": "ProtocolAdded",
+    "name": "ProtocolApproved",
     "inputs": [
       {
         "name": "protocol",
@@ -1832,7 +1832,7 @@ var AxonVaultAbi = [
   },
   {
     "type": "event",
-    "name": "ProtocolRemoved",
+    "name": "ProtocolRevoked",
     "inputs": [
       {
         "name": "protocol",
@@ -2029,6 +2029,11 @@ var AxonVaultAbi = [
     "name": "CalldataHashMismatch",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "ContractNotApproved",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "DeadlineExpired",
@@ -2193,11 +2198,6 @@ var AxonVaultAbi = [
     "name": "ProtocolNotApproved",
     "inputs": []
   },
-  {
-    "type": "error",
-    "name": "ProtocolNotInList",
-    "inputs": []
-  },
   {
     "type": "error",
     "name": "RebalanceTokenNotAllowed",
@@ -2763,6 +2763,7 @@ var Token = /* @__PURE__ */ ((Token2) => {
   Token2["cbETH"] = "cbETH";
   Token2["wstETH"] = "wstETH";
   Token2["rETH"] = "rETH";
+  Token2["weETH"] = "weETH";
   Token2["LINK"] = "LINK";
   Token2["UNI"] = "UNI";
   Token2["AAVE"] = "AAVE";
@@ -2860,9 +2861,19 @@ var KNOWN_TOKENS = {
     name: "Rocket Pool ETH",
     decimals: 18,
     addresses: {
+      8453: "0xB6fe221Fe9EeF5aBa221c348bA20A1Bf5e73624c",
       42161: "0xEC70Dcb4A1EFa46b8F2D97C310C9c4790ba5ffA8"
     }
   },
+  weETH: {
+    symbol: "weETH",
+    name: "EtherFi Wrapped eETH",
+    decimals: 18,
+    addresses: {
+      8453: "0x04C0599Ae5A44757c0af6F9eC3b93da8976c150A",
+      42161: "0x35751007a407ca6FEFfE80b3cB397736D2cf4dbe"
+    }
+  },
   // ── DeFi blue-chips ─────────────────────────────────────
   LINK: {
     symbol: "LINK",
@@ -2944,6 +2955,27 @@ var KNOWN_TOKENS = {
     }
   }
 };
+var DEFAULT_APPROVED_TOKENS = [
+  "USDC",
+  "USDT",
+  "DAI",
+  "WETH",
+  "WBTC",
+  "cbBTC",
+  "wstETH",
+  "weETH",
+  "cbETH",
+  "rETH"
+];
+function getDefaultApprovedTokens(chainId) {
+  const addresses = [];
+  for (const symbol of DEFAULT_APPROVED_TOKENS) {
+    const entry = KNOWN_TOKENS[symbol];
+    const addr = entry.addresses[chainId];
+    if (addr) addresses.push(addr);
+  }
+  return addresses;
+}
 var addressToSymbol = /* @__PURE__ */ new Map();
 for (const token of Object.values(KNOWN_TOKENS)) {
   for (const addr of Object.values(token.addresses)) {
@@ -3525,10 +3557,10 @@ var AxonClient = class {
     return this._get(path);
   }
   // ============================================================================
-  // isProtocolApproved() — via relayer
+  // isContractApproved() — via relayer
   // ============================================================================
-  /** Returns whether a protocol address is approved for executeProtocol() calls (via relayer). */
-  async isProtocolApproved(protocol) {
+  /** Returns whether a contract address (protocol or token) is approved for executeProtocol() calls (via relayer). */
+  async isContractApproved(protocol) {
     const path = RELAYER_API.protocolCheck(this.vaultAddress, protocol, this.chainId);
     const data = await this._get(path);
     return data.approved;
@@ -3890,6 +3922,19 @@ var AxonRegistryAbi = [
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "VERSION",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "acceptOwnership",
@@ -3923,6 +3968,19 @@ var AxonRegistryAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "approveDefaultToken",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "isApprovedSwapRouter",
@@ -3961,6 +4019,25 @@ var AxonRegistryAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "isDefaultToken",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "owner",
@@ -4020,6 +4097,19 @@ var AxonRegistryAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "revokeDefaultToken",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setOracleConfig",
@@ -4095,6 +4185,32 @@ var AxonRegistryAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "event",
+    "name": "DefaultTokenApproved",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "DefaultTokenRevoked",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "OracleConfigUpdated",
@@ -4265,6 +4381,7 @@ exports.AxonVaultAbi = AxonVaultAbi;
 exports.AxonVaultFactoryAbi = AxonVaultFactoryAbi;
 exports.CHAIN_NAMES = CHAIN_NAMES;
 exports.Chain = Chain;
+exports.DEFAULT_APPROVED_TOKENS = DEFAULT_APPROVED_TOKENS;
 exports.DEFAULT_DEADLINE_SECONDS = DEFAULT_DEADLINE_SECONDS;
 exports.EIP712_DOMAIN_NAME = EIP712_DOMAIN_NAME;
 exports.EIP712_DOMAIN_VERSION = EIP712_DOMAIN_VERSION;
@@ -4296,6 +4413,7 @@ exports.findMatchingOption = findMatchingOption;
 exports.formatPaymentSignature = formatPaymentSignature;
 exports.getBotConfig = getBotConfig;
 exports.getChain = getChain;
+exports.getDefaultApprovedTokens = getDefaultApprovedTokens;
 exports.getDomainSeparator = getDomainSeparator;
 exports.getKnownTokensForChain = getKnownTokensForChain;
 exports.getOperatorCeilings = getOperatorCeilings;