@gitmyabi/merkleredeem 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,108 @@
-# Temporary Holding Version
+# @gitmyabi/merkleredeem
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Auto-generated TypeScript type bindings for **MerkleRedeem**
+
+- **Build ID**: `etherscan-merkleredeem-dbc3088d-1793764440865`
+- **Build Number**: 1
+- **Commit**: `c51ba44`
+- **Branch**: `etherscan`
+- **Target**: `ethers-v6`
+- **Contracts**: 1
+
+## Installation
+
+```bash
+npm install @gitmyabi/merkleredeem@1.0.1
+```
+
+## Usage
+
+### Class-based API (TypeChain-like)
+
+```typescript
+import { createPublicClient, createWalletClient, http } from 'viem';
+import { mainnet } from 'viem/chains';
+import { YourContract } from '@gitmyabi/merkleredeem';
+
+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/merkleredeem';
+
+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/merkleredeem';
+
+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/MerkleRedeem_json.d.ts

@@ -0,0 +1,563 @@
+import type { Address, PublicClient, WalletClient } from 'viem';
+/**
+ * MerkleRedeem.Claim struct type
+ */
+export type MerkleRedeem_Claim = {
+    week: bigint;
+    balance: bigint;
+    merkleProof: `0x${string}`[];
+};
+/**
+ * MerkleRedeem_json ABI
+ *
+ * This ABI is typed using viem's type system for full type safety.
+ */
+export declare const MerkleRedeem_jsonAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_token";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: false;
+        readonly internalType: "address";
+        readonly name: "_claimant";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "_balance";
+        readonly type: "uint256";
+    }];
+    readonly name: "Claimed";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "previousOwner";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "newOwner";
+        readonly type: "address";
+    }];
+    readonly name: "OwnershipTransferred";
+    readonly type: "event";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_liquidityProvider";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_begin";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_end";
+        readonly type: "uint256";
+    }];
+    readonly name: "claimStatus";
+    readonly outputs: readonly [{
+        readonly internalType: "bool[]";
+        readonly name: "";
+        readonly type: "bool[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_liquidityProvider";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_week";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_claimedBalance";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "bytes32[]";
+        readonly name: "_merkleProof";
+        readonly type: "bytes32[]";
+    }];
+    readonly name: "claimWeek";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_liquidityProvider";
+        readonly type: "address";
+    }, {
+        readonly components: readonly [{
+            readonly internalType: "uint256";
+            readonly name: "week";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "balance";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "bytes32[]";
+            readonly name: "merkleProof";
+            readonly type: "bytes32[]";
+        }];
+        readonly internalType: "struct MerkleRedeem.Claim[]";
+        readonly name: "claims";
+        readonly type: "tuple[]";
+    }];
+    readonly name: "claimWeeks";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly name: "claimed";
+    readonly outputs: readonly [{
+        readonly internalType: "bool";
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "_begin";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_end";
+        readonly type: "uint256";
+    }];
+    readonly name: "merkleRoots";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32[]";
+        readonly name: "";
+        readonly type: "bytes32[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "owner";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "renounceOwnership";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "_week";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "bytes32";
+        readonly name: "_merkleRoot";
+        readonly type: "bytes32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_totalAllocation";
+        readonly type: "uint256";
+    }];
+    readonly name: "seedAllocations";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "token";
+    readonly outputs: readonly [{
+        readonly internalType: "contract IERC20";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "newOwner";
+        readonly type: "address";
+    }];
+    readonly name: "transferOwnership";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_liquidityProvider";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_week";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "_claimedBalance";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "bytes32[]";
+        readonly name: "_merkleProof";
+        readonly type: "bytes32[]";
+    }];
+    readonly name: "verifyClaim";
+    readonly outputs: readonly [{
+        readonly internalType: "bool";
+        readonly name: "valid";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly name: "weekMerkleRoots";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+/**
+ * Type-safe ABI for MerkleRedeem_json
+ */
+export type MerkleRedeem_jsonAbi = typeof MerkleRedeem_jsonAbi;
+/**
+ * Contract instance type for MerkleRedeem_json
+ */
+export type MerkleRedeem_jsonContract = any;
+/**
+ * MerkleRedeem_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 { MerkleRedeem_json } from 'MerkleRedeem_json';
+ *
+ * const publicClient = createPublicClient({ chain: mainnet, transport: http() });
+ * const walletClient = createWalletClient({ chain: mainnet, transport: http() });
+ *
+ * const contract = new MerkleRedeem_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 MerkleRedeem_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(): MerkleRedeem_jsonContract;
+    /**
+     * claimStatus
+     * view
+     */
+    claimStatus(_liquidityProvider: `0x${string}`, _begin: bigint, _end: bigint): Promise<boolean[]>;
+    /**
+     * claimed
+     * view
+     */
+    claimed(arg0: bigint, arg1: `0x${string}`): Promise<boolean>;
+    /**
+     * merkleRoots
+     * view
+     */
+    merkleRoots(_begin: bigint, _end: bigint): Promise<`0x${string}`[]>;
+    /**
+     * owner
+     * view
+     */
+    owner(): Promise<`0x${string}`>;
+    /**
+     * token
+     * view
+     */
+    token(): Promise<`0x${string}`>;
+    /**
+     * verifyClaim
+     * view
+     */
+    verifyClaim(_liquidityProvider: `0x${string}`, _week: bigint, _claimedBalance: bigint, _merkleProof: `0x${string}`[]): Promise<boolean>;
+    /**
+     * weekMerkleRoots
+     * view
+     */
+    weekMerkleRoots(arg0: bigint): Promise<`0x${string}`>;
+    /**
+     * claimWeek
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    claimWeek(_liquidityProvider: `0x${string}`, _week: bigint, _claimedBalance: bigint, _merkleProof: `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}`>;
+    /**
+     * claimWeeks
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    claimWeeks(_liquidityProvider: `0x${string}`, claims: MerkleRedeem_Claim[], 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}`>;
+    /**
+     * renounceOwnership
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    renounceOwnership(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}`>;
+    /**
+     * seedAllocations
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    seedAllocations(_week: bigint, _merkleRoot: `0x${string}`, _totalAllocation: 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}`>;
+    /**
+     * transferOwnership
+     * nonpayable
+     * @param options Optional transaction parameters (value, gas, nonce, etc.)
+     */
+    transferOwnership(newOwner: `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 claimWeek
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        claimWeek(_liquidityProvider: `0x${string}`, _week: bigint, _claimedBalance: bigint, _merkleProof: `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 claimWeeks
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        claimWeeks(_liquidityProvider: `0x${string}`, claims: MerkleRedeem_Claim[], 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 renounceOwnership
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        renounceOwnership(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 seedAllocations
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        seedAllocations(_week: bigint, _merkleRoot: `0x${string}`, _totalAllocation: 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>;
+        /**
+         * Simulate transferOwnership
+         * Returns gas estimate and result without sending transaction
+         * @param options Optional transaction parameters (value, gas, nonce, etc.)
+         */
+        transferOwnership(newOwner: `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 Claimed events
+         * @param callback Function to call when event is emitted
+         * @param filter Optional filter for indexed parameters
+         * @returns Unwatch function to stop listening
+         */
+        Claimed: (callback: (event: {
+            _claimant: `0x${string}`;
+            _balance: bigint;
+        }) => void) => () => void;
+        /**
+         * Watch OwnershipTransferred events
+         * @param callback Function to call when event is emitted
+         * @param filter Optional filter for indexed parameters
+         * @returns Unwatch function to stop listening
+         */
+        OwnershipTransferred: (callback: (event: {
+            previousOwner: `0x${string}`;
+            newOwner: `0x${string}`;
+        }) => void, filter?: {
+            previousOwner: `0x${string}`;
+            newOwner: `0x${string}`;
+        }) => () => void;
+    };
+}