@gitmyabi/fxcacheroottunnel 1.0.0

package/README.md

@@ -0,0 +1,108 @@
+# @gitmyabi/fxcacheroottunnel
+
+Auto-generated TypeScript type bindings for **FxCacheRootTunnel**
+
+- **Build ID**: `etherscan-fxcacheroottunnel-309111b4-1789238455579`
+- **Build Number**: 1
+- **Commit**: `d4752a1`
+- **Branch**: `etherscan`
+- **Target**: `ethers-v6`
+- **Contracts**: 1
+
+## Installation
+
+```bash
+npm install @gitmyabi/fxcacheroottunnel@1.0.0
+```
+
+## Usage
+
+### Class-based API (TypeChain-like)
+
+```typescript
+import { createPublicClient, createWalletClient, http } from 'viem';
+import { mainnet } from 'viem/chains';
+import { YourContract } from '@gitmyabi/fxcacheroottunnel';
+
+const publicClient = createPublicClient({ chain: mainnet, transport: http() });
+const walletClient = createWalletClient({ chain: mainnet, transport: http() });
+
+// Create contract instance
+const contract = new YourContract('0x...', { publicClient, walletClient });
+
+// Read functions - call directly like TypeChain!
+const result = await contract.yourMethod(param1, param2);
+
+// Write functions - also call directly!
+const hash = await contract.transfer('0x...', 1000n);
+```
+
+### With viem directly
+
+```typescript
+import { createPublicClient, http } from 'viem';
+import { mainnet } from 'viem/chains';
+import { YourContractAbi } from '@gitmyabi/fxcacheroottunnel';
+
+const client = createPublicClient({
+  chain: mainnet,
+  transport: http(),
+});
+
+// Fully typed contract read
+const result = await client.readContract({
+  address: '0x...',
+  abi: YourContractAbi,
+  functionName: 'yourMethod',
+  args: [param1, param2],
+});
+
+// Fully typed contract write
+const hash = await client.writeContract({
+  address: '0x...',
+  abi: YourContractAbi,
+  functionName: 'yourMethod',
+  args: [param1, param2],
+});
+```
+
+### With wagmi
+
+```typescript
+import { useReadContract, useWriteContract } from 'wagmi';
+import { YourContractAbi } from '@gitmyabi/fxcacheroottunnel';
+
+function MyComponent() {
+  const { data } = useReadContract({
+    address: '0x...',
+    abi: YourContractAbi,
+    functionName: 'yourMethod',
+    args: [param1, param2],
+  });
+
+  const { writeContract } = useWriteContract();
+  
+  const handleWrite = () => {
+    writeContract({
+      address: '0x...',
+      abi: YourContractAbi,
+      functionName: 'yourMethod',
+      args: [param1, param2],
+    });
+  };
+
+  return <button onClick={handleWrite}>Call Contract</button>;
+}
+```
+
+## Type Safety
+
+This package provides full TypeScript type safety for all contract methods, events, and parameters using viem's type system. All ABIs are exported as `const` assertions for maximum type inference.
+
+## Generated Contracts
+
+This package includes type bindings for 1 contract(s) generated from ABI artifacts.
+
+## License
+
+MIT

package/contracts/FxCacheRootTunnel_json.d.ts

