@4mica/sdk 1.0.0 → 1.0.2

package/README.md

@@ -144,6 +144,23 @@ The SDK exposes three main entry points:
 - `client.recipient`: recipient-side operations (tabs, guarantees, remuneration)
 - `X402Flow`: helper for 402-protected HTTP resources
 
+### End-to-end Example (Base Sepolia + x402 v2)
+
+See `examples/base-sepolia-x402-facilitator-e2e.ts` for a full flow in the `examples` folder:
+- deposit collateral
+- create/get a tab via facilitator
+- issue and verify V1 + V2 guarantees
+- `payTab` in ERC20 for V1
+- remunerate V2 only after `wachai-validation-sdk` returns a passing ERC-8004 validation
+- submit + finalize withdrawal
+
+Run it with:
+
+```bash
+cp examples/.env.x402-facilitator-e2e.example examples/.env.x402-facilitator-e2e
+npx dotenv-cli -e examples/.env.x402-facilitator-e2e -- npm run example:base-sepolia:x402-v2
+```
+
 ### X402 flow (HTTP 402)
 
 The X402 helper turns `paymentRequirements` from a `402 Payment Required` response into an

package/dist/contract.d.ts

@@ -21,6 +21,7 @@ export declare class ContractGateway {
     static create(rpcUrl: string, signer: Account, contractAddress: Hex, chainId: number): Promise<ContractGateway>;
     private erc20;
     private enqueueTx;
+    private defaultFeeParams;
     private splitWaitOptions;
     getGuaranteeDomain(): Promise<string>;
     getGuaranteeVersionConfig(version: number): Promise<{

package/dist/contract.js

@@ -7,6 +7,9 @@ const chain_1 = require("./chain");
 const errors_1 = require("./errors");
 const utils_1 = require("./utils");
 const DEFAULT_REMUNERATE_GAS_LIMIT = 8000000n;
+const DEFAULT_PAY_TAB_ERC20_GAS_LIMIT = 300000n;
+const DEFAULT_MAX_FEE_PER_GAS = (0, viem_1.parseGwei)('0.1');
+const DEFAULT_MAX_PRIORITY_FEE_PER_GAS = (0, viem_1.parseGwei)('0.1');
 class ContractGateway {
     publicClient;
     walletClient;
@@ -58,6 +61,12 @@ class ContractGateway {
         this.txQueue = run.then(() => undefined, () => undefined);
         return run;
     }
+    defaultFeeParams() {
+        return {
+            maxFeePerGas: DEFAULT_MAX_FEE_PER_GAS,
+            maxPriorityFeePerGas: DEFAULT_MAX_PRIORITY_FEE_PER_GAS,
+        };
+    }
     splitWaitOptions(waitOptions) {
         if (!waitOptions) {
             return { receipt: {} };
@@ -81,19 +90,36 @@ class ContractGateway {
     async approveErc20(token, amount, waitOptions) {
         const { receipt } = this.splitWaitOptions(waitOptions);
         const erc20 = this.erc20(token);
-        // spender address logic
         const spender = this.contract.address;
-        const hash = await this.enqueueTx(() => erc20.write.approve([spender, (0, utils_1.parseU256)(amount)]));
-        return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
+        const targetAllowance = (0, utils_1.parseU256)(amount);
+        const sendApprove = async (value) => {
+            const hash = await this.enqueueTx(() => erc20.write.approve([spender, value], this.defaultFeeParams()));
+            const txReceipt = await this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
+            if (txReceipt.status !== 'success') {
+                throw new errors_1.ContractError(`approve transaction reverted: ${hash}`);
+            }
+            return txReceipt;
+        };
+        try {
+            return await sendApprove(targetAllowance);
+        }
+        catch (error) {
+            // Some ERC20s require resetting allowance to zero before setting a new value.
+            if (targetAllowance === 0n) {
+                throw error;
+            }
+            await sendApprove(0n);
+            return sendApprove(targetAllowance);
+        }
     }
     async deposit(amount, erc20Token, waitOptions) {
         const { receipt } = this.splitWaitOptions(waitOptions);
         let hash;
         if (erc20Token) {
-            hash = await this.enqueueTx(() => this.contract.write.depositStablecoin([erc20Token, (0, utils_1.parseU256)(amount)]));
+            hash = await this.enqueueTx(() => this.contract.write.depositStablecoin([erc20Token, (0, utils_1.parseU256)(amount)], this.defaultFeeParams()));
         }
         else {
-            hash = await this.enqueueTx(() => this.contract.write.deposit({ value: (0, utils_1.parseU256)(amount) }));
+            hash = await this.enqueueTx(() => this.contract.write.deposit({ value: (0, utils_1.parseU256)(amount), ...this.defaultFeeParams() }));
         }
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
@@ -128,17 +154,16 @@ class ContractGateway {
             to: recipient,
             value: (0, utils_1.parseU256)(amount),
             data: (0, utils_1.hexFromBytes)(data),
+            ...this.defaultFeeParams(),
         }));
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
     async payTabErc20(tabId, amount, erc20Token, recipient, waitOptions) {
-        const { receipt } = this.splitWaitOptions(waitOptions);
-        const hash = await this.enqueueTx(() => this.contract.write.payTabInERC20Token([
-            (0, utils_1.parseU256)(tabId),
-            erc20Token,
-            (0, utils_1.parseU256)(amount),
-            recipient,
-        ]));
+        const { gas, receipt } = this.splitWaitOptions(waitOptions);
+        const hash = await this.enqueueTx(() => this.contract.write.payTabInERC20Token([(0, utils_1.parseU256)(tabId), erc20Token, (0, utils_1.parseU256)(amount), recipient], {
+            gas: gas ?? DEFAULT_PAY_TAB_ERC20_GAS_LIMIT,
+            ...this.defaultFeeParams(),
+        }));
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
     async requestWithdrawal(amount, erc20Token, waitOptions) {
@@ -146,10 +171,10 @@ class ContractGateway {
         const value = (0, utils_1.parseU256)(amount);
         let hash;
         if (erc20Token) {
-            hash = await this.enqueueTx(() => this.contract.write.requestWithdrawal([erc20Token, value]));
+            hash = await this.enqueueTx(() => this.contract.write.requestWithdrawal([erc20Token, value], this.defaultFeeParams()));
         }
         else {
-            hash = await this.enqueueTx(() => this.contract.write.requestWithdrawal([value]));
+            hash = await this.enqueueTx(() => this.contract.write.requestWithdrawal([value], this.defaultFeeParams()));
         }
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
@@ -157,10 +182,10 @@ class ContractGateway {
         const { receipt } = this.splitWaitOptions(waitOptions);
         let hash;
         if (erc20Token) {
-            hash = await this.enqueueTx(() => this.contract.write.cancelWithdrawal([erc20Token]));
+            hash = await this.enqueueTx(() => this.contract.write.cancelWithdrawal([erc20Token], this.defaultFeeParams()));
         }
         else {
-            hash = await this.enqueueTx(() => this.contract.write.cancelWithdrawal());
+            hash = await this.enqueueTx(() => this.contract.write.cancelWithdrawal(this.defaultFeeParams()));
         }
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
@@ -168,10 +193,10 @@ class ContractGateway {
         const { receipt } = this.splitWaitOptions(waitOptions);
         let hash;
         if (erc20Token) {
-            hash = await this.enqueueTx(() => this.contract.write.finalizeWithdrawal([erc20Token]));
+            hash = await this.enqueueTx(() => this.contract.write.finalizeWithdrawal([erc20Token], this.defaultFeeParams()));
         }
         else {
-            hash = await this.enqueueTx(() => this.contract.write.finalizeWithdrawal());
+            hash = await this.enqueueTx(() => this.contract.write.finalizeWithdrawal(this.defaultFeeParams()));
         }
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
@@ -189,6 +214,7 @@ class ContractGateway {
         };
         const hash = await this.enqueueTx(() => this.contract.write.remunerate([(0, utils_1.hexFromBytes)(claimsBlob), sigStruct], {
             gas: gas ?? DEFAULT_REMUNERATE_GAS_LIMIT,
+            ...this.defaultFeeParams(),
         }));
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4mica/sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "TypeScript SDK for interacting with the 4Mica payment network",
   "license": "MIT",
   "repository": {
@@ -39,14 +39,19 @@
     "ethers"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "clean": "node -e \"require('node:fs').rmSync('dist',{ recursive: true, force: true })\"",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
     "test": "vitest run",
     "test:e2e": "vitest run --config vitest.e2e.config.ts",
+    "example:base-sepolia:x402-v2": "node_modules/.bin/tsx examples/base-sepolia-x402-facilitator-e2e.ts",
+    "example:manual:agents": "node_modules/.bin/tsx examples/manual-agents/demo.ts",
     "lint": "eslint . --ext .ts",
     "fmt": "prettier --check \"{src,tests}/**/*.{ts,js,json}\""
   },
   "dependencies": {
+    "@4mica/x402": "file:../x402-4mica/packages/typescript/x402",
     "@noble/curves": "^2.0.1",
+    "@quillai-network/wachai-validation-sdk": "^0.1.0",
     "viem": "^2.45.1"
   },
   "devDependencies": {