@fairblock/stabletrust 2.0.6 → 2.0.7

package/README.md

@@ -572,28 +572,15 @@ try {
 
 ### Common Issues and Solutions
 
-| Issue                          | Cause                                                   | Solution                                                |
-| :----------------------------- | :------------------------------------------------------ | :------------------------------------------------------ |
-| "Account does not exist"       | Recipient hasn't initialized their confidential account | Recipient must call `ensureAccount()` first             |
-| "Insufficient balance"         | Transfer amount exceeds available confidential balance  | Deposit more tokens or reduce transfer amount           |
-| "Account finalization timeout" | Account creation is still processing                    | Wait a few minutes and retry                            |
-| "Proof generation failed"      | Invalid inputs or cryptographic operation error         | Verify all parameters and ensure sufficient balance     |
-| "Amount too small"             | Amount rounds to 0 in contract scale                    | Use a larger amount (minimum depends on token decimals) |
+| Issue                              | Cause                                                                 | Solution                                                                                                            |
+| :--------------------------------- | :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------ |
+| "Account does not exist"           | Recipient hasn't initialized their confidential account               | Recipient must call `ensureAccount()` first                                                                         |
+| "Insufficient balance"             | Transfer amount exceeds available confidential balance                | Deposit more tokens or reduce transfer amount                                                                       |
+| "Account finalization timeout"     | Account creation is still processing                                  | Wait a few minutes and retry                                                                                        |
+| "Proof generation failed"          | Invalid inputs or cryptographic operation error                       | Verify all parameters and ensure sufficient balance                                                                 |
+| "Amount too small"                 | Amount rounds to 0 in contract scale                                  | Use a larger amount (minimum depends on token decimals)                                                             |
 | "Insufficient prepaid fee balance" | Anonymous account's prepaid fee reserve is below the per-transfer fee | Call `depositFees(wallet, accountId, amount)` to top up; use `getFeeToken()`/`getFeeAmount()` to check requirements |
-| Fairycloak HTTP error          | Relay unreachable or request rejected                   | Check the relay URL, API key, and account authorization |
-
----
-
-## Performance Metrics
-
-The following are estimated execution times for standard operations. Durations may vary based on network congestion and hardware.
-
-| Operation        | Avg Duration |
-| :--------------- | :----------- |
-| Account Creation | 45s          |
-| Deposit          | 63s          |
-| Transfer         | 58s          |
-| Withdraw         | 58s          |
+| Fairycloak HTTP error              | Relay unreachable or request rejected                                 | Check the relay URL, API key, and account authorization                                                             |
 
 ---
 

package/examples/anonymous-flow.js

@@ -24,7 +24,7 @@ dotenv.config();
 
 const EVM_RPC = process.env.EVM_RPC ?? "http://127.0.0.1:8545";
 const FAIRYCLOAK_URL = process.env.FAIRYCLOAK_URL ?? "http://127.0.0.1:8080";
-const CHAIN_ID = Number(process.env.CHAIN_ID ?? "31337");
+const CHAIN_ID = Number(process.env.CHAIN_ID ?? "5042002");
 const TOKEN_ADDRESS =
   process.env.TOKEN_ADDRESS ?? "0xE915164570b027C2A0FfadcB1B672192E35BF008";
 const TOKEN_DECIMALS = Number(process.env.TOKEN_DECIMALS ?? "6");
@@ -236,34 +236,39 @@ async function main() {
   log("  fee token  :", feeToken);
   log("  fee/xfer   :", fmt(feeAmount, TOKEN_DECIMALS), "tokens");
 
-  const feeBalance = await client.getPrepaidFeeBalance(anon1Id, feeToken);
-  log("  fee balance:", fmt(feeBalance, TOKEN_DECIMALS), "tokens");
-
-  if (feeBalance < MIN_FEE_BALANCE) {
-    log(
-      `  balance < ${fmt(MIN_FEE_BALANCE, TOKEN_DECIMALS)}, depositing ${fmt(FEE_DEPOSIT_AMOUNT, TOKEN_DECIMALS)} fee tokens (anon1 pays gas) …`,
-    );
-    const fd = await client.depositFees(
-      anon1Wallet,
-      anon1Id,
-      FEE_DEPOSIT_AMOUNT,
-    );
-    log("  request_id:", fd.request_id, "  status:", fd.status);
-    if (fd.error) log("    [!] Error:", fd.error);
-    if (fd.tx_hash) log("  tx_hash   :", fd.tx_hash);
-
-    const fdFinal = await client.waitForRequest(fd.request_id, {
-      timeoutMs: 180_000,
-    });
-    log("  status    :", fdFinal.status, "  tx_hash:", fdFinal.tx_hash ?? "—");
-    if (fdFinal.error) log("    [!] Error:", fdFinal.error);
-
-    const newFeeBalance = await client.getPrepaidFeeBalance(anon1Id, feeToken);
-    log("  new fee balance:", fmt(newFeeBalance, TOKEN_DECIMALS), "tokens");
+  if (feeAmount === 0n) {
+    log("  no fee configured — transactions are free, skipping top-up.");
   } else {
-    log(
-      `  fee balance sufficient (${fmt(feeBalance, TOKEN_DECIMALS)} ≥ ${fmt(MIN_FEE_BALANCE, TOKEN_DECIMALS)}), skipping deposit.`,
-    );
+    const feeBalance = await client.getPrepaidFeeBalance(anon1Id, feeToken);
+    log("  fee balance:", fmt(feeBalance, TOKEN_DECIMALS), "tokens");
+
+    if (feeBalance < MIN_FEE_BALANCE) {
+      const currency = feeToken === ethers.ZeroAddress ? "native" : "ERC-20";
+      log(
+        `  balance < ${fmt(MIN_FEE_BALANCE, TOKEN_DECIMALS)}, depositing ${fmt(FEE_DEPOSIT_AMOUNT, TOKEN_DECIMALS)} ${currency} fee tokens (anon1 pays gas) …`,
+      );
+      const fd = await client.depositFees(
+        anon1Wallet,
+        anon1Id,
+        FEE_DEPOSIT_AMOUNT,
+      );
+      log("  request_id:", fd.request_id, "  status:", fd.status);
+      if (fd.error) log("    [!] Error:", fd.error);
+      if (fd.tx_hash) log("  tx_hash   :", fd.tx_hash);
+
+      const fdFinal = await client.waitForRequest(fd.request_id, {
+        timeoutMs: 180_000,
+      });
+      log("  status    :", fdFinal.status, "  tx_hash:", fdFinal.tx_hash ?? "—");
+      if (fdFinal.error) log("    [!] Error:", fdFinal.error);
+
+      const newFeeBalance = await client.getPrepaidFeeBalance(anon1Id, feeToken);
+      log("  new fee balance:", fmt(newFeeBalance, TOKEN_DECIMALS), "tokens");
+    } else {
+      log(
+        `  fee balance sufficient (${fmt(feeBalance, TOKEN_DECIMALS)} ≥ ${fmt(MIN_FEE_BALANCE, TOKEN_DECIMALS)}), skipping deposit.`,
+      );
+    }
   }
 
   // ── [6] Transfer anon1 → anon2 ───────────────────────────────────────────────

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairblock/stabletrust",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "SDK for confidential transfers using homomorphic encryption and zero-knowledge proofs",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/anonymous-client.js

@@ -1488,8 +1488,6 @@ export class AnonymousTransferClient {
     ]);
     if (feeAmount === 0n) return; // no fee configured
 
-    if (feeToken === ethers.ZeroAddress) return; // fee token not set
-
     const balance = await this.getPrepaidFeeBalance(accountId, feeToken);
     if (balance < feeAmount) {
       throw new Error(
@@ -1534,45 +1532,51 @@ export class AnonymousTransferClient {
       if (amountBig <= 0n) throw new Error("Amount must be greater than 0");
 
       const feeToken = await this.getFeeToken();
-      if (feeToken === ethers.ZeroAddress)
-        throw new Error(
-          "No fee token is currently configured on the contract. Contact the protocol operator.",
-        );
+      const isNative = feeToken === ethers.ZeroAddress;
 
       const depositorAddress = await authWallet.getAddress();
       const walletWithProvider = authWallet.connect
         ? authWallet.connect(this.provider)
         : authWallet;
 
-      // 1. Approve if needed
-      const tokenContract = new ethers.Contract(
-        feeToken,
-        [
-          "function balanceOf(address) view returns (uint256)",
-          "function allowance(address,address) view returns (uint256)",
-          "function approve(address,uint256) returns (bool)",
-        ],
-        walletWithProvider,
-      );
+      if (isNative) {
+        // Native currency: check wallet balance, no ERC-20 approve needed
+        const balance = await this.provider.getBalance(depositorAddress);
+        if (balance < amountBig)
+          throw new Error(
+            `Insufficient native balance. Required: ${amountBig}, available: ${balance}`,
+          );
+      } else {
+        // ERC-20: approve if needed
+        const tokenContract = new ethers.Contract(
+          feeToken,
+          [
+            "function balanceOf(address) view returns (uint256)",
+            "function allowance(address,address) view returns (uint256)",
+            "function approve(address,uint256) returns (bool)",
+          ],
+          walletWithProvider,
+        );
 
-      const [balance, allowance] = await Promise.all([
-        tokenContract.balanceOf(depositorAddress),
-        tokenContract.allowance(depositorAddress, this.diamondAddress),
-      ]);
+        const [balance, allowance] = await Promise.all([
+          tokenContract.balanceOf(depositorAddress),
+          tokenContract.allowance(depositorAddress, this.diamondAddress),
+        ]);
 
-      if (balance < amountBig)
-        throw new Error(
-          `Insufficient fee token balance. Required: ${amountBig}, available: ${balance}`,
-        );
+        if (balance < amountBig)
+          throw new Error(
+            `Insufficient fee token balance. Required: ${amountBig}, available: ${balance}`,
+          );
 
-      if (allowance < amountBig) {
-        const approveTx = await tokenContract.approve(
-          this.diamondAddress,
-          ethers.MaxUint256,
-        );
-        const receipt = await approveTx.wait();
-        if (!receipt || receipt.status === 0)
-          throw new Error("Fee token approval failed");
+        if (allowance < amountBig) {
+          const approveTx = await tokenContract.approve(
+            this.diamondAddress,
+            ethers.MaxUint256,
+          );
+          const receipt = await approveTx.wait();
+          if (!receipt || receipt.status === 0)
+            throw new Error("Fee token approval failed");
+        }
       }
 
       // 2. EIP-712 AnonymousAddFees signature
@@ -1614,6 +1618,7 @@ export class AnonymousTransferClient {
         this.provider.getFeeData(),
       ]);
 
+      const txValue = isNative ? amountBig : 0n;
       let txObj;
       if (feeData.maxFeePerGas) {
         txObj = {
@@ -1624,7 +1629,7 @@ export class AnonymousTransferClient {
           gasLimit,
           maxFeePerGas: (feeData.maxFeePerGas * 12n) / 10n,
           maxPriorityFeePerGas: feeData.maxPriorityFeePerGas ?? 0n,
-          value: 0n,
+          value: txValue,
         };
       } else {
         txObj = {
@@ -1634,7 +1639,7 @@ export class AnonymousTransferClient {
           chainId: BigInt(this.chainId),
           gasLimit,
           gasPrice: (feeData.gasPrice * 11n) / 10n,
-          value: 0n,
+          value: txValue,
         };
       }