@zkp2p/cash 0.4.7 → 0.4.9

package/dist/index.cjs

@@ -498,7 +498,7 @@ function buildCapabilities(environment) {
       currencies: [...new Set(currencies2)].sort(),
       payeeHint: PAYEE_HINTS[platform] ?? "Your payment handle for this platform",
       requiresIdentityAttestation: IDENTITY_ATTESTATION_PLATFORMS.has(platform),
-      requiresAtomicAccessPolicy: CASH_RESTRICTED_PLATFORMS.has(platform)
+      requiresAtomicAccessPolicy: false
     };
   }).filter((p) => p.currencies.length > 0).sort((a, b) => a.platform.localeCompare(b.platform));
   const currencies = [...new Set(platforms.flatMap((p) => p.currencies))].sort();
@@ -676,15 +676,16 @@ var errors = {
       code: "PAYEE_VERIFICATION_REQUIRED",
       message: `${platform} requires a verified maker identity attestation to register a payee; a bare handle is not accepted.`,
       retryable: false,
-      remediation: `Register this ${platform} payee through the ZKP2P app / extension (which produces the signed identity attestation) before cashing out. capabilities() flags such platforms with requiresIdentityAttestation: true.`
+      remediation: `Register this ${platform} payee through Peer web and its TEE browser extension, which produces the signed identity attestation, before cashing out. capabilities() flags such platforms with requiresIdentityAttestation: true.`
     },
     { cause }
   ),
