@aastar/paymaster 0.16.7

package/dist/core/src/actions/faucet.js

@@ -0,0 +1,337 @@
+import { parseEther, parseAbi, formatEther, zeroAddress, encodeAbiParameters } from 'viem';
+import { sepolia } from 'viem/chains';
+// Standard ERC20 ABI for minting/approving
+const ERC20_ABI = parseAbi([
+    'function mint(address to, uint256 amount) external',
+    'function approve(address spender, uint256 amount) external returns (bool)',
+    'function balanceOf(address account) external view returns (uint256)',
+    'function allowance(address owner, address spender) external view returns (uint256)',
+    'function transfer(address to, uint256 amount) external returns (bool)'
+]);
+const PAYMASTER_ABI = parseAbi([
+    'function depositFor(address target, uint256 amount) external',
+    'function deposit() external payable'
+]);
+export class SepoliaFaucetAPI {
+    /**
+     * Orchestrates the complete setup for a test account.
+     * 1. Funds ETH
+     * 2. Registers ENDUSER role
+     * 3. Mints potential Paymaster Tokens (cPNTs/dPNTs)
+     * 4. Deposits to Paymaster V4 (if address provided) using Admin's tokens
+     */
+    static async prepareTestAccount(adminWallet, publicClient, config) {
+        console.log(`\n🚰 SepoliaFaucetAPI: Preparing ${config.targetAA}...`);
+        const results = {
+            ethFunded: false,
+            roleRegistered: false,
+            tokenMinted: false,
+            paymasterDeposited: false
+        };
+        // 1. Fund ETH
+        const ethAmount = config.ethAmount ?? parseEther('0.1');
+        results.ethFunded = await this.fundETH(adminWallet, publicClient, config.targetAA, ethAmount);
+        // 2. Register EndUser
+        results.roleRegistered = await this.registerEndUser(adminWallet, publicClient, config.registry, config.targetAA, config.token, config.community);
+        // 3. Mint Tokens (User Holding Logic - for SuperPaymaster)
+        // If SuperPaymaster is involved, User needs to HOLD the token.
+        // If Paymaster V4 is involved, User might need to HOLD (Pull mode) or Admin Deposits (Push mode).
+        // Strategy: Always mint some to User for flexibility.
+        const tokenAmount = config.tokenAmount ?? parseEther('1000');
+        results.tokenMinted = await this.mintTestTokens(adminWallet, publicClient, config.token, config.targetAA, tokenAmount);
+        // 4. Admin Deposit for User (Paymaster V4 Logic)
+        if (config.paymasterV4) {
+            results.paymasterDeposited = await this.adminDepositForUser(adminWallet, publicClient, config.paymasterV4, config.targetAA, config.token, parseEther('10') // Deposit 10 Tokens for testing
+            );
+        }
+        console.log(`✅ Preparation Complete!`, results);
+        return results;
+    }
+    /**
+     * Funds the target with ETH if balance is below threshold.
+     */
+    static async fundETH(adminWallet, publicClient, target, amount) {
+        const balance = await publicClient.getBalance({ address: target });
+        // Threshold: 50% of target amount
+        if (balance < (amount / 2n)) {
+            console.log(`   💰 Funding ETH... (Before: ${formatEther(balance)})`);
+            const hash = await adminWallet.sendTransaction({
+                to: target,
+                value: amount,
+                chain: sepolia,
+                account: adminWallet.account
+            });
+            await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+            console.log(`      -> Sent ${formatEther(amount)} ETH. Tx: ${hash}`);
+            return true;
+        }
+        console.log(`   ✅ ETH Balance adequate (${formatEther(balance)} ETH).`);
+        return false;
+    }
+    /**
+     * Registers the ENDUSER role via Registry.
+     */
+    /**
+     * Registers the ENDUSER role using Sponsor Mode (Admin pays stake).
+     */
+    static async registerEndUser(adminWallet, publicClient, registryAddr, target, gasToken, // Re-using the 'token' passed in config which is GToken
+    community) {
+        // ENDUSER Hash: keccak256("ENDUSER")
+        const ENDUSER_ROLE = '0x0c34ecc75d3bf122e0609d2576e167f53fb42429262ce8c9b33cab91ff670e3a';
+        // 1. Check if already registered
+        const hasRole = await publicClient.readContract({
+            address: registryAddr,
+            abi: parseAbi(['function hasRole(bytes32 role, address account) view returns (bool)']),
+            functionName: 'hasRole',
+            args: [ENDUSER_ROLE, target]
+        });
+        if (hasRole) {
+            console.log(`   ✅ ENDUSER Role already held.`);
+            return false;
+        }
+        console.log(`   👤 Registering ENDUSER role (Sponsor Mode)...`);
+        try {
+            // 2. Get Staking Contract Address
+            const stakingAddr = await publicClient.readContract({
+                address: registryAddr,
+                abi: parseAbi(['function GTOKEN_STAKING() view returns (address)']),
+                functionName: 'GTOKEN_STAKING'
+            });
+            // Fetch the actual GToken required by Staking
+            const stakingToken = await publicClient.readContract({
+                address: stakingAddr,
+                abi: parseAbi(['function GTOKEN() view returns (address)']),
+                functionName: 'GTOKEN'
+            });
+            // 3. Admin Approves Staking Contract (if needed)
+            const adminAddr = adminWallet.account.address;
+            console.log(`      🔎 Debug Staking: Registry=${registryAddr}, Staking=${stakingAddr}`);
+            console.log(`      🔎 Debug Token: Contract=${stakingToken}`);
+            // Check allowance for the STAKING TOKEN
+            const allowance = await publicClient.readContract({
+                address: stakingToken,
+                abi: ERC20_ABI,
+                functionName: 'allowance',
+                args: [adminAddr, stakingAddr]
+            });
+            console.log(`      🔎 Debug Allowance: ${formatEther(allowance)} (Needed: >0.5)`);
+            // Approve if needed (standard stake ~0.3 ETH, verify enough)
+            const approveAmount = parseEther('1000'); // A sufficiently large amount
+            if (allowance < parseEther('500')) {
+                console.log('      🔓 Approving Staking Contract (Core Token)...');
+                const hashApprove = await adminWallet.writeContract({
+                    address: stakingToken,
+                    abi: ERC20_ABI,
+                    functionName: 'approve',
+                    args: [stakingAddr, approveAmount],
+                    chain: sepolia,
+                    account: adminWallet.account
+                });
+                await publicClient.waitForTransactionReceipt({ hash: hashApprove, timeout: 300000 });
+                console.log(`      🔓 Approving Staking Contract... ${hashApprove}`);
+                // Ensure Admin has GTokens (Staking Token) balance
+                const adminGBal = await publicClient.readContract({
+                    address: stakingToken,
+                    abi: ERC20_ABI,
+                    functionName: 'balanceOf',
+                    args: [adminAddr]
+                });
+                if (adminGBal < parseEther('100')) {
+                    console.log(`      🪙 Minting GTokens (Staking Token) to Admin...`);
+                    try {
+                        const hashGMint = await adminWallet.writeContract({
+                            address: stakingToken,
+                            abi: ERC20_ABI,
+                            functionName: 'mint',
+                            args: [adminAddr, parseEther('1000')],
+                            chain: sepolia,
+                            account: adminWallet.account
+                        });
+                        await publicClient.waitForTransactionReceipt({ hash: hashGMint, timeout: 300000 });
+                        console.log(`      ✅ GTokens Minted. Tx: ${hashGMint}`);
+                    }
+                    catch (e) {
+                        console.warn(`      ⚠️ Failed to mint GTokens (Admin might not be minter):`, e);
+                    }
+                }
+            }
+            // ALSO Approve Registry (just in case it pulls first)
+            const allowReg = await publicClient.readContract({
+                address: stakingToken,
+                abi: ERC20_ABI,
+                functionName: 'allowance',
+                args: [adminAddr, registryAddr]
+            });
+            if (allowReg < parseEther('500')) {
+                console.log('      🔓 Approving Registry Contract...');
+                const hash = await adminWallet.writeContract({
+                    address: stakingToken,
+                    abi: ERC20_ABI,
+                    functionName: 'approve',
+                    args: [registryAddr, parseEther('1000')],
+                    chain: sepolia,
+                    account: adminWallet.account
+                });
+                await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+                console.log(`      ✅ Approved Registry. Tx: ${hash}`);
+            }
+            else {
+                console.log('      ✅ Allowance sufficient.');
+            }
+            // 5. Register Role (registerRole)
+            // EndUser Role Data: (address account, address community, string avatarURI, string ensName, uint256 stakeAmount)
+            const userData = encodeAbiParameters([
+                { name: 'account', type: 'address' },
+                { name: 'community', type: 'address' },
+                { name: 'avatarURI', type: 'string' },
+                { name: 'ensName', type: 'string' },
+                { name: 'stakeAmount', type: 'uint256' }
+            ], 
+            // Stake Amount 0, relying on Registry to enforce minStake and charge msg.sender
+            [target, community || zeroAddress, '', '', 0n]);
+            const hashMint = await adminWallet.writeContract({
+                address: registryAddr,
+                abi: parseAbi([
+                    'function safeMintForRole(bytes32 roleId, address user, bytes calldata data) external returns (uint256)',
+                    'error InvalidParameter(string message)'
+                ]),
+                functionName: 'safeMintForRole',
+                args: [ENDUSER_ROLE, target, userData],
+                chain: sepolia,
+                account: adminWallet.account
+            });
+            await publicClient.waitForTransactionReceipt({ hash: hashMint, timeout: 300000 });
+            console.log(`      -> Role Sponsored & Granted. Tx: ${hashMint}`);
+            return true;
+        }
+        catch (error) {
+            console.warn(`      ⚠️ Failed to sponsor ENDUSER role. Error:`, error);
+            return false;
+        }
+    }
+    /**
+     * Mints tokens directly to the target.
+     */
+    static async mintTestTokens(adminWallet, publicClient, token, target, amount) {
+        const balance = await publicClient.readContract({
+            address: token,
+            abi: ERC20_ABI,
+            functionName: 'balanceOf',
+            args: [target]
+        });
+        if (balance < amount) {
+            console.log(`   🪙 Funding Tokens... (Current: ${formatEther(balance)})`);
+            const adminAddr = adminWallet.account.address;
+            // 1. Try Transfer from Admin (if Admin has balance)
+            const adminBal = await publicClient.readContract({
+                address: token,
+                abi: ERC20_ABI,
+                functionName: 'balanceOf',
+                args: [adminAddr]
+            });
+            if (adminBal >= amount) {
+                console.log(`      💸 Transferring from Admin...`);
+                const hash = await adminWallet.writeContract({
+                    address: token,
+                    abi: ERC20_ABI,
+                    functionName: 'transfer',
+                    args: [target, amount],
+                    chain: sepolia,
+                    account: adminWallet.account
+                });
+                await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+                console.log(`      ✅ Transferred ${formatEther(amount)}. Tx: ${hash}`);
+                return true;
+            }
+            // 2. Try Mint (Assuming Admin has Minter Role or is Owner)
+            console.log(`      🪙 Admin balance low. Attempting Mint...`);
+            try {
+                const hash = await adminWallet.writeContract({
+                    address: token,
+                    abi: ERC20_ABI,
+                    functionName: 'mint',
+                    args: [target, amount],
+                    chain: sepolia,
+                    account: adminWallet.account
+                });
+                await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+                console.log(`      ✅ Minted ${formatEther(amount)}. Tx: ${hash}`);
+                return true;
+            }
+            catch (e) {
+                console.warn(`      ⚠️ Failed to mint/transfer tokens. Check Admin permissions/balance.`, e);
+                return false;
+            }
+        }
+        console.log(`   ✅ Token Balance adequate.`);
+        return false;
+    }
+    /**
+     * Complex Flow:
+     * 1. Admin mints tokens to SELF.
+     * 2. Admin approves Paymaster.
+     * 3. Admin calls depositFor(target) on Paymaster.
+     */
+    static async adminDepositForUser(adminWallet, publicClient, paymaster, target, token, amount) {
+        // 1. Mint to Admin First
+        const adminAddr = adminWallet.account.address;
+        const adminBal = await publicClient.readContract({
+            address: token,
+            abi: ERC20_ABI,
+            functionName: 'balanceOf',
+            args: [adminAddr]
+        });
+        if (adminBal < amount) {
+            console.log(`   🏧 Admin Minting to Self (for deposit)...`);
+            const hash = await adminWallet.writeContract({
+                address: token,
+                abi: ERC20_ABI,
+                functionName: 'mint',
+                args: [adminAddr, amount * 10n], // bulk mint
+                chain: sepolia,
+                account: adminWallet.account
+            });
+            await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+            console.log(`      -> Admin Minted. Tx: ${hash}`);
+        }
+        // 2. Approve Paymaster
+        const allowance = await publicClient.readContract({
+            address: token,
+            abi: ERC20_ABI,
+            functionName: 'allowance',
+            args: [adminAddr, paymaster]
+        });
+        if (allowance < amount) {
+            console.log(`   🔓 Admin Approving Paymaster...`);
+            const hash = await adminWallet.writeContract({
+                address: token,
+                abi: ERC20_ABI,
+                functionName: 'approve',
+                args: [paymaster, 115792089237316195423570985008687907853269984665640564039457584007913129639935n], // Max Uint
+                chain: sepolia,
+                account: adminWallet.account
+            });
+            await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+            console.log(`      -> Approved Paymaster. Tx: ${hash}`);
+        }
+        // 3. Deposit For
+        console.log(`   🏦 Depositing FOR User...`);
+        try {
+            const hash = await adminWallet.writeContract({
+                address: paymaster,
+                abi: PAYMASTER_ABI,
+                functionName: 'depositFor',
+                args: [target, amount],
+                chain: sepolia,
+                account: adminWallet.account
+            });
+            await publicClient.waitForTransactionReceipt({ hash, timeout: 300000 });
+            console.log(`      -> Deposited ${formatEther(amount)} to PM. Tx: ${hash}`);
+            return true;
+        }
+        catch (e) {
+            console.warn(`      ⚠️ Deposit Failed (Maybe not supported on this PM?):`, e);
+            return false;
+        }
+    }
+}

