@cfxdevkit/defi-react 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,377 @@
+import { Address } from 'viem';
+
+/**
+ * AutomationManager contract ABI (subset) and helpers.
+ *
+ * The full artifact lives at:
+ *   contracts/artifacts/contracts/AutomationManager.sol/AutomationManager.json
+ *
+ * We only include the fragments needed by the frontend:
+ *   - createLimitOrder
+ *   - createDCAJob
+ *   - JobCreated event
+ */
+
+declare const AUTOMATION_MANAGER_ADDRESS: Address;
+declare const ERC20_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "approve";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+}];
+declare const WCFX_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "balanceOf";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "approve";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "deposit";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "withdraw";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "wad";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [];
+}];
+/** Max uint256 — used as an unlimited approval amount for DCA jobs. */
+declare const MAX_UINT256: bigint;
+declare const AUTOMATION_MANAGER_ABI: readonly [{
+    readonly type: "error";
+    readonly name: "DCACompleted";
+    readonly inputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "DCAIntervalNotReached";
+    readonly inputs: readonly [{
+        readonly name: "nextExecution";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "EnforcedPause";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ExpectedPause";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidParams";
+    readonly inputs: readonly [{
+        readonly name: "reason";
+        readonly type: "string";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "JobExpiredError";
+    readonly inputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "JobNotActive";
+    readonly inputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "JobNotFound";
+    readonly inputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "OwnableInvalidOwner";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "OwnableUnauthorizedAccount";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "PriceConditionNotMet";
+    readonly inputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "ReentrancyGuardReentrantCall";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "SafeERC20FailedOperation";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "SlippageTooHigh";
+    readonly inputs: readonly [{
+        readonly name: "requested";
+        readonly type: "uint256";
+    }, {
+        readonly name: "maxAllowed";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "TooManyJobs";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "Unauthorized";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ZeroAddress";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "event";
+    readonly name: "JobCreated";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "jobType";
+        readonly type: "uint8";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "createLimitOrder";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "params";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "tokenIn";
+            readonly type: "address";
+        }, {
+            readonly name: "tokenOut";
+            readonly type: "address";
+        }, {
+            readonly name: "amountIn";
+            readonly type: "uint256";
+        }, {
+            readonly name: "minAmountOut";
+            readonly type: "uint256";
+        }, {
+            readonly name: "targetPrice";
+            readonly type: "uint256";
+        }, {
+            readonly name: "triggerAbove";
+            readonly type: "bool";
+        }];
+    }, {
+        readonly name: "slippageBps";
+        readonly type: "uint256";
+    }, {
+        readonly name: "expiresAt";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "createDCAJob";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "params";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "tokenIn";
+            readonly type: "address";
+        }, {
+            readonly name: "tokenOut";
+            readonly type: "address";
+        }, {
+            readonly name: "amountPerSwap";
+            readonly type: "uint256";
+        }, {
+            readonly name: "intervalSeconds";
+            readonly type: "uint256";
+        }, {
+            readonly name: "totalSwaps";
+            readonly type: "uint256";
+        }, {
+            readonly name: "swapsCompleted";
+            readonly type: "uint256";
+        }, {
+            readonly name: "nextExecution";
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly name: "slippageBps";
+        readonly type: "uint256";
+    }, {
+        readonly name: "expiresAt";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "cancelJob";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "event";
+    readonly name: "JobCancelled";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "jobId";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: true;
+        readonly name: "canceller";
+        readonly type: "address";
+    }];
+}];
+
+interface TokenWithBalance {
+    address: string;
+    symbol: string;
+    name: string;
+    /**
+     * Token decimals — `null` when GeckoTerminal did not publish them.
+     * Consumers that need an accurate value for `parseUnits` / `formatUnits`
+     * should fall back to an on-chain `decimals()` read when this is null.
+     * Display-only callers can safely fall back to 18.
+     */
+    decimals: number | null;
+    /** Token logo image URL (from GeckoTerminal), if available */
+    logoURI?: string;
+    /** Raw wei balance as string, '0' if no wallet connected */
+    balanceWei: string;
+    /** Human-readable balance, e.g. '123.45' */
+    balanceFormatted: string;
+}
+interface PairInfo {
+    address: string;
+    token0: string;
+    token1: string;
+}
+interface UsePoolTokensResult {
+    tokens: TokenWithBalance[];
+    pairs: PairInfo[];
+    /** True only on first-ever load when there is no cached metadata yet. */
+    loading: boolean;
+    /** True while on-chain balances are being fetched (background enrichment). */
+    balancesLoading: boolean;
+    error: string | null;
+    /** Non-null when balance RPC calls partially or fully failed (quota/node issue). */
+    rpcWarning: string | null;
+    refresh: () => void;
+}
+declare const CFX_NATIVE_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+declare function wcfxAddress(network?: string): string;
+declare function resolveTokenInAddress(address: string): string;
+/**
+ * Returns tokens that are paired with tokenInAddress.
+ * All address comparisons are case-insensitive.
+ */
+declare function getPairedTokens(pairs: PairInfo[], allTokens: TokenWithBalance[], tokenInAddress: string): TokenWithBalance[];
+declare function usePoolTokens(userAddress: string | undefined): UsePoolTokensResult;
+
+export { AUTOMATION_MANAGER_ABI, AUTOMATION_MANAGER_ADDRESS, CFX_NATIVE_ADDRESS, ERC20_ABI, MAX_UINT256, type PairInfo, type TokenWithBalance, type UsePoolTokensResult, WCFX_ABI, getPairedTokens, resolveTokenInAddress, usePoolTokens, wcfxAddress };