@axonfi/sdk 0.3.0 → 0.3.1

package/README.md

@@ -93,8 +93,9 @@ token: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'; // raw address
 
 ### Payments
 
+Send USDC (or any ERC-20) to any address. The bot signs an EIP-712 intent — Axon verifies it against your vault's spending policies, simulates the transaction, and executes on-chain. If the payment exceeds the AI threshold, it goes through 3-agent verification before execution.
+
 ```typescript
-// Send a payment
 const result = await axon.pay({
   to: '0xRecipient',
   token: 'USDC', // or Token.USDC, or an address
@@ -102,12 +103,14 @@ const result = await axon.pay({
   memo: 'Invoice #42',
 });
 
-// Poll async payments
+// Poll async payments (AI scan or human review)
 const status = await axon.poll(result.requestId);
 ```
 
 ### In-Vault Swaps
 
+Rebalance tokens inside your vault without withdrawing. Swap between any tokens on the vault's rebalance whitelist (set by the owner). Restricted by a separate `maxRebalanceAmount` cap — independent from payment limits.
+
 ```typescript
 const result = await axon.swap({
   toToken: 'WETH',
@@ -118,6 +121,8 @@ const result = await axon.swap({
 
 ### DeFi Protocol Execution
 
+Interact with any on-chain protocol (Uniswap, Aave, GMX, etc.) directly 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.
+
 ```typescript
 const result = await axon.execute({
   protocol: '0xUniswapRouter',
@@ -129,8 +134,10 @@ const result = await axon.execute({
 
 ### 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).
+
 ```typescript
-await axon.getBalance('0xUSDC...'); // vault token balance
+await axon.getBalance('USDC'); // vault token balance
 await axon.isActive(); // bot registered + active?
 await axon.isPaused(); // vault paused?
 await axon.getVaultInfo(); // owner, operator, version
@@ -139,6 +146,8 @@ await axon.canPayTo('0xRecipient'); // destination allowed?
 
 ### Utilities
 
+Helper functions for amount conversion, token resolution, and reference encoding.
+
 ```typescript
 import { parseAmount, resolveTokenDecimals, resolveToken, encodeRef } from '@axonfi/sdk';
 

package/dist/index.cjs

@@ -3063,7 +3063,7 @@ var AxonClient = class {
   constructor(config) {
     this.vaultAddress = config.vaultAddress;
     this.chainId = config.chainId;
-    this.relayerUrl = (config.relayerUrl ?? "https://relay.axonfi.xyz").replace(/\/$/, "");
+    this.relayerUrl = "https://relay.axonfi.xyz";
     if (!config.botPrivateKey) {
       throw new Error("botPrivateKey is required in AxonClientConfig");
     }