package/dist/core/src/actions/gtokenExtended.d.ts

@@ -0,0 +1,39 @@
+import { type Address, type PublicClient, type WalletClient, type Hash, type Account } from 'viem';
+export type GTokenExtendedActions = {
+    mint: (args: {
+        to: Address;
+        amount: bigint;
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    burn: (args: {
+        amount: bigint;
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    burnFrom: (args: {
+        from: Address;
+        amount: bigint;
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    cap: () => Promise<bigint>;
+    minter: () => Promise<Address>;
+    setMinter: (args: {
+        minter: Address;
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    pause: (args: {
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    unpause: (args: {
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    paused: () => Promise<boolean>;
+    owner: () => Promise<Address>;
+    transferOwnership: (args: {
+        newOwner: Address;
+        account?: Account | Address;
+    }) => Promise<Hash>;
+    renounceOwnership: (args: {
+        account?: Account | Address;
+    }) => Promise<Hash>;
+};
+export declare const gTokenExtendedActions: (address: Address) => (client: PublicClient | WalletClient) => GTokenExtendedActions;

package/dist/core/src/actions/gtokenExtended.js

@@ -0,0 +1,115 @@
+import { GTokenABI } from '../abis/index.js';
+export const gTokenExtendedActions = (address) => (client) => ({
+    async mint({ to, amount, account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'mint',
+            args: [to, amount],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async burn({ amount, account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'burn',
+            args: [amount],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async burnFrom({ from, amount, account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'burnFrom',
+            args: [from, amount],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async cap() {
+        return client.readContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'cap',
+            args: []
+        });
+    },
+    async minter() {
+        return client.readContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'minter',
+            args: []
+        });
+    },
+    async setMinter({ minter, account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'setMinter',
+            args: [minter],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async pause({ account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'pause',
+            args: [],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async unpause({ account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'unpause',
+            args: [],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async paused() {
+        return client.readContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'paused',
+            args: []
+        });
+    },
+    async owner() {
+        return client.readContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'owner',
+            args: []
+        });
+    },
+    async transferOwnership({ newOwner, account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'transferOwnership',
+            args: [newOwner],
+            account: account,
+            chain: client.chain
+        });
+    },
+    async renounceOwnership({ account }) {
+        return client.writeContract({
+            address,
+            abi: GTokenABI,
+            functionName: 'renounceOwnership',
+            args: [],
+            account: account,
+            chain: client.chain
+        });
+    }
+});

package/dist/core/src/actions/index.d.ts

@@ -0,0 +1,15 @@
+export * from './registry.js';
+export * from './staking.js';
+export * from './sbt.js';
+export * from './superPaymaster.js';
+export * from './paymasterV4.js';
+export * from './reputation.js';
+export * from './tokens.js';
+export * from './entryPoint.js';
+export * from './gtokenExtended.js';
+export * from './StateValidator.js';
+export * from './dvt.js';
+export * from './factory.js';
+export * from './aggregator.js';
+export * from './account.js';
+export * from './faucet.js';

package/dist/core/src/actions/index.js

@@ -0,0 +1,17 @@
+export * from './registry.js';
+export * from './staking.js';
+export * from './sbt.js';
+export * from './superPaymaster.js';
+export * from './paymasterV4.js';
+export * from './reputation.js';
+export * from './tokens.js';
+export * from './entryPoint.js';
+export * from './gtokenExtended.js';
+export * from './StateValidator.js';
+export * from './dvt.js';
+export * from './factory.js';
+export * from './aggregator.js';
+export * from './account.js';
+export * from './faucet.js';
+// validators.ts merged into dvt.js and aggregator.js
+// validators.ts merged into dvt.js and aggregator.js