@axonfi/sdk 0.14.0 → 0.15.0

package/README.md

@@ -4,7 +4,7 @@ Give your AI agents a wallet they can't drain.
 
 ## What is Axon Finance
 
-Treasury and payment infrastructure for autonomous AI agents. Non-custodial vaults, gasless bots, AI verification.
+Agentic finance infrastructure. Secure, non-custodial vaults for autonomous AI agents. Gasless bots, AI verification.
 
 ## Why Axon Finance
 
@@ -53,14 +53,19 @@ Everything can be done from code — no dashboard needed. An agent can bootstrap
 
 ```typescript
 import {
-  AxonClient, deployVault, addBot, deposit,
-  createAxonPublicClient, createAxonWalletClient,
-  WINDOW, Chain,
+  AxonClient,
+  deployVault,
+  addBot,
+  deposit,
+  createAxonPublicClient,
+  createAxonWalletClient,
+  WINDOW,
+  Chain,
 } from '@axonfi/sdk';
 import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';
 
 // ── 1. Owner wallet (funded with ETH for gas) ─────────────────────
-const ownerKey = '0x...';  // or generate: generatePrivateKey()
+const ownerKey = '0x...'; // or generate: generatePrivateKey()
 const chainId = Chain.BaseSepolia;
 const ownerWallet = createAxonWalletClient(ownerKey, chainId);
 const publicClient = createAxonPublicClient(chainId, 'https://sepolia.base.org');
@@ -79,14 +84,16 @@ await axon.acceptTos(ownerWallet, ownerWallet.account!.address);
 
 // ── 5. Register the bot on the vault (on-chain tx, ~0.0005 ETH gas)
 await addBot(ownerWallet, publicClient, vaultAddress, botAddress, {
-  maxPerTxAmount: 100,                // $100 hard cap per tx
-  maxRebalanceAmount: 0,              // no rebalance cap
-  spendingLimits: [{
-    amount: 1000,                     // $1,000/day rolling limit
-    maxCount: 0,                      // no tx count limit
-    windowSeconds: WINDOW.ONE_DAY,
-  }],
-  aiTriggerThreshold: 50,            // AI scan above $50
+  maxPerTxAmount: 100, // $100 hard cap per tx
+  maxRebalanceAmount: 0, // no rebalance cap
+  spendingLimits: [
+    {
+      amount: 1000, // $1,000/day rolling limit
+      maxCount: 0, // no tx count limit
+      windowSeconds: WINDOW.ONE_DAY,
+    },
+  ],
+  aiTriggerThreshold: 50, // AI scan above $50
   requireAiVerification: false,
 });
 
@@ -103,19 +110,19 @@ await deposit(ownerWallet, publicClient, vaultAddress, 'USDC', 500);
 
 ### What Needs Gas vs. What's Gasless
 
-| Step | Who pays gas | Notes |
-|------|-------------|-------|
-| Deploy vault | Owner | ~0.001 ETH. One-time. |
-| Accept ToS | Owner | Wallet signature only (no gas). |
-| Register bot | Owner | ~0.0005 ETH. One per bot. |
-| Configure bot | Owner | ~0.0003 ETH. Only when changing limits. |
-| Deposit ETH | Depositor | Anyone can deposit. ETH sent directly. |
-| Deposit ERC-20 | Depositor | Anyone can deposit. SDK handles approve + deposit. |
-| **Pay** | **Free (relayer)** | **Bot signs EIP-712 intent. Axon pays gas.** |
-| **Execute (DeFi)** | **Free (relayer)** | **Bot signs intent. Axon pays gas.** |
-| **Swap (rebalance)** | **Free (relayer)** | **Bot signs intent. Axon pays gas.** |
-| Pause/unpause | Owner | ~0.0002 ETH. Emergency only. |
-| Withdraw | Owner | ~0.0003 ETH. Owner-only. |
+| Step                 | Who pays gas       | Notes                                              |
+| -------------------- | ------------------ | -------------------------------------------------- |
+| Deploy vault         | Owner              | ~0.001 ETH. One-time.                              |
+| Accept ToS           | Owner              | Wallet signature only (no gas).                    |
+| Register bot         | Owner              | ~0.0005 ETH. One per bot.                          |
+| Configure bot        | Owner              | ~0.0003 ETH. Only when changing limits.            |
+| Deposit ETH          | Depositor          | Anyone can deposit. ETH sent directly.             |
+| Deposit ERC-20       | Depositor          | Anyone can deposit. SDK handles approve + deposit. |
+| **Pay**              | **Free (relayer)** | **Bot signs EIP-712 intent. Axon pays gas.**       |
+| **Execute (DeFi)**   | **Free (relayer)** | **Bot signs intent. Axon pays gas.**               |
+| **Swap (rebalance)** | **Free (relayer)** | **Bot signs intent. Axon pays gas.**               |
+| Pause/unpause        | Owner              | ~0.0002 ETH. Emergency only.                       |
+| Withdraw             | Owner              | ~0.0003 ETH. Owner-only.                           |
 
 **The key insight:** Setup operations (deploy, add bot, deposit) require gas from the owner. Once setup is complete, all bot operations (payments, DeFi, swaps) are gasless — the bot never needs ETH. The relayer pays all execution gas.
 
@@ -226,6 +233,8 @@ Rebalance tokens inside your vault without withdrawing. Swap between any tokens
 const result = await axon.swap({
   toToken: Token.WETH,
   minToAmount: 0.001,
+  fromToken: Token.USDC,
+  maxFromAmount: 5,
   memo: 'Rebalance to WETH',
 });
 ```
