@axonfi/sdk 0.5.0 → 0.5.2

package/dist/index.d.cts

@@ -382,7 +382,7 @@ interface BotConfig {
     /** Relayer always requires AI scan for this bot regardless of amount. */
     requireAiVerification: boolean;
 }
-/** Parameters for addBot / updateBotConfig. */
+/** Parameters for addBot / updateBotConfig (raw on-chain format). */
 interface BotConfigParams {
     maxPerTxAmount: bigint;
     /** Hard cap for rebalancing (executeSwap) input amount in USD. 0 = no cap (default). */
@@ -391,6 +391,33 @@ interface BotConfigParams {
     aiTriggerThreshold: bigint;
     requireAiVerification: boolean;
 }
+/** Human-friendly spending limit input. SDK converts dollar amounts to 6-decimal base units. */
+interface SpendingLimitInput {
+    /** Max spend in this window in USD (e.g. 1000 = $1,000). */
+    amount: number;
+    /** Max transactions in this window. 0 = no count limit. */
+    maxCount: number;
+    /** Window size in seconds: 3600=1h, 86400=1d, 604800=1w. Use WINDOW constants. */
+    windowSeconds: number;
+}
+/**
+ * Human-friendly bot config input for addBot / updateBotConfig.
+ *
+ * Dollar amounts are plain numbers (e.g. 100 = $100). The SDK converts
+ * to 6-decimal base units (USDC precision) before sending to the contract.
+ */
+interface BotConfigInput {
+    /** Hard per-tx cap in USD (e.g. 100 = $100). 0 = no cap. */
+    maxPerTxAmount: number;
+    /** Hard rebalance cap in USD (e.g. 50 = $50). 0 = no cap. */
+    maxRebalanceAmount: number;
+    /** Rolling window spending limits. Up to 5. */
+    spendingLimits: SpendingLimitInput[];
+    /** AI scan trigger threshold in USD (e.g. 50 = $50). 0 = never by amount. */
+    aiTriggerThreshold: number;
+    /** Always require AI scan regardless of amount. */
+    requireAiVerification: boolean;
+}
 /** Owner-set ceilings bounding operator actions. */
 interface OperatorCeilings {
     /** Operator cannot set a bot's maxPerTxAmount above this. 0 = no ceiling. */
@@ -963,6 +990,8 @@ declare function getChain(chainId: number): Chain$1;
 declare function createAxonPublicClient(chainId: number, rpcUrl: string): PublicClient;
 /** Create a viem WalletClient from a raw private key (signing-only, no RPC needed). */
 declare function createAxonWalletClient(privateKey: Hex, chainId: number): WalletClient;
+/** Convert human-friendly BotConfigInput (dollar amounts) to on-chain BotConfigParams (6-decimal bigints). */
+declare function toBotConfigParams(input: BotConfigInput): BotConfigParams;
 /**
  * Returns the full BotConfig for a bot address from the vault.
  * If the bot has never been added, isActive will be false and all
@@ -1009,11 +1038,14 @@ declare function isRebalanceTokenWhitelisted(publicClient: PublicClient, vaultAd
  * The vault is owned by the walletClient's account. Permissionless — any
  * address can deploy, no Axon approval required.
  *
+ * The factory address is fetched automatically from the Axon relayer.
+ *
  * @param walletClient      Wallet that will own the deployed vault.
- * @param factoryAddress    Address of the deployed AxonVaultFactory.
+ * @param publicClient      Public client for the vault's chain.
+ * @param relayerUrl        Override relayer URL (defaults to https://relay.axonfi.xyz).
  * @returns                 Address of the newly deployed vault.
  */
-declare function deployVault(walletClient: WalletClient, publicClient: PublicClient, factoryAddress: Address): Promise<Address>;
+declare function deployVault(walletClient: WalletClient, publicClient: PublicClient, relayerUrl?: string): Promise<Address>;
 /**
  * Register a bot on the vault with its initial spending configuration.
  *
@@ -1024,10 +1056,10 @@ declare function deployVault(walletClient: WalletClient, publicClient: PublicCli
  * @param publicClient    Public client for the vault's chain.
  * @param vaultAddress    Vault to register the bot on.
  * @param botAddress      Public address of the bot to register.
- * @param config          Bot spending configuration (limits, AI threshold, etc.).
+ * @param config          Bot spending configuration — human-readable USD amounts (e.g. 100 = $100).
  * @returns               Transaction hash.
  */
-declare function addBot(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigParams): Promise<Hex>;
+declare function addBot(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigInput): Promise<Hex>;
 /**
  * Update an existing bot's spending configuration.
  *
@@ -1038,10 +1070,10 @@ declare function addBot(walletClient: WalletClient, publicClient: PublicClient,
  * @param publicClient    Public client for the vault's chain.
  * @param vaultAddress    Vault the bot is registered on.
  * @param botAddress      Bot to update.
- * @param config          New spending configuration.
+ * @param config          New spending configuration — human-readable USD amounts.
  * @returns               Transaction hash.
  */
-declare function updateBotConfig(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigParams): Promise<Hex>;
+declare function updateBotConfig(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigInput): Promise<Hex>;
 /**
  * Remove a bot from the vault whitelist.
  *
@@ -1068,12 +1100,12 @@ declare function removeBot(walletClient: WalletClient, publicClient: PublicClien
  * @param walletClient    Wallet sending the deposit (anyone, not just owner).
  * @param publicClient    Public client for the vault's chain.
  * @param vaultAddress    Vault to deposit into.
- * @param token           Token address, or NATIVE_ETH for ETH deposits.
+ * @param token           Token symbol ('USDC', 'WETH'), Token enum, raw address, or NATIVE_ETH / 'ETH' for ETH deposits.
  * @param amount          Amount in base units (e.g. 5_000_000n for 5 USDC, 10n**16n for 0.01 ETH).
  * @param ref             Optional bytes32 reference linking to an off-chain record. Defaults to 0x0.
  * @returns               Transaction hash of the deposit.
  */
-declare function deposit(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, token: Address, amount: bigint, ref?: Hex): Promise<Hex>;
+declare function deposit(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, token: Address | string, amount: bigint, ref?: Hex): Promise<Hex>;
 
 interface KeystoreV3 {
     version: 3;
@@ -3398,4 +3430,4 @@ declare const AxonRegistryAbi: readonly [{
     readonly inputs: readonly [];
 }];
 
-export { type AmountInput, AxonClient, type AxonClientConfig, AxonRegistryAbi, AxonVaultAbi, AxonVaultFactoryAbi, type BotConfig, type BotConfigParams, CHAIN_NAMES, Chain, DEFAULT_APPROVED_TOKENS, DEFAULT_DEADLINE_SECONDS, type DestinationCheckResult, EIP712_DOMAIN_NAME, EIP712_DOMAIN_VERSION, EXECUTE_INTENT_TYPEHASH, EXPLORER_ADDR, EXPLORER_TX, type ExecuteInput, type ExecuteIntent, KNOWN_TOKENS, type KeystoreV3, type KnownToken, type KnownTokenSymbol, NATIVE_ETH, type OperatorCeilings, PAYMENT_INTENT_TYPEHASH, PERMIT2_ADDRESS, type PayInput, PaymentErrorCode, type PaymentIntent, type PaymentResult, type PaymentStatus, type Permit2Authorization, RELAYER_API, type RebalanceTokensResult, SUPPORTED_CHAIN_IDS, SWAP_INTENT_TYPEHASH, type SpendingLimit, type SupportedChainId, type SwapInput, type SwapIntent, Token, type TokenInput, type TosStatus, type TransferAuthorization, USDC, USDC_EIP712_DOMAIN, type VaultInfo, WINDOW, WITNESS_TYPE_STRING, type X402HandleResult, type X402PaymentOption, type X402PaymentRequired, type X402Resource, X402_PROXY_ADDRESS, addBot, createAxonPublicClient, createAxonWalletClient, decryptKeystore, deployVault, deposit, encodeRef, encryptKeystore, extractX402Metadata, findMatchingOption, formatPaymentSignature, getBotConfig, getChain, getDefaultApprovedTokens, getDomainSeparator, getKnownTokensForChain, getOperatorCeilings, getRebalanceTokenCount, getTokenSymbolByAddress, getVaultOperator, getVaultOwner, getVaultVersion, isBotActive, isDestinationAllowed, isRebalanceTokenWhitelisted, isVaultPaused, operatorMaxDrainPerDay, parseAmount, parseChainId, parsePaymentRequired, randomNonce, randomPermit2Nonce, removeBot, resolveToken, resolveTokenDecimals, signExecuteIntent, signPayment, signPermit2WitnessTransfer, signSwapIntent, signTransferWithAuthorization, updateBotConfig };
+export { type AmountInput, AxonClient, type AxonClientConfig, AxonRegistryAbi, AxonVaultAbi, AxonVaultFactoryAbi, type BotConfig, type BotConfigInput, type BotConfigParams, CHAIN_NAMES, Chain, DEFAULT_APPROVED_TOKENS, DEFAULT_DEADLINE_SECONDS, type DestinationCheckResult, EIP712_DOMAIN_NAME, EIP712_DOMAIN_VERSION, EXECUTE_INTENT_TYPEHASH, EXPLORER_ADDR, EXPLORER_TX, type ExecuteInput, type ExecuteIntent, KNOWN_TOKENS, type KeystoreV3, type KnownToken, type KnownTokenSymbol, NATIVE_ETH, type OperatorCeilings, PAYMENT_INTENT_TYPEHASH, PERMIT2_ADDRESS, type PayInput, PaymentErrorCode, type PaymentIntent, type PaymentResult, type PaymentStatus, type Permit2Authorization, RELAYER_API, type RebalanceTokensResult, SUPPORTED_CHAIN_IDS, SWAP_INTENT_TYPEHASH, type SpendingLimit, type SpendingLimitInput, type SupportedChainId, type SwapInput, type SwapIntent, Token, type TokenInput, type TosStatus, type TransferAuthorization, USDC, USDC_EIP712_DOMAIN, type VaultInfo, WINDOW, WITNESS_TYPE_STRING, type X402HandleResult, type X402PaymentOption, type X402PaymentRequired, type X402Resource, X402_PROXY_ADDRESS, addBot, createAxonPublicClient, createAxonWalletClient, decryptKeystore, deployVault, deposit, encodeRef, encryptKeystore, extractX402Metadata, findMatchingOption, formatPaymentSignature, getBotConfig, getChain, getDefaultApprovedTokens, getDomainSeparator, getKnownTokensForChain, getOperatorCeilings, getRebalanceTokenCount, getTokenSymbolByAddress, getVaultOperator, getVaultOwner, getVaultVersion, isBotActive, isDestinationAllowed, isRebalanceTokenWhitelisted, isVaultPaused, operatorMaxDrainPerDay, parseAmount, parseChainId, parsePaymentRequired, randomNonce, randomPermit2Nonce, removeBot, resolveToken, resolveTokenDecimals, signExecuteIntent, signPayment, signPermit2WitnessTransfer, signSwapIntent, signTransferWithAuthorization, toBotConfigParams, updateBotConfig };

package/dist/index.d.ts

@@ -382,7 +382,7 @@ interface BotConfig {
     /** Relayer always requires AI scan for this bot regardless of amount. */
     requireAiVerification: boolean;
 }
-/** Parameters for addBot / updateBotConfig. */
+/** Parameters for addBot / updateBotConfig (raw on-chain format). */
 interface BotConfigParams {
     maxPerTxAmount: bigint;
     /** Hard cap for rebalancing (executeSwap) input amount in USD. 0 = no cap (default). */
@@ -391,6 +391,33 @@ interface BotConfigParams {
     aiTriggerThreshold: bigint;
     requireAiVerification: boolean;
 }
+/** Human-friendly spending limit input. SDK converts dollar amounts to 6-decimal base units. */
+interface SpendingLimitInput {
+    /** Max spend in this window in USD (e.g. 1000 = $1,000). */
+    amount: number;
+    /** Max transactions in this window. 0 = no count limit. */
+    maxCount: number;
+    /** Window size in seconds: 3600=1h, 86400=1d, 604800=1w. Use WINDOW constants. */
+    windowSeconds: number;
+}
+/**
+ * Human-friendly bot config input for addBot / updateBotConfig.
+ *
+ * Dollar amounts are plain numbers (e.g. 100 = $100). The SDK converts
+ * to 6-decimal base units (USDC precision) before sending to the contract.
+ */
+interface BotConfigInput {
+    /** Hard per-tx cap in USD (e.g. 100 = $100). 0 = no cap. */
+    maxPerTxAmount: number;
+    /** Hard rebalance cap in USD (e.g. 50 = $50). 0 = no cap. */
+    maxRebalanceAmount: number;
+    /** Rolling window spending limits. Up to 5. */
+    spendingLimits: SpendingLimitInput[];
+    /** AI scan trigger threshold in USD (e.g. 50 = $50). 0 = never by amount. */
+    aiTriggerThreshold: number;
+    /** Always require AI scan regardless of amount. */
+    requireAiVerification: boolean;
+}
 /** Owner-set ceilings bounding operator actions. */
 interface OperatorCeilings {
     /** Operator cannot set a bot's maxPerTxAmount above this. 0 = no ceiling. */
@@ -963,6 +990,8 @@ declare function getChain(chainId: number): Chain$1;
 declare function createAxonPublicClient(chainId: number, rpcUrl: string): PublicClient;
 /** Create a viem WalletClient from a raw private key (signing-only, no RPC needed). */
 declare function createAxonWalletClient(privateKey: Hex, chainId: number): WalletClient;
+/** Convert human-friendly BotConfigInput (dollar amounts) to on-chain BotConfigParams (6-decimal bigints). */
+declare function toBotConfigParams(input: BotConfigInput): BotConfigParams;
 /**
  * Returns the full BotConfig for a bot address from the vault.
  * If the bot has never been added, isActive will be false and all
@@ -1009,11 +1038,14 @@ declare function isRebalanceTokenWhitelisted(publicClient: PublicClient, vaultAd
  * The vault is owned by the walletClient's account. Permissionless — any
  * address can deploy, no Axon approval required.
  *
+ * The factory address is fetched automatically from the Axon relayer.
+ *
  * @param walletClient      Wallet that will own the deployed vault.
- * @param factoryAddress    Address of the deployed AxonVaultFactory.
+ * @param publicClient      Public client for the vault's chain.
+ * @param relayerUrl        Override relayer URL (defaults to https://relay.axonfi.xyz).
  * @returns                 Address of the newly deployed vault.
  */
-declare function deployVault(walletClient: WalletClient, publicClient: PublicClient, factoryAddress: Address): Promise<Address>;
+declare function deployVault(walletClient: WalletClient, publicClient: PublicClient, relayerUrl?: string): Promise<Address>;
 /**
  * Register a bot on the vault with its initial spending configuration.
  *
@@ -1024,10 +1056,10 @@ declare function deployVault(walletClient: WalletClient, publicClient: PublicCli
  * @param publicClient    Public client for the vault's chain.
  * @param vaultAddress    Vault to register the bot on.
  * @param botAddress      Public address of the bot to register.
- * @param config          Bot spending configuration (limits, AI threshold, etc.).
+ * @param config          Bot spending configuration — human-readable USD amounts (e.g. 100 = $100).
  * @returns               Transaction hash.
  */
-declare function addBot(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigParams): Promise<Hex>;
+declare function addBot(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigInput): Promise<Hex>;
 /**
  * Update an existing bot's spending configuration.
  *
@@ -1038,10 +1070,10 @@ declare function addBot(walletClient: WalletClient, publicClient: PublicClient,
  * @param publicClient    Public client for the vault's chain.
  * @param vaultAddress    Vault the bot is registered on.
  * @param botAddress      Bot to update.
- * @param config          New spending configuration.
+ * @param config          New spending configuration — human-readable USD amounts.
  * @returns               Transaction hash.
  */
-declare function updateBotConfig(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigParams): Promise<Hex>;
+declare function updateBotConfig(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, botAddress: Address, config: BotConfigInput): Promise<Hex>;
 /**
  * Remove a bot from the vault whitelist.
  *
@@ -1068,12 +1100,12 @@ declare function removeBot(walletClient: WalletClient, publicClient: PublicClien
  * @param walletClient    Wallet sending the deposit (anyone, not just owner).
  * @param publicClient    Public client for the vault's chain.
  * @param vaultAddress    Vault to deposit into.
- * @param token           Token address, or NATIVE_ETH for ETH deposits.
+ * @param token           Token symbol ('USDC', 'WETH'), Token enum, raw address, or NATIVE_ETH / 'ETH' for ETH deposits.
  * @param amount          Amount in base units (e.g. 5_000_000n for 5 USDC, 10n**16n for 0.01 ETH).
  * @param ref             Optional bytes32 reference linking to an off-chain record. Defaults to 0x0.
  * @returns               Transaction hash of the deposit.
  */
-declare function deposit(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, token: Address, amount: bigint, ref?: Hex): Promise<Hex>;
+declare function deposit(walletClient: WalletClient, publicClient: PublicClient, vaultAddress: Address, token: Address | string, amount: bigint, ref?: Hex): Promise<Hex>;
 
 interface KeystoreV3 {
     version: 3;
@@ -3398,4 +3430,4 @@ declare const AxonRegistryAbi: readonly [{
     readonly inputs: readonly [];
 }];
 
-export { type AmountInput, AxonClient, type AxonClientConfig, AxonRegistryAbi, AxonVaultAbi, AxonVaultFactoryAbi, type BotConfig, type BotConfigParams, CHAIN_NAMES, Chain, DEFAULT_APPROVED_TOKENS, DEFAULT_DEADLINE_SECONDS, type DestinationCheckResult, EIP712_DOMAIN_NAME, EIP712_DOMAIN_VERSION, EXECUTE_INTENT_TYPEHASH, EXPLORER_ADDR, EXPLORER_TX, type ExecuteInput, type ExecuteIntent, KNOWN_TOKENS, type KeystoreV3, type KnownToken, type KnownTokenSymbol, NATIVE_ETH, type OperatorCeilings, PAYMENT_INTENT_TYPEHASH, PERMIT2_ADDRESS, type PayInput, PaymentErrorCode, type PaymentIntent, type PaymentResult, type PaymentStatus, type Permit2Authorization, RELAYER_API, type RebalanceTokensResult, SUPPORTED_CHAIN_IDS, SWAP_INTENT_TYPEHASH, type SpendingLimit, type SupportedChainId, type SwapInput, type SwapIntent, Token, type TokenInput, type TosStatus, type TransferAuthorization, USDC, USDC_EIP712_DOMAIN, type VaultInfo, WINDOW, WITNESS_TYPE_STRING, type X402HandleResult, type X402PaymentOption, type X402PaymentRequired, type X402Resource, X402_PROXY_ADDRESS, addBot, createAxonPublicClient, createAxonWalletClient, decryptKeystore, deployVault, deposit, encodeRef, encryptKeystore, extractX402Metadata, findMatchingOption, formatPaymentSignature, getBotConfig, getChain, getDefaultApprovedTokens, getDomainSeparator, getKnownTokensForChain, getOperatorCeilings, getRebalanceTokenCount, getTokenSymbolByAddress, getVaultOperator, getVaultOwner, getVaultVersion, isBotActive, isDestinationAllowed, isRebalanceTokenWhitelisted, isVaultPaused, operatorMaxDrainPerDay, parseAmount, parseChainId, parsePaymentRequired, randomNonce, randomPermit2Nonce, removeBot, resolveToken, resolveTokenDecimals, signExecuteIntent, signPayment, signPermit2WitnessTransfer, signSwapIntent, signTransferWithAuthorization, updateBotConfig };
+export { type AmountInput, AxonClient, type AxonClientConfig, AxonRegistryAbi, AxonVaultAbi, AxonVaultFactoryAbi, type BotConfig, type BotConfigInput, type BotConfigParams, CHAIN_NAMES, Chain, DEFAULT_APPROVED_TOKENS, DEFAULT_DEADLINE_SECONDS, type DestinationCheckResult, EIP712_DOMAIN_NAME, EIP712_DOMAIN_VERSION, EXECUTE_INTENT_TYPEHASH, EXPLORER_ADDR, EXPLORER_TX, type ExecuteInput, type ExecuteIntent, KNOWN_TOKENS, type KeystoreV3, type KnownToken, type KnownTokenSymbol, NATIVE_ETH, type OperatorCeilings, PAYMENT_INTENT_TYPEHASH, PERMIT2_ADDRESS, type PayInput, PaymentErrorCode, type PaymentIntent, type PaymentResult, type PaymentStatus, type Permit2Authorization, RELAYER_API, type RebalanceTokensResult, SUPPORTED_CHAIN_IDS, SWAP_INTENT_TYPEHASH, type SpendingLimit, type SpendingLimitInput, type SupportedChainId, type SwapInput, type SwapIntent, Token, type TokenInput, type TosStatus, type TransferAuthorization, USDC, USDC_EIP712_DOMAIN, type VaultInfo, WINDOW, WITNESS_TYPE_STRING, type X402HandleResult, type X402PaymentOption, type X402PaymentRequired, type X402Resource, X402_PROXY_ADDRESS, addBot, createAxonPublicClient, createAxonWalletClient, decryptKeystore, deployVault, deposit, encodeRef, encryptKeystore, extractX402Metadata, findMatchingOption, formatPaymentSignature, getBotConfig, getChain, getDefaultApprovedTokens, getDomainSeparator, getKnownTokensForChain, getOperatorCeilings, getRebalanceTokenCount, getTokenSymbolByAddress, getVaultOperator, getVaultOwner, getVaultVersion, isBotActive, isDestinationAllowed, isRebalanceTokenWhitelisted, isVaultPaused, operatorMaxDrainPerDay, parseAmount, parseChainId, parsePaymentRequired, randomNonce, randomPermit2Nonce, removeBot, resolveToken, resolveTokenDecimals, signExecuteIntent, signPayment, signPermit2WitnessTransfer, signSwapIntent, signTransferWithAuthorization, toBotConfigParams, updateBotConfig };