@gitmyabi/erc20 1.0.0 → 1.0.1

package/contracts/TokenERC20.ts

@@ -0,0 +1,760 @@
+import type { Abi, Address, PublicClient, WalletClient, GetContractReturnType } from 'viem';
+import { getContract } from 'viem';
+
+/**
+ * TokenERC20 ABI
+ * 
+ * This ABI is typed using viem's type system for full type safety.
+ */
+export const TokenERC20Abi = [
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_spender",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "approve",
+    "outputs": [
+      {
+        "name": "success",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_from",
+        "type": "address"
+      },
+      {
+        "name": "_to",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "transferFrom",
+    "outputs": [
+      {
+        "name": "success",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "burn",
+    "outputs": [
+      {
+        "name": "success",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [
+      {
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_from",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "burnFrom",
+    "outputs": [
+      {
+        "name": "success",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [
+      {
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_to",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "transfer",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_spender",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      },
+      {
+        "name": "_extraData",
+        "type": "bytes"
+      }
+    ],
+    "name": "approveAndCall",
+    "outputs": [
+      {
+        "name": "success",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [
+      {
+        "name": "",
+        "type": "address"
+      },
+      {
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "name": "allowance",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "name": "initialSupply",
+        "type": "uint256"
+      },
+      {
+        "name": "tokenName",
+        "type": "string"
+      },
+      {
+        "name": "tokenSymbol",
+        "type": "string"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Burn",
+    "type": "event"
+  }
+] as const satisfies Abi;
+
+/**
+ * Type-safe ABI for TokenERC20
+ */
+export type TokenERC20Abi = typeof TokenERC20Abi;
+
+/**
+ * Contract instance type for TokenERC20
+ */
+// Use any for contract type to avoid complex viem type issues
+// The runtime behavior is type-safe through viem's ABI typing
+export type TokenERC20Contract = any;
+
+/**
+ * TokenERC20 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 { TokenERC20 } from 'TokenERC20';
+ * 
+ * const publicClient = createPublicClient({ chain: mainnet, transport: http() });
+ * const walletClient = createWalletClient({ chain: mainnet, transport: http() });
+ * 
+ * const contract = new TokenERC20('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 class TokenERC20 {
+  private contract: TokenERC20Contract;
+  private contractAddress: Address;
+  private publicClient: PublicClient;
+
+  constructor(
+    address: Address,
+    clients: {
+      publicClient: PublicClient;
+      walletClient?: WalletClient;
+    }
+  ) {
+    this.contractAddress = address;
+    this.publicClient = clients.publicClient;
+    this.contract = getContract({
+      address,
+      abi: TokenERC20Abi,
+      client: {
+        public: clients.publicClient,
+        wallet: clients.walletClient,
+      },
+    });
+  }
+
+  /**
+   * Get the contract address
+   */
+  get address(): Address {
+    return this.contractAddress;
+  }
+
+  /**
+   * Get the underlying viem contract instance.
+   */
+  getContract(): TokenERC20Contract {
+    return this.contract;
+  }
+
+  /**
+   * name
+   * view
+   */
+  async name(): Promise<string> {
+    return this.contract.read.name() as Promise<string>;
+  }
+
+  /**
+   * totalSupply
+   * view
+   */
+  async totalSupply(): Promise<bigint> {
+    return this.contract.read.totalSupply() as Promise<bigint>;
+  }
+
+  /**
+   * decimals
+   * view
+   */
+  async decimals(): Promise<bigint> {
+    return this.contract.read.decimals() as Promise<bigint>;
+  }
+
+  /**
+   * balanceOf
+   * view
+   */
+  async balanceOf(arg0: `0x${string}`): Promise<bigint> {
+    return this.contract.read.balanceOf([arg0] as const) as Promise<bigint>;
+  }
+
+  /**
+   * symbol
+   * view
+   */
+  async symbol(): Promise<string> {
+    return this.contract.read.symbol() as Promise<string>;
+  }
+
+  /**
+   * allowance
+   * view
+   */
+  async allowance(arg0: `0x${string}`, arg1: `0x${string}`): Promise<bigint> {
+    return this.contract.read.allowance([arg0, arg1] as const) as Promise<bigint>;
+  }
+
+  /**
+   * approve
+   * nonpayable
+   * @param options Optional transaction parameters (value, gas, nonce, etc.)
+   */
+  async approve(_spender: `0x${string}`, _value: bigint, 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}`> {
+    if (!this.contract.write) {
+      throw new Error('Wallet client is required for write operations');
+    }
+    return this.contract.write.approve([_spender, _value] as const, options) as Promise<`0x${string}`>;
+  }
+
+  /**
+   * transferFrom
+   * nonpayable
+   * @param options Optional transaction parameters (value, gas, nonce, etc.)
+   */
+  async transferFrom(_from: `0x${string}`, _to: `0x${string}`, _value: bigint, 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}`> {
+    if (!this.contract.write) {
+      throw new Error('Wallet client is required for write operations');
+    }
+    return this.contract.write.transferFrom([_from, _to, _value] as const, options) as Promise<`0x${string}`>;
+  }
+
+  /**
+   * burn
+   * nonpayable
+   * @param options Optional transaction parameters (value, gas, nonce, etc.)
+   */
+  async burn(_value: bigint, 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}`> {
+    if (!this.contract.write) {
+      throw new Error('Wallet client is required for write operations');
+    }
+    return this.contract.write.burn([_value] as const, options) as Promise<`0x${string}`>;
+  }
+
+  /**
+   * burnFrom
+   * nonpayable
+   * @param options Optional transaction parameters (value, gas, nonce, etc.)
+   */
+  async burnFrom(_from: `0x${string}`, _value: bigint, 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}`> {
+    if (!this.contract.write) {
+      throw new Error('Wallet client is required for write operations');
+    }
+    return this.contract.write.burnFrom([_from, _value] as const, options) as Promise<`0x${string}`>;
+  }
+
+  /**
+   * transfer
+   * nonpayable
+   * @param options Optional transaction parameters (value, gas, nonce, etc.)
+   */
+  async transfer(_to: `0x${string}`, _value: bigint, 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}`> {
+    if (!this.contract.write) {
+      throw new Error('Wallet client is required for write operations');
+    }
+    return this.contract.write.transfer([_to, _value] as const, options) as Promise<`0x${string}`>;
+  }
+
+  /**
+   * approveAndCall
+   * nonpayable
+   * @param options Optional transaction parameters (value, gas, nonce, etc.)
+   */
+  async approveAndCall(_spender: `0x${string}`, _value: bigint, _extraData: `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}`> {
+    if (!this.contract.write) {
+      throw new Error('Wallet client is required for write operations');
+    }
+    return this.contract.write.approveAndCall([_spender, _value, _extraData] as const, options) as 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() {
+    const contract = this.contract;
+    if (!contract.simulate) {
+      throw new Error('Public client is required for simulation');
+    }
+    return {
+      /**
+       * Simulate approve
+       * Returns gas estimate and result without sending transaction
+       * @param options Optional transaction parameters (value, gas, nonce, etc.)
+       */
+      async approve(_spender: `0x${string}`, _value: bigint, 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<boolean> {
+        return contract.simulate.approve([_spender, _value] as const, options) as Promise<boolean>;
+      },
+      /**
+       * Simulate transferFrom
+       * Returns gas estimate and result without sending transaction
+       * @param options Optional transaction parameters (value, gas, nonce, etc.)
+       */
+      async transferFrom(_from: `0x${string}`, _to: `0x${string}`, _value: bigint, 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<boolean> {
+        return contract.simulate.transferFrom([_from, _to, _value] as const, options) as Promise<boolean>;
+      },
+      /**
+       * Simulate burn
+       * Returns gas estimate and result without sending transaction
+       * @param options Optional transaction parameters (value, gas, nonce, etc.)
+       */
+      async burn(_value: bigint, 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<boolean> {
+        return contract.simulate.burn([_value] as const, options) as Promise<boolean>;
+      },
+      /**
+       * Simulate burnFrom
+       * Returns gas estimate and result without sending transaction
+       * @param options Optional transaction parameters (value, gas, nonce, etc.)
+       */
+      async burnFrom(_from: `0x${string}`, _value: bigint, 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<boolean> {
+        return contract.simulate.burnFrom([_from, _value] as const, options) as Promise<boolean>;
+      },
+      /**
+       * Simulate transfer
+       * Returns gas estimate and result without sending transaction
+       * @param options Optional transaction parameters (value, gas, nonce, etc.)
+       */
+      async transfer(_to: `0x${string}`, _value: bigint, 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> {
+        return contract.simulate.transfer([_to, _value] as const, options) as Promise<void>;
+      },
+      /**
+       * Simulate approveAndCall
+       * Returns gas estimate and result without sending transaction
+       * @param options Optional transaction parameters (value, gas, nonce, etc.)
+       */
+      async approveAndCall(_spender: `0x${string}`, _value: bigint, _extraData: `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<boolean> {
+        return contract.simulate.approveAndCall([_spender, _value, _extraData] as const, options) as Promise<boolean>;
+      }
+    };
+  }
+
+  /**
+   * Watch contract events
+   * 
+   * @example
+   * // Watch all Transfer events
+   * const unwatch = contract.watch.Transfer((event) => {
+   *   console.log('Transfer:', event);
+   * });
+   * 
+   * // Stop watching
+   * unwatch();
+   */
+  get watch() {
+    return {
+      /**
+       * Watch Transfer events
+       * @param callback Function to call when event is emitted
+       * @param filter Optional filter for indexed parameters
+       * @returns Unwatch function to stop listening
+       */
+      Transfer: (callback: (event: { from: `0x${string}`; to: `0x${string}`; value: bigint }) => void, filter?: { from?: `0x${string}` | `0x${string}`[] | null; to?: `0x${string}` | `0x${string}`[] | null }) => {
+        return this.publicClient.watchContractEvent({
+          address: this.contractAddress,
+          abi: TokenERC20Abi,
+          eventName: 'Transfer',
+          args: filter as any,
+          onLogs: (logs: any[]) => {
+            logs.forEach((log: any) => {
+              callback(log.args as any);
+            });
+          },
+        }) as () => void;
+      },
+      /**
+       * Watch Burn events
+       * @param callback Function to call when event is emitted
+       * @param filter Optional filter for indexed parameters
+       * @returns Unwatch function to stop listening
+       */
+      Burn: (callback: (event: { from: `0x${string}`; value: bigint }) => void, filter?: { from?: `0x${string}` | `0x${string}`[] | null }) => {
+        return this.publicClient.watchContractEvent({
+          address: this.contractAddress,
+          abi: TokenERC20Abi,
+          eventName: 'Burn',
+          args: filter as any,
+          onLogs: (logs: any[]) => {
+            logs.forEach((log: any) => {
+              callback(log.args as any);
+            });
+          },
+        }) as () => void;
+      }
+    };
+  }
+}