@@ -0,0 +1,534 @@
+import type { Address, PublicClient, WalletClient } from 'viem';
+/**
+ * FxCacheRootTunnel_json ABI
+ *
+ * This ABI is typed using viem's type system for full type safety.
+ */
+export declare const FxCacheRootTunnel_jsonAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_checkpointManager";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "_fxRoot";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "rootToken";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "depositor";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "userAddress";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "FxDepositERC20";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "rootToken";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "childToken";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "userAddress";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "FxWithdrawERC20";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "rootToken";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "childToken";
+        readonly type: "address";
+    }];
+    readonly name: "TokenMappedERC20";
+    readonly type: "event";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "DEPOSIT";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MAP_TOKEN";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "SEND_MESSAGE_EVENT_SIG";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "checkpointManager";
+    readonly outputs: readonly [{
+        readonly internalType: "contract ICheckpointManager";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "rootToken";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "childToken";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "user";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "bytes";
+        readonly name: "data";
+        readonly type: "bytes";
+    }];
+    readonly name: "deposit";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "fxChildTunnel";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "fxRoot";
+    readonly outputs: readonly [{
+        readonly internalType: "contract IFxStateSender";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "rootToken";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "_childToken";
+        readonly type: "address";
+    }];
+    readonly name: "mapToken";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly name: "processedExits";
+    readonly outputs: readonly [{
+        readonly internalType: "bool";
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes";
+        readonly name: "inputData";
+        readonly type: "bytes";
+    }];
+    readonly name: "receiveMessage";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly name: "rootToChildTokens";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_fxChildTunnel";
+        readonly type: "address";
+    }];
+    readonly name: "setFxChildTunnel";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+/**
+ * Type-safe ABI for FxCacheRootTunnel_json
+ */
+export type FxCacheRootTunnel_jsonAbi = typeof FxCacheRootTunnel_jsonAbi;
+/**
+ * Contract instance type for FxCacheRootTunnel_json
+ */
+export type FxCacheRootTunnel_jsonContract = any;
+/**
+ * FxCacheRootTunnel_json Contract Class
+ *
+ * Provides a class-based API similar to TypeChain for interacting with the contract.
+ *
+ * @example
+ * ```typescript
+ * import { createPublicClient, createWalletClient, http } from 'viem';
+ * import { mainnet } from 'viem/chains';
+ * import { FxCacheRootTunnel_json } from 'FxCacheRootTunnel_json';
+ *
+ * const publicClient = createPublicClient({ chain: mainnet, transport: http() });
+ * const walletClient = createWalletClient({ chain: mainnet, transport: http() });
+ *
+ * const contract = new FxCacheRootTunnel_json('0x...', { publicClient, walletClient });
+ *
+ * // Read functions
+ * const result = await contract.balanceOf('0x...');
+ *
+ * // Write functions
+ * const hash = await contract.transfer('0x...', 1000n);
+ *
+ * // Simulate transactions (dry-run)
+ * const simulation = await contract.simulate.transfer('0x...', 1000n);
+ * console.log('Gas estimate:', simulation.request.gas);
+ *
+ * // Watch events
+ * const unwatch = contract.watch.Transfer((event) => {
+ *   console.log('Transfer event:', event);
+ * });
+ * ```
+ */
+export declare class FxCacheRootTunnel_json {
+    private contract;
+    private contractAddress;
+    private publicClient;
+    constructor(address: Address, clients: {
+        publicClient: PublicClient;
+        walletClient?: WalletClient;
+    });
+    /**
+     * Get the contract address
+     */
+    get address(): Address;
+    /**
+     * Get the underlying viem contract instance
+     */
+    getContract(): FxCacheRootTunnel_jsonContract;
+    /**
+     * DEPOSIT
+     * view
+     */
+    DEPOSIT(): Promise<`0x${string}`>;
+    /**
+     * MAP_TOKEN
+     * view
+     */
+    MAP_TOKEN(): Promise<`0x${string}`>;
+    /**
+     * SEND_MESSAGE_EVENT_SIG
+     * view
+     */
+    SEND_MESSAGE_EVENT_SIG(): Promise<`0x${string}`>;
+    /**
+     * checkpointManager
+     * view
+     */
+    checkpointManager(): Promise<`0x${string}`>;
+    /**
+     * fxChildTunnel
+     * view
+     */
+    fxChildTunnel(): Promise<`0x${string}`>;
+    /**
+     * fxRoot
+     * view
+     */
+    fxRoot(): Promise<`0x${string}`>;
+    /**
+     * processedExits
+     * view
+     */
+    processedExits(arg0: `0x${string}`): Promise<boolean>;
+    /**
+     * rootToChildTokens
+     * view
+     */
+    rootToChildTokens(arg0: `0x${string}`): Promise<`0x${string}`>;
+    /**
+     * deposit
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    deposit(rootToken: `0x${string}`, childToken: `0x${string}`, user: `0x${string}`, amount: bigint, data: `0x${string}`, options?: {
+        accessList?: import('viem').AccessList;
+        authorizationList?: import('viem').AuthorizationList;
+        chain?: import('viem').Chain | null;
+        dataSuffix?: `0x${string}`;
+        gas?: bigint;
+        gasPrice?: bigint;
+        maxFeePerGas?: bigint;
+        maxPriorityFeePerGas?: bigint;
+        nonce?: number;
+        value?: bigint;
+    }): Promise<`0x${string}`>;
+    /**
+     * mapToken
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    mapToken(rootToken: `0x${string}`, _childToken: `0x${string}`, options?: {
+        accessList?: import('viem').AccessList;
+        authorizationList?: import('viem').AuthorizationList;
+        chain?: import('viem').Chain | null;
+        dataSuffix?: `0x${string}`;
+        gas?: bigint;
+        gasPrice?: bigint;
+        maxFeePerGas?: bigint;
+        maxPriorityFeePerGas?: bigint;
+        nonce?: number;
+        value?: bigint;
+    }): Promise<`0x${string}`>;
+    /**
+     * receiveMessage
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    receiveMessage(inputData: `0x${string}`, options?: {
+        accessList?: import('viem').AccessList;
+        authorizationList?: import('viem').AuthorizationList;
+        chain?: import('viem').Chain | null;
+        dataSuffix?: `0x${string}`;
+        gas?: bigint;
+        gasPrice?: bigint;
+        maxFeePerGas?: bigint;
+        maxPriorityFeePerGas?: bigint;
+        nonce?: number;
+        value?: bigint;
+    }): Promise<`0x${string}`>;
+    /**
+     * setFxChildTunnel
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    setFxChildTunnel(_fxChildTunnel: `0x${string}`, options?: {
+        accessList?: import('viem').AccessList;
+        authorizationList?: import('viem').AuthorizationList;
+        chain?: import('viem').Chain | null;
+        dataSuffix?: `0x${string}`;
+        gas?: bigint;
+        gasPrice?: bigint;
+        maxFeePerGas?: bigint;
+        maxPriorityFeePerGas?: bigint;
+        nonce?: number;
+        value?: bigint;
+    }): Promise<`0x${string}`>;
+    /**
+     * Simulate contract write operations (dry-run without sending transaction)
+     *
+     * @example
+     * const result = await contract.simulate.transfer('0x...', 1000n);
+     * console.log('Gas estimate:', result.request.gas);
+     * console.log('Would succeed:', result.result);
+     */
+    get simulate(): {
+        /**
+         * Simulate deposit
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        deposit(rootToken: `0x${string}`, childToken: `0x${string}`, user: `0x${string}`, amount: bigint, data: `0x${string}`, options?: {
+            accessList?: import("viem").AccessList;
+            authorizationList?: import("viem").AuthorizationList;
+            chain?: import("viem").Chain | null;
+            dataSuffix?: `0x${string}`;
+            gas?: bigint;
+            gasPrice?: bigint;
+            maxFeePerGas?: bigint;
+            maxPriorityFeePerGas?: bigint;
+            nonce?: number;
+            value?: bigint;
+        }): Promise<void>;
+        /**
+         * Simulate mapToken
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        mapToken(rootToken: `0x${string}`, _childToken: `0x${string}`, options?: {
+            accessList?: import("viem").AccessList;
+            authorizationList?: import("viem").AuthorizationList;
+            chain?: import("viem").Chain | null;
+            dataSuffix?: `0x${string}`;
+            gas?: bigint;
+            gasPrice?: bigint;
+            maxFeePerGas?: bigint;
+            maxPriorityFeePerGas?: bigint;
+            nonce?: number;
+            value?: bigint;
+        }): Promise<void>;
+        /**
+         * Simulate receiveMessage
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        receiveMessage(inputData: `0x${string}`, options?: {
+            accessList?: import("viem").AccessList;
+            authorizationList?: import("viem").AuthorizationList;
+            chain?: import("viem").Chain | null;
+            dataSuffix?: `0x${string}`;
+            gas?: bigint;
+            gasPrice?: bigint;
+            maxFeePerGas?: bigint;
+            maxPriorityFeePerGas?: bigint;
+            nonce?: number;
+            value?: bigint;
+        }): Promise<void>;
+        /**
+         * Simulate setFxChildTunnel
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        setFxChildTunnel(_fxChildTunnel: `0x${string}`, options?: {
+            accessList?: import("viem").AccessList;
+            authorizationList?: import("viem").AuthorizationList;
+            chain?: import("viem").Chain | null;
+            dataSuffix?: `0x${string}`;
+            gas?: bigint;
+            gasPrice?: bigint;
+            maxFeePerGas?: bigint;
+            maxPriorityFeePerGas?: bigint;
+            nonce?: number;
+            value?: bigint;
+        }): Promise<void>;
+    };
+    /**
+     * Watch contract events
+     *
+     * @example
+     * // Watch all Transfer events
+     * const unwatch = contract.watch.Transfer((event) => {
+     *   console.log('Transfer:', event);
+     * });
+     *
+     * // Stop watching
+     * unwatch();
+     */
+    get watch(): {
+        /**
+         * Watch FxDepositERC20 events
+         * @param callback Function to call when event is emitted
+         * @param filter Optional filter for indexed parameters
+         * @returns Unwatch function to stop listening
+         */
+        FxDepositERC20: (callback: (event: {
+            rootToken: `0x${string}`;
+            depositor: `0x${string}`;
+            userAddress: `0x${string}`;
+            amount: bigint;
+        }) => void, filter?: {
+            rootToken: `0x${string}`;
+            depositor: `0x${string}`;
+            userAddress: `0x${string}`;
+        }) => () => void;
+        /**
+         * Watch FxWithdrawERC20 events
+         * @param callback Function to call when event is emitted
+         * @param filter Optional filter for indexed parameters
+         * @returns Unwatch function to stop listening
+         */
+        FxWithdrawERC20: (callback: (event: {
+            rootToken: `0x${string}`;
+            childToken: `0x${string}`;
+            userAddress: `0x${string}`;
+            amount: bigint;
+        }) => void, filter?: {
+            rootToken: `0x${string}`;
+            childToken: `0x${string}`;
+            userAddress: `0x${string}`;
+        }) => () => void;
+        /**
+         * Watch TokenMappedERC20 events
+         * @param callback Function to call when event is emitted
+         * @param filter Optional filter for indexed parameters
+         * @returns Unwatch function to stop listening
+         */
+        TokenMappedERC20: (callback: (event: {
+            rootToken: `0x${string}`;
+            childToken: `0x${string}`;
+        }) => void, filter?: {
+            rootToken: `0x${string}`;
+            childToken: `0x${string}`;
+        }) => () => void;
+    };
+}