@4mica/sdk 1.2.2 → 1.2.5

package/dist/client/user.d.ts

@@ -32,7 +32,9 @@ export declare class UserClient {
      *   locked collateral and any pending withdrawal.
      * @throws {@link ContractError} if the contract call fails.
      */
-    getUser(): Promise<UserInfo[]>;
+    getUser(opts?: {
+        blockNumber?: bigint;
+    }): Promise<UserInfo[]>;
     /**
      * Query the on-chain payment status of a tab.
      *

package/dist/client/user.js

@@ -43,8 +43,8 @@ class UserClient {
      *   locked collateral and any pending withdrawal.
      * @throws {@link ContractError} if the contract call fails.
      */
-    async getUser() {
-        const assets = await this.client.gateway.getUserAssets();
+    async getUser(opts) {
+        const assets = await this.client.gateway.getUserAssets(opts);
         return assets.map((a) => ({
             asset: a.asset,
             collateral: (0, utils_1.parseU256)(a.collateral),

package/dist/config.d.ts

@@ -48,15 +48,15 @@ export declare class ConfigBuilder {
      * Resolves to the corresponding core API URL.
      * Mutually exclusive with {@link rpcUrl} — last call wins.
      *
-     * Supported values: `"base-sepolia"` / `"eip155:84532"`,
+     * Supported values: `"base"` / `"eip155:8453"`, `"base-sepolia"` / `"eip155:84532"`,
      * `"ethereum-sepolia"` / `"eip155:11155111"`.
      *
      * @throws {@link ConfigError} if the network is not recognised.
      *
      * @example
      * ```ts
-     * new ConfigBuilder().network("base-sepolia").walletPrivateKey("0x...").build();
-     * new ConfigBuilder().network("eip155:84532").walletPrivateKey("0x...").build();
+     * new ConfigBuilder().network("base").walletPrivateKey("0x...").build();
+     * new ConfigBuilder().network("eip155:8453").walletPrivateKey("0x...").build();
      * ```
      */
     network(value: string): ConfigBuilder;
@@ -82,7 +82,7 @@ export declare class ConfigBuilder {
      * Load configuration from environment variables.
      *
      * Recognised variables:
-     * - `4MICA_NETWORK` — shorthand or CAIP-2 id (e.g. `base-sepolia`); takes precedence over `4MICA_RPC_URL`
+     * - `4MICA_NETWORK` — shorthand or CAIP-2 id (e.g. `base`); takes precedence over `4MICA_RPC_URL`
      * - `4MICA_RPC_URL`
      * - `4MICA_WALLET_PRIVATE_KEY`
      * - `4MICA_ETHEREUM_HTTP_RPC_URL`

package/dist/config.js

@@ -38,21 +38,21 @@ class ConfigBuilder {
      * Resolves to the corresponding core API URL.
      * Mutually exclusive with {@link rpcUrl} — last call wins.
      *
-     * Supported values: `"base-sepolia"` / `"eip155:84532"`,
+     * Supported values: `"base"` / `"eip155:8453"`, `"base-sepolia"` / `"eip155:84532"`,
      * `"ethereum-sepolia"` / `"eip155:11155111"`.
      *
      * @throws {@link ConfigError} if the network is not recognised.
      *
      * @example
      * ```ts
-     * new ConfigBuilder().network("base-sepolia").walletPrivateKey("0x...").build();
-     * new ConfigBuilder().network("eip155:84532").walletPrivateKey("0x...").build();
+     * new ConfigBuilder().network("base").walletPrivateKey("0x...").build();
+     * new ConfigBuilder().network("eip155:8453").walletPrivateKey("0x...").build();
      * ```
      */
     network(value) {
         const url = (0, networks_1.resolveNetworkRpcUrl)(value);
         if (!url) {
-            throw new errors_1.ConfigError(`unknown network "${value}". Use a known shorthand (e.g. "base-sepolia") or CAIP-2 id, or call rpcUrl() directly.`);
+            throw new errors_1.ConfigError(`unknown network "${value}". Use a known shorthand (e.g. "base") or CAIP-2 id, or call rpcUrl() directly.`);
         }
         this._rpcUrl = url;
         return this;
@@ -108,7 +108,7 @@ class ConfigBuilder {
      * Load configuration from environment variables.
      *
      * Recognised variables:
-     * - `4MICA_NETWORK` — shorthand or CAIP-2 id (e.g. `base-sepolia`); takes precedence over `4MICA_RPC_URL`
+     * - `4MICA_NETWORK` — shorthand or CAIP-2 id (e.g. `base`); takes precedence over `4MICA_RPC_URL`
      * - `4MICA_RPC_URL`
      * - `4MICA_WALLET_PRIVATE_KEY`
      * - `4MICA_ETHEREUM_HTTP_RPC_URL`
@@ -122,7 +122,7 @@ class ConfigBuilder {
         const env = process.env;
         if (env['4MICA_NETWORK'])
             this.network(env['4MICA_NETWORK']);
-        if (env['4MICA_RPC_URL'])
+        else if (env['4MICA_RPC_URL'])
             this._rpcUrl = env['4MICA_RPC_URL'];
         if (env['4MICA_WALLET_PRIVATE_KEY'])
             this._walletPrivateKey = env['4MICA_WALLET_PRIVATE_KEY'];

package/dist/contract.d.ts

@@ -31,7 +31,9 @@ export declare class ContractGateway {
     }>;
     approveErc20(token: string, amount: number | bigint | string, waitOptions?: TxReceiptWaitOptions): Promise<import("viem").TransactionReceipt>;
     deposit(amount: number | bigint | string, erc20Token?: string, waitOptions?: TxReceiptWaitOptions): Promise<import("viem").TransactionReceipt>;
-    getUserAssets(): Promise<{
+    getUserAssets(opts?: {
+        blockNumber?: bigint;
+    }): Promise<{
         asset: `0x${string}`;
         collateral: bigint;
         withdrawalRequestTimestamp: bigint;

package/dist/contract.js

@@ -6,6 +6,22 @@ const core4mica_1 = require("./abi/core4mica");
 const chain_1 = require("./chain");
 const errors_1 = require("./errors");
 const utils_1 = require("./utils");
+/**
+ * Extract a human-readable message from a viem contract error, falling back
+ * to the raw message if no structured reason is available.
+ */
+function wrapViemError(error, context) {
+    if (error instanceof errors_1.ContractError)
+        return error;
+    if (error instanceof Error) {
+        const e = error;
+        const reason = e['cause']?.['reason'] ??
+            e['shortMessage'] ??
+            error.message;
+        return new errors_1.ContractError(`${context}: ${reason}`);
+    }
+    return new errors_1.ContractError(`${context}: ${String(error)}`);
+}
 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');
@@ -100,36 +116,82 @@ class ContractGateway {
             }
             return txReceipt;
         };
+        let txReceipt;
         try {
-            return await sendApprove(targetAllowance);
+            txReceipt = await sendApprove(targetAllowance);
         }
         catch (error) {
-            // Some ERC20s require resetting allowance to zero before setting a new value.
+            // Some ERC20s (e.g. USDT) require resetting allowance to zero before
+            // setting a new non-zero value.
             if (targetAllowance === 0n) {
-                throw error;
+                throw wrapViemError(error, 'ERC20 approve failed');
+            }
+            try {
+                await sendApprove(0n);
+                txReceipt = await sendApprove(targetAllowance);
+            }
+            catch (retryError) {
+                throw wrapViemError(retryError, 'ERC20 approve failed after allowance reset');
             }
-            await sendApprove(0n);
-            return sendApprove(targetAllowance);
         }
+        // Verify the allowance was actually set on-chain. The catch path above can
+        // leave allowance at 0 if the re-approve transaction fails silently.
+        // Read at the confirmed block number so the result is consistent regardless
+        // of RPC node propagation lag.
+        const account = this.walletClient.account;
+        if (account) {
+            const actual = (await erc20.read.allowance([account.address, spender], {
+                blockNumber: txReceipt.blockNumber,
+            }));
+            if (actual < targetAllowance) {
+                throw new errors_1.ContractError(`ERC20 allowance verification failed: on-chain allowance is ${actual} but expected ${targetAllowance}. ` +
+                    `Try calling approveErc20 again.`);
+            }
+        }
+        return txReceipt;
     }
     async deposit(amount, erc20Token, waitOptions) {
         const { receipt } = this.splitWaitOptions(waitOptions);
+        const parsedAmount = (0, utils_1.parseU256)(amount);
         let hash;
         if (erc20Token) {
-            hash = await this.enqueueTx(() => this.contract.write.depositStablecoin([erc20Token, (0, utils_1.parseU256)(amount)], this.defaultFeeParams()));
+            // Pre-check allowance to surface a clear error before hitting the contract.
+            const account = this.walletClient.account;
+            if (account) {
+                const erc20 = this.erc20(erc20Token);
+                const allowance = await erc20.read.allowance([
+                    account.address,
+                    this.contract.address,
+                ]);
+                if (allowance < parsedAmount) {
+                    throw new errors_1.ContractError(`Insufficient ERC20 allowance: ${allowance} approved but ${parsedAmount} required. ` +
+                        `Call approveErc20("${erc20Token}", ${parsedAmount}) before depositing.`);
+                }
+            }
+            try {
+                hash = await this.enqueueTx(() => this.contract.write.depositStablecoin([erc20Token, parsedAmount], this.defaultFeeParams()));
+            }
+            catch (error) {
+                throw wrapViemError(error, 'depositStablecoin failed');
+            }
         }
         else {
-            hash = await this.enqueueTx(() => this.contract.write.deposit({ value: (0, utils_1.parseU256)(amount), ...this.defaultFeeParams() }));
+            try {
+                hash = await this.enqueueTx(() => this.contract.write.deposit({ value: parsedAmount, ...this.defaultFeeParams() }));
+            }
+            catch (error) {
+                throw wrapViemError(error, 'deposit failed');
+            }
         }
         return this.publicClient.waitForTransactionReceipt({ hash, ...receipt });
     }
-    async getUserAssets() {
+    async getUserAssets(opts) {
         const account = this.walletClient.account;
         if (!account) {
             throw new errors_1.ContractError('wallet client has no account configured');
         }
         const addr = account.address;
-        const result = await this.contract.read.getUserAllAssets([addr]);
+        const result = await this.contract.read.getUserAllAssets([addr], opts);
         return result.map((a) => ({
             asset: a.asset,
             collateral: a.collateral,

package/dist/networks.d.ts

@@ -17,12 +17,12 @@ export interface NetworkInfo {
  *
  * // By shorthand
  * const cfg = new ConfigBuilder()
- *   .network("base-sepolia")
+ *   .network("base")
  *   .walletPrivateKey("0x...")
  *   .build();
  *
  * // Inspect available networks
- * console.log(NETWORKS["base-sepolia"].caip2); // "eip155:84532"
+ * console.log(NETWORKS["base"].caip2); // "eip155:8453"
  * ```
  */
 export declare const NETWORKS: Record<string, NetworkInfo>;
@@ -32,8 +32,8 @@ export declare const NETWORKS: Record<string, NetworkInfo>;
  *
  * @example
  * ```ts
- * resolveNetworkRpcUrl("base-sepolia");   // "https://base.sepolia.api.4mica.xyz/"
- * resolveNetworkRpcUrl("eip155:84532");   // "https://base.sepolia.api.4mica.xyz/"
+ * resolveNetworkRpcUrl("base");           // "https://base.api.4mica.xyz/"
+ * resolveNetworkRpcUrl("eip155:8453");    // "https://base.api.4mica.xyz/"
  * resolveNetworkRpcUrl("eip155:1");       // undefined
  * ```
  */

package/dist/networks.js

@@ -14,15 +14,19 @@ exports.resolveNetworkRpcUrl = resolveNetworkRpcUrl;
  *
  * // By shorthand
  * const cfg = new ConfigBuilder()
- *   .network("base-sepolia")
+ *   .network("base")
  *   .walletPrivateKey("0x...")
  *   .build();
  *
  * // Inspect available networks
- * console.log(NETWORKS["base-sepolia"].caip2); // "eip155:84532"
+ * console.log(NETWORKS["base"].caip2); // "eip155:8453"
  * ```
  */
 exports.NETWORKS = {
+    base: {
+        caip2: 'eip155:8453',
+        rpcUrl: 'https://base.api.4mica.xyz/',
+    },
     'base-sepolia': {
         caip2: 'eip155:84532',
         rpcUrl: 'https://base.sepolia.api.4mica.xyz/',
@@ -39,8 +43,8 @@ const NETWORKS_BY_CAIP2 = Object.fromEntries(Object.values(exports.NETWORKS).map
  *
  * @example
  * ```ts
- * resolveNetworkRpcUrl("base-sepolia");   // "https://base.sepolia.api.4mica.xyz/"
- * resolveNetworkRpcUrl("eip155:84532");   // "https://base.sepolia.api.4mica.xyz/"
+ * resolveNetworkRpcUrl("base");           // "https://base.api.4mica.xyz/"
+ * resolveNetworkRpcUrl("eip155:8453");    // "https://base.api.4mica.xyz/"
  * resolveNetworkRpcUrl("eip155:1");       // undefined
  * ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4mica/sdk",
-  "version": "1.2.2",
+  "version": "1.2.5",
   "description": "TypeScript SDK for interacting with the 4Mica payment network",
   "license": "MIT",
   "repository": {
@@ -45,6 +45,9 @@
     "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",
+    "example:wachai:v2": "node_modules/.bin/tsx examples/wachai-v2-demo/demo.ts",
+    "example:deposit": "node_modules/.bin/tsx examples/deposit.ts",
+    "example:yield": "node_modules/.bin/tsx examples/yield.ts",
     "lint": "eslint . --ext .ts",
     "fmt": "prettier --check \"{src,tests}/**/*.{ts,js,json}\""
   },