@@ -284,10 +293,11 @@ await axon.execute({
 ```
 
 **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.
+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.
 
@@ -303,6 +313,7 @@ If `execute()` reverts with `ContractNotApproved`, the `protocol` address you're
 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
 
@@ -418,7 +429,7 @@ Supports EIP-3009 (USDC, gasless) and Permit2 (any ERC-20) settlement schemes.
 - [Documentation](https://axonfi.xyz/llms.txt)
 - [npm — @axonfi/sdk](https://www.npmjs.com/package/@axonfi/sdk)
 - [PyPI — axonfi](https://pypi.org/project/axonfi/) (Python SDK)
-- [Smart Contracts](https://github.com/axonfi/contracts)
+- [Smart Contracts](https://github.com/axonfi/smart-contracts)
 - [Examples](https://github.com/axonfi/examples)
 - [Twitter/X — @axonfixyz](https://x.com/axonfixyz)
 

package/dist/index.cjs

@@ -22,7 +22,7 @@ var EXECUTE_INTENT_TYPEHASH = viem.keccak256(
   )
 );
 var SWAP_INTENT_TYPEHASH = viem.keccak256(
-  viem.stringToBytes("SwapIntent(address bot,address toToken,uint256 minToAmount,uint256 deadline,bytes32 ref)")
+  viem.stringToBytes("SwapIntent(address bot,address toToken,uint256 minToAmount,address fromToken,uint256 maxFromAmount,uint256 deadline,bytes32 ref)")
 );
 var EIP712_DOMAIN_NAME = "AxonVault";
 var EIP712_DOMAIN_VERSION = "1";
@@ -167,6 +167,8 @@ var SWAP_INTENT_TYPES = {
     { name: "bot", type: "address" },
     { name: "toToken", type: "address" },
     { name: "minToAmount", type: "uint256" },
+    { name: "fromToken", type: "address" },
+    { name: "maxFromAmount", type: "uint256" },
     { name: "deadline", type: "uint256" },
     { name: "ref", type: "bytes32" }
   ]
@@ -232,6 +234,8 @@ async function signSwapIntent(walletClient, vaultAddress, chainId, intent) {
       bot: intent.bot,
       toToken: intent.toToken,
       minToAmount: intent.minToAmount,
+      fromToken: intent.fromToken,
+      maxFromAmount: intent.maxFromAmount,
       deadline: intent.deadline,
       ref: intent.ref
     }
@@ -501,8 +505,8 @@ var AxonVaultAbi = [
     "outputs": [
       {
         "name": "",
-        "type": "bool",
-        "internalType": "bool"
+        "type": "address",
+        "internalType": "address"
       }
     ],
     "stateMutability": "view"
@@ -774,6 +778,16 @@ var AxonVaultAbi = [
             "type": "uint256",
             "internalType": "uint256"
           },
+          {
+            "name": "fromToken",
+            "type": "address",
+            "internalType": "address"
+          },
+          {
+            "name": "maxFromAmount",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
           {
             "name": "deadline",
             "type": "uint256",
@@ -791,16 +805,6 @@ var AxonVaultAbi = [
         "type": "bytes",
         "internalType": "bytes"
       },
-      {
-        "name": "fromToken",
-        "type": "address",
-        "internalType": "address"
-      },
-      {
-        "name": "maxFromAmount",
-        "type": "uint256",
-        "internalType": "uint256"
-      },
       {
         "name": "swapRouter",
         "type": "address",
@@ -1032,6 +1036,19 @@ var AxonVaultAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "maxSwapSlippageBps",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "onERC1155BatchReceived",
@@ -1203,6 +1220,30 @@ var AxonVaultAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "oracleUsdValue",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "owner",
@@ -1249,6 +1290,55 @@ var AxonVaultAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "previewSwapSlippage",
+    "inputs": [
+      {
+        "name": "fromToken",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "fromAmount",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "toToken",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "toAmount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "wouldPass",
+        "type": "bool",
+        "internalType": "bool"
+      },
+      {
+        "name": "fromUsd",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "toUsd",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "minToUsd",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "rebalanceTokenCount",
@@ -1384,6 +1474,19 @@ var AxonVaultAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "setMaxSwapSlippageBps",
+    "inputs": [
+      {
+        "name": "bps",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setOperator",
@@ -1897,6 +2000,19 @@ var AxonVaultAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "MaxSwapSlippageBpsSet",
+    "inputs": [
+      {
+        "name": "bps",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "OperatorCeilingsUpdated",
@@ -1956,6 +2072,31 @@ var AxonVaultAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "OracleCheckSkipped",
+    "inputs": [
+      {
+        "name": "fromToken",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "toToken",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "reason",
+        "type": "string",
+        "indexed": false,
+        "internalType": "string"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "OwnershipTransferStarted",
@@ -2480,6 +2621,11 @@ var AxonVaultAbi = [
     "name": "SwapOutputInsufficient",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "SwapSlippageTooHigh",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "TooManySpendingLimits",
@@ -2716,6 +2862,19 @@ var AxonVaultFactoryAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "vaultVersion",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint16",
+        "internalType": "uint16"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "event",
     "name": "OwnershipTransferStarted",
@@ -3153,7 +3312,9 @@ function toBotConfigParams(input) {
   for (const sl of input.spendingLimits) {
     if (!ALLOWED_WINDOWS.has(BigInt(sl.windowSeconds))) {
       const allowed = [...ALLOWED_WINDOWS].map((w) => `${Number(w)}s`).join(", ");
-      throw new Error(`Invalid spending window: ${sl.windowSeconds}s. Allowed values: ${allowed}. Use WINDOW constants.`);
+      throw new Error(
+        `Invalid spending window: ${sl.windowSeconds}s. Allowed values: ${allowed}. Use WINDOW constants.`
+      );
     }
   }
   return {
@@ -3339,6 +3500,23 @@ async function isRebalanceTokenWhitelisted(publicClient, vaultAddress, token) {
     args: [token]
   });
 }
+async function getMaxSwapSlippageBps(publicClient, vaultAddress) {
+  return publicClient.readContract({
+    address: vaultAddress,
+    abi: AxonVaultAbi,
+    functionName: "maxSwapSlippageBps"
+  });
+}
+async function previewSwapSlippage(publicClient, vaultAddress, fromToken, fromAmount, toToken, toAmount) {
+  const result = await publicClient.readContract({
+    address: vaultAddress,
+    abi: AxonVaultAbi,
+    functionName: "previewSwapSlippage",
+    args: [fromToken, fromAmount, toToken, toAmount]
+  });
+  const [wouldPass, fromUsd, toUsd, minToUsd] = result;
+  return { wouldPass, fromUsd, toUsd, minToUsd };
+}
 async function deployVault(walletClient, publicClient, relayerUrl) {
   if (!walletClient.account) {
     throw new Error("walletClient has no account attached");
@@ -3895,12 +4073,19 @@ var AxonClient = class {
     const signature = await signPayment(this.walletClient, this.vaultAddress, this.chainId, intent);
     const result = await this._submitPayment(intent, signature, input);
     if (result.status === "rejected" && result.errorCode === "SWAP_REQUIRED") {
+      if (!input.swapFromToken || !input.swapMaxFromAmount) {
+        throw new Error(
+          "Vault lacks the payment token (SWAP_REQUIRED). Provide swapFromToken and swapMaxFromAmount in PayInput to enable auto-swap."
+        );
+      }
       const swapIntent = {
         bot: this.botAddress,
         toToken: intent.token,
         // swap TO the payment token
         minToAmount: intent.amount,
         // need at least the payment amount
+        fromToken: resolveToken(input.swapFromToken, this.chainId),
+        maxFromAmount: parseAmount(input.swapMaxFromAmount, input.swapFromToken, this.chainId),
         deadline: intent.deadline,
         // same deadline
         ref: intent.ref
@@ -4183,6 +4368,8 @@ Timestamp: ${timestamp}`;
       bot: this.botAddress,
       toToken: resolveToken(input.toToken, this.chainId),
       minToAmount: parseAmount(input.minToAmount, input.toToken, this.chainId),
+      fromToken: resolveToken(input.fromToken, this.chainId),
+      maxFromAmount: parseAmount(input.maxFromAmount, input.fromToken, this.chainId),
       deadline: input.deadline ?? this._defaultDeadline(),
       ref: this._resolveRef(input.memo, input.ref)
     };
@@ -4201,10 +4388,12 @@ Timestamp: ${timestamp}`;
       deadline: intent.deadline.toString(),
       ref: intent.ref,
       signature,
-      // Swap fields
+      // Swap fields (all bot-signed)
       swapSignature,
       swapToToken: swapIntent.toToken,
       swapMinToAmount: swapIntent.minToAmount.toString(),
+      swapFromToken: swapIntent.fromToken,
+      swapMaxFromAmount: swapIntent.maxFromAmount.toString(),
       swapDeadline: swapIntent.deadline.toString(),
       swapRef: swapIntent.ref,
       // Off-chain metadata
@@ -4272,21 +4461,18 @@ Timestamp: ${timestamp}`;
   }
   async _submitSwap(intent, signature, input) {
     const idempotencyKey = input.idempotencyKey ?? generateUuid();
-    const fromToken = input.fromToken !== void 0 ? resolveToken(input.fromToken, this.chainId) : void 0;
-    const maxFromAmount = input.maxFromAmount !== void 0 ? parseAmount(input.maxFromAmount, input.fromToken ?? input.toToken, this.chainId) : void 0;
     const body = {
       chainId: this.chainId,
       vaultAddress: this.vaultAddress,
-      // Flat intent fields
+      // Flat intent fields (all bot-signed)
       bot: intent.bot,
       toToken: intent.toToken,
       minToAmount: intent.minToAmount.toString(),
+      fromToken: intent.fromToken,
+      maxFromAmount: intent.maxFromAmount.toString(),
       deadline: intent.deadline.toString(),
       ref: intent.ref,
       signature,
-      // Optional source token
-      ...fromToken !== void 0 && { fromToken },
-      ...maxFromAmount !== void 0 && { maxFromAmount: maxFromAmount.toString() },
       // Off-chain metadata
       idempotencyKey,
       ...input.memo !== void 0 && { memo: input.memo }
@@ -4995,6 +5181,7 @@ exports.getChain = getChain;
 exports.getDefaultApprovedTokens = getDefaultApprovedTokens;
 exports.getDomainSeparator = getDomainSeparator;
 exports.getKnownTokensForChain = getKnownTokensForChain;
+exports.getMaxSwapSlippageBps = getMaxSwapSlippageBps;
 exports.getOperatorCeilings = getOperatorCeilings;
 exports.getRebalanceTokenCount = getRebalanceTokenCount;
 exports.getTokenSymbolByAddress = getTokenSymbolByAddress;
@@ -5011,6 +5198,7 @@ exports.parseAmount = parseAmount;
 exports.parseChainId = parseChainId;
 exports.parsePaymentRequired = parsePaymentRequired;
 exports.predictVaultAddress = predictVaultAddress;
+exports.previewSwapSlippage = previewSwapSlippage;
 exports.randomNonce = randomNonce;
 exports.randomPermit2Nonce = randomPermit2Nonce;
 exports.removeBot = removeBot;