@axonfi/sdk 0.2.0 → 0.2.2

package/README.md

@@ -1,12 +1,16 @@
 # @axonfi/sdk
 
+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.
 
-## Why Axon
+## Why Axon Finance
 
 Giving bots funded wallets is risky: scattered keys, no spending controls, one compromised key drains everything. Axon flips this model:
 
-- **Non-custodial vaults** — each Principal deploys their own vault. Only the owner can withdraw. Enforced on-chain.
+- **Non-custodial vaults** — each owner deploys their own vault. Only the owner can withdraw. Enforced on-chain.
 - **Bounded risk** — per-tx caps, daily limits, velocity windows, destination whitelists. Bots can only operate within the policies you set.
 - **AI verification** — 3-agent LLM consensus (safety, behavioral, reasoning) for flagged transactions. 2/3 consensus required.
 - **Gasless bots** — bots sign EIP-712 intents off-chain. Axon's relayer handles gas, simulation, and on-chain execution.
@@ -17,7 +21,7 @@ Your agents pay. You stay in control.
 ## Install
 
 ```bash
-npm install @axonfi/sdk viem
+npm install @axonfi/sdk
 ```
 
 ## Quick Start
@@ -27,7 +31,7 @@ import { AxonClient } from '@axonfi/sdk';
 
 const axon = new AxonClient({
   vaultAddress: '0x...',
-  chainId: 8453,                         // Base
+  chainId: 8453, // Base
   botPrivateKey: '0x...',
   relayerUrl: 'https://relay.axonfi.xyz',
 });
@@ -63,9 +67,9 @@ Token field accepts addresses, `Token` enum values, or symbol strings:
 ```typescript
 import { Token, USDC } from '@axonfi/sdk';
 
-token: 'USDC'                                    // bare symbol string
-token: Token.USDC                                // type-safe enum
-token: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'  // raw address
+token: 'USDC'; // bare symbol string
+token: Token.USDC; // type-safe enum
+token: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913'; // raw address
 ```
 
 ### Encrypted Bot Keys
@@ -93,8 +97,8 @@ const axon = new AxonClient({
 // Send a payment
 const result = await axon.pay({
   to: '0xRecipient',
-  token: 'USDC',           // or Token.USDC, or an address
-  amount: 25,              // or '25', or 25_000_000n
+  token: 'USDC', // or Token.USDC, or an address
+  amount: 25, // or '25', or 25_000_000n
   memo: 'Invoice #42',
 });
 
@@ -126,11 +130,11 @@ const result = await axon.execute({
 ### Vault Reads
 
 ```typescript
-await axon.getBalance('0xUSDC...');       // vault token balance
-await axon.isActive();                     // bot registered + active?
-await axon.isPaused();                     // vault paused?
-await axon.getVaultInfo();                 // owner, operator, version
-await axon.canPayTo('0xRecipient');        // destination allowed?
+await axon.getBalance('0xUSDC...'); // vault token balance
+await axon.isActive(); // bot registered + active?
+await axon.isPaused(); // vault paused?
+await axon.getVaultInfo(); // owner, operator, version
+await axon.canPayTo('0xRecipient'); // destination allowed?
 ```
 
 ### Utilities
@@ -138,37 +142,37 @@ await axon.canPayTo('0xRecipient');        // destination allowed?
 ```typescript
 import { parseAmount, resolveTokenDecimals, resolveToken, encodeRef } from '@axonfi/sdk';
 
-parseAmount(5.2, 'USDC');                 // 5_200_000n
-resolveTokenDecimals('WETH');             // 18
-resolveToken('USDC', 8453);              // 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
-encodeRef('invoice-042');                 // keccak256 → bytes32
+parseAmount(5.2, 'USDC'); // 5_200_000n
+resolveTokenDecimals('WETH'); // 18
+resolveToken('USDC', 8453); // 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
+encodeRef('invoice-042'); // keccak256 → bytes32
 ```
 
 ## Response Paths
 
 Payments resolve through one of three paths:
 
-| Path | Trigger | Timing | Response |
-|------|---------|--------|----------|
-| **Fast** | Below all thresholds | ~2s | `status: "approved"`, `txHash` |
-| **AI Scan** | Exceeds AI threshold | ~30s | `status: "approved"` or routes to review |
-| **Human Review** | No AI consensus | Async | `status: "pending_review"`, poll for result |
+| Path             | Trigger              | Timing | Response                                    |
+| ---------------- | -------------------- | ------ | ------------------------------------------- |
+| **Fast**         | Below all thresholds | ~2s    | `status: "approved"`, `txHash`              |
+| **AI Scan**      | Exceeds AI threshold | ~30s   | `status: "approved"` or routes to review    |
+| **Human Review** | No AI consensus      | Async  | `status: "pending_review"`, poll for result |
 
 ## Security Model
 
-- **Principals** (vault owners) control everything: bot whitelist, spending limits, withdrawal. Hardware wallet recommended.
+- **Owners** control everything: bot whitelist, spending limits, withdrawal. Hardware wallet recommended.
 - **Bots** only sign payment intents. They never hold ETH, never submit transactions, and can be removed instantly.
 - **Relayer** (Axon) can only execute bot-signed intents within configured limits. Cannot withdraw or modify vault config.
-- **If Axon goes offline**, the Principal retains full withdrawal access directly through the on-chain vault contract.
+- **If Axon goes offline**, the owner retains full withdrawal access directly through the on-chain vault contract.
 
 ## Chains
 
-| Chain | ID | Status |
-|-------|----|--------|
-| Base | 8453 | Live |
-| Arbitrum One | 42161 | Live |
-| Optimism | 10 | Live |
-| Polygon PoS | 137 | Live |
+| Chain        | ID    | Status  |
+| ------------ | ----- | ------- |
+| Base         | 8453  | Live    |
+| Arbitrum One | 42161 | Live    |
+| Optimism     | 10    | Live    |
+| Polygon PoS  | 137   | Live    |
 | Base Sepolia | 84532 | Testnet |
 
 ## Documentation