+  /** @deprecated Cash-outs no longer require an atomic access-policy flow. */
   atomicAccessPolicyRequired: (platforms) => new CashError({
     code: "ATOMIC_ACCESS_POLICY_REQUIRED",
-    message: `${platforms.join(", ")} cash-outs require atomic deposit creation and access-policy configuration.`,
+    message: `Atomic access-policy enforcement for ${platforms.join(", ")} is deprecated.`,
     retryable: false,
-    remediation: `Use Peer web or a host that atomically batches guard-before, createDeposit, guard-after, and configureDeposit. Nothing was submitted by this call.`
+    remediation: `Upgrade @zkp2p/cash; current cash-out flows do not require atomic access-policy configuration.`
   }),
   sourceRouteUnsupportedInPrepare: () => new CashError({
     code: "SOURCE_ROUTE_UNSUPPORTED_IN_PREPARE",
@@ -887,20 +888,28 @@ var errors = {
     },
     { cause }
   ),
-  accessPolicyConfigurationFailed: (depositId, groupIds, cause, transactionHash) => new CashError(
+  accessPolicyConfigurationFailed: (depositId, groupIds, context = {}) => new CashError(
     {
       code: "ACCESS_POLICY_CONFIGURATION_FAILED",
-      message: `Cash-out deposit ${depositId} was created, but its required access policy was not confirmed.`,
+      message: `Cash-out deposit ${depositId} was created, but its access policy could not be confirmed.`,
       retryable: false,
-      remediation: `Do not call cashout() again. Inspect the existing deposit and any access-policy transaction, then configure that deposit with recovery.groupIds through @zkp2p/sdk accessPolicy.`,
+      remediation: `Do not create another cash-out. If recovery.transactionHash is present, inspect that policy transaction first. Otherwise, or if it is confirmed reverted, submit and confirm prepareAccessPolicy(recovery.depositId) with the same depositor wallet.`,
       recovery: {
         kind: "configure-cashout-access-policy",
         depositId,
         groupIds: [...groupIds],
-        ...transactionHash ? { transactionHash } : {}
+        ...context.transactionHash ? { transactionHash: context.transactionHash } : {},
+        ...context.source ? {
+          source: {
+            amount: context.source.amount.toString(),
+            ...context.source.requestId ? { requestId: context.source.requestId } : {},
+            txHashes: context.source.txHashes,
+            ...context.source.transactions ? { transactions: context.source.transactions } : {}
+          }
+        } : {}
       }
     },
-    { cause }
+    { cause: context.cause }
   ),
   escrowPaused: () => new CashError({
     code: "ESCROW_PAUSED",
@@ -1786,6 +1795,11 @@ async function submitAndConfirm(client, verb, send) {
 function isKnownPreBroadcastFailure(mapped) {
   return mapped.code === "TRANSACTION_REJECTED" || mapped.code === "INSUFFICIENT_TOKEN_BALANCE" || mapped.code === "ALLOWANCE_NOT_VISIBLE" || mapped.code === "ESCROW_PAUSED";
 }
+function requiresCashoutAccessPolicy(depositInput) {
+  return depositInput.payouts.some(
+    (payout) => CASH_RESTRICTED_PLATFORMS.has(payout.processorName.toLowerCase())
+  );
+}
 function depositOrderOptions(deposit) {
   const remaining = toBigIntOrUndefined(deposit.remainingDeposits);
   const outstanding = toBigIntOrUndefined(deposit.outstandingIntentAmount);
@@ -1917,12 +1931,6 @@ function createCashClient(options) {
       ...range ? { intentAmountRange: range } : {}
     };
   }
-  function assertGenericCashoutSupported(payoutInput) {
-    const restrictedPlatforms = payoutInput.payouts.map((payout) => payout.processorName.toLowerCase()).filter((platform) => CASH_RESTRICTED_PLATFORMS.has(platform));
-    if (restrictedPlatforms.length > 0) {
-      throw errors.atomicAccessPolicyRequired(restrictedPlatforms);
-    }
-  }
   function isCashPayoutSet(payouts) {
     return payouts.length > 0 && payouts.every((payout) => payout.pricing.marketRate && payout.pricing.spreadBps === 0);
   }
@@ -2162,7 +2170,7 @@ function createCashClient(options) {
     if (lastNonceError) throw lastNonceError;
     throw new Error(`Signer provider did not observe Relay nonce ${afterRelay - 1}`);
   }
-  function prepareCashoutAccess(depositId, client = readClient) {
+  function prepareCashoutAccess(depositId, client = readClient, source) {
     const { compositeId, escrowAddress, onchainDepositId } = parseDepositId(depositId);
     const groupIds = CASH_ACCESS_GROUP_IDS[environment];
     try {
@@ -2181,9 +2189,50 @@ function createCashClient(options) {
         chainId: prepared.chainId
       };
     } catch (err) {
-      throw errors.accessPolicyConfigurationFailed(compositeId, groupIds, err);
+      throw errors.accessPolicyConfigurationFailed(compositeId, groupIds, {
+        cause: err,
+        ...source ? { source } : {}
+      });
     }
   }
+  async function configureCashoutAccess(client, signer, depositInput, depositId, source) {
+    if (!requiresCashoutAccessPolicy(depositInput)) return void 0;
+    const groupIds = CASH_ACCESS_GROUP_IDS[environment];
+    const prepared = prepareCashoutAccess(depositId, client, source);
+    let hash;
+    try {
+      hash = await signer.sendTransaction({
+        account: signer.account,
+        chain: signer.chain,
+        to: prepared.to,
+        data: prepared.data,
+        value: prepared.value
+      });
+    } catch (err) {
+      throw errors.accessPolicyConfigurationFailed(depositId, groupIds, {
+        cause: err,
+        ...source ? { source } : {}
+      });
+    }
+    let receipt;
+    try {
+      receipt = await client.publicClient.waitForTransactionReceipt({ hash });
+    } catch (err) {
+      throw errors.accessPolicyConfigurationFailed(depositId, groupIds, {
+        cause: err,
+        transactionHash: hash,
+        ...source ? { source } : {}
+      });
+    }
+    if (receipt.status === "reverted") {
+      throw errors.accessPolicyConfigurationFailed(depositId, groupIds, {
+        cause: errors.transactionFailed(hash),
+        transactionHash: hash,
+        ...source ? { source } : {}
+      });
+    }
+    return hash;
+  }
   return {
     capabilities,
     async sourceCapabilities() {
@@ -2221,11 +2270,8 @@ function createCashClient(options) {
     },
     async cashout(input, opts) {
       const payoutInput = validatePayout(input);
-      assertGenericCashoutSupported(payoutInput);
       const client = await signingClient("cashout", opts);
       const owner = opts.signer.account.address;
-      let sourceResult;
-      let cashoutAmount = input.amount;
       if (input.source) {
         const sourceSigner = opts.sourceSigner ?? (input.source.chainId === BASE_CHAIN_ID ? opts.signer : void 0);
         if (!sourceSigner?.account) throw errors.signerRequired("source cashout");
@@ -2246,7 +2292,7 @@ function createCashClient(options) {
         if (relayQuote.outputAmount < MIN_CASHOUT_AMOUNT) {
           throw errors.amountBelowMinimum(relayQuote.outputAmount, MIN_CASHOUT_AMOUNT);
         }
-        cashoutAmount = relayQuote.outputAmount;
+        const cashoutAmount = relayQuote.outputAmount;
         const depositInput2 = validateDepositInput(cashoutAmount, input, payoutInput);
         const params2 = await buildDepositParams(client, depositInput2);
         const escrow2 = client.escrowV2Address ?? client.escrowAddress;
@@ -2263,7 +2309,6 @@ function createCashClient(options) {
           txHashes: executed.txHashes,
           ...executed.transactions ? { transactions: executed.transactions } : {}
         };
-        sourceResult = routedSource;
         try {
           await waitForBaseSignerAfterRelay(
             client,
@@ -2319,6 +2364,13 @@ function createCashClient(options) {
         const abi2 = client.escrowV2Abi ?? client.escrowAbi;
         const resolved2 = resolveCashDepositId({ logs: receipt2.logs, abi: abi2 });
         if (!resolved2) throw errors.depositResolutionFailed(hash2);
+        const accessPolicyTxHash2 = await configureCashoutAccess(
+          client,
+          opts.signer,
+          depositInput2,
+          resolved2.compositeId,
+          routedSource
+        );
         const order2 = deriveCashOrder(resolved2.compositeId, [], {
           remainingAmount: depositInput2.amount,
           status: "ACTIVE"
@@ -2329,6 +2381,7 @@ function createCashClient(options) {
           escrowAddress: resolved2.escrowAddress,
           onchainDepositId: resolved2.onchainDepositId,
           order: order2,
+          ...accessPolicyTxHash2 ? { accessPolicyTxHash: accessPolicyTxHash2 } : {},
           source: routedSource
         };
       }
@@ -2373,6 +2426,12 @@ function createCashClient(options) {
       const abi = client.escrowV2Abi ?? client.escrowAbi;
       const resolved = resolveCashDepositId({ logs: receipt.logs, abi });
       if (!resolved) throw errors.depositResolutionFailed(hash);
+      const accessPolicyTxHash = await configureCashoutAccess(
+        client,
+        opts.signer,
+        depositInput,
+        resolved.compositeId
+      );
       const order = deriveCashOrder(resolved.compositeId, [], {
         remainingAmount: depositInput.amount,
         status: "ACTIVE"
@@ -2383,13 +2442,12 @@ function createCashClient(options) {
         escrowAddress: resolved.escrowAddress,
         onchainDepositId: resolved.onchainDepositId,
         order,
-        ...sourceResult ? { source: sourceResult } : {}
+        ...accessPolicyTxHash ? { accessPolicyTxHash } : {}
       };
     },
     async prepare(input) {
       if (input.source) throw errors.sourceRouteUnsupportedInPrepare();
       const depositInput = validateDepositInput(input.amount, input);
-      assertGenericCashoutSupported(depositInput);
       const params = await buildDepositParams(readClient, depositInput);
       const { prepared } = await readClient.prepareCreateDeposit({
         ...params,
@@ -2422,7 +2480,7 @@ function createCashClient(options) {
           }
         ],
         register: { hashedOnchainIds },
-        accessPolicyRequired: false
+        accessPolicyRequired: requiresCashoutAccessPolicy(depositInput)
       };
     },
     finalizePreparedCashout(receipt) {
@@ -3049,7 +3107,8 @@ var cashErrorRecoveryJsonSchema = zod.z.discriminatedUnion("kind", [
     kind: zod.z.literal("configure-cashout-access-policy"),
     depositId: zod.z.string(),
     groupIds: zod.z.array(zod.z.string()),
-    transactionHash: zod.z.string().optional()
+    transactionHash: zod.z.string().optional(),
+    source: zod.z.object(cashSourceRecoveryJsonShape).strict().optional()
   }).strict()
 ]);
 var cashErrorJsonSchema = zod.z.object({
@@ -3377,6 +3436,10 @@ function topUpResultFromJson(json) {
 function capabilitiesToJson(caps) {
   return {
     ...caps,
+    platforms: caps.platforms.map((platform) => ({
+      ...platform,
+      requiresAtomicAccessPolicy: false
+    })),
     amount: {
       min: caps.amount.min.toString(),
       recommendedMin: caps.amount.recommendedMin.toString(),
@@ -3395,7 +3458,7 @@ function capabilitiesFromJson(json) {
     platforms: parsed.platforms.map((p) => ({
       ...p,
       currencies: p.currencies,
-      requiresAtomicAccessPolicy: p.requiresAtomicAccessPolicy ?? CASH_RESTRICTED_PLATFORMS.has(p.platform)
+      requiresAtomicAccessPolicy: false
     })),
     currencies: parsed.currencies,
     amount: {
@@ -3429,7 +3492,15 @@ function cashErrorFromJson(json) {
         kind: parsed.recovery.kind,
         depositId: parsed.recovery.depositId,
         groupIds: parsed.recovery.groupIds,
-        ...parsed.recovery.transactionHash !== void 0 ? { transactionHash: parsed.recovery.transactionHash } : {}
+        ...parsed.recovery.transactionHash !== void 0 ? { transactionHash: parsed.recovery.transactionHash } : {},
+        ...parsed.recovery.source !== void 0 ? {
+          source: {
+            amount: parsed.recovery.source.amount,
+            txHashes: parsed.recovery.source.txHashes,
+            ...parsed.recovery.source.requestId !== void 0 ? { requestId: parsed.recovery.source.requestId } : {},
+            ...parsed.recovery.source.transactions !== void 0 ? { transactions: parsed.recovery.source.transactions } : {}
+          }
+        } : {}
       };
     } else if (parsed.recovery.kind === "inspect-base-operation-submission") {
       recovery = {