@zkp2p/pay-shared 4.0.1 → 6.0.0

package/dist/sandboxPricing.js

@@ -0,0 +1,53 @@
+import { computeDisplayedFiatAmount } from './fiatAmount.js';
+const MAX_RAIL_SPREAD = 0.03; // ±3% around the live FX rate
+const SPREAD_BUCKETS = 601; // integer granularity for the deterministic hash
+/**
+ * Applies a deterministic per-rail spread (±3%) on top of the live fiat-per-USD
+ * rate so sandbox quotes vary by payment method. The spread is hashed from the
+ * rail identifier + currency so refreshes are stable and different merchants
+ * see consistent rates, without any rail getting an unrealistic 0% spread.
+ */
+export function applySandboxRailSpread(baseRate, rail, currency) {
+    const seed = `${rail.trim().toLowerCase()}|${currency.trim().toUpperCase()}`;
+    let hash = 0;
+    for (let i = 0; i < seed.length; i += 1) {
+        hash = ((hash * 31) + seed.charCodeAt(i)) | 0;
+    }
+    const bucket = Math.abs(hash) % SPREAD_BUCKETS; // [0, 600]
+    const normalized = (bucket - (SPREAD_BUCKETS - 1) / 2) / ((SPREAD_BUCKETS - 1) / 2); // [-1, 1]
+    const spread = normalized * MAX_RAIL_SPREAD;
+    return baseRate * (1 + spread);
+}
+function decimalUnits(value, decimals) {
+    const [whole, fraction = ''] = value.split('.');
+    return BigInt(whole) * 10n ** BigInt(decimals) + BigInt(fraction.slice(0, decimals).padEnd(decimals, '0'));
+}
+function usdFromUnits(units) {
+    return `${units / 1000000n}.${(units % 1000000n).toString().padStart(6, '0')}`;
+}
+/** Deterministic sandbox maker spread and fee-share sizing, shared with the CLI. */
+export function buildSandboxSplitFiatAmounts(input) {
+    const rawRate = String(applySandboxRailSpread(Number(input.currencyPerUsdRate), input.rail, input.fiatCurrency));
+    const [whole, fraction = ''] = rawRate.split('.');
+    const conversionRate = fraction === '' ? whole : `${whole}.${fraction.slice(0, 6)}`;
+    const rate = decimalUnits(conversionRate, 18);
+    const peg = decimalUnits(input.currencyPerUsdRate, 18);
+    const share = BigInt(input.buyerFeeShareBps);
+    const denominator = (10000n - share) * rate * 10000n + share * (10000n - BigInt(input.totalReferralFeeBps)) * peg;
+    if (denominator <= 0n)
+        throw new Error('Split sandbox quote has no positive principal contribution');
+    const numerator = decimalUnits(input.principalUsd, 6) * 100000000n * peg;
+    const signalIntentAmountBaseUnits = ((numerator + denominator - 1n) / denominator).toString();
+    return { conversionRate, signalIntentAmountBaseUnits,
+        ...settleSandboxSplitFiatAmounts({ signalIntentAmountBaseUnits, conversionRateDecimal: conversionRate }) };
+}
+/** Preserve the saved signal for a full payment; scale a partial fiat payment at its saved maker rate. */
+export function settleSandboxSplitFiatAmounts(input) {
+    const paymentAmount = input.paidFiatAmount ?? computeDisplayedFiatAmount({
+        feePayer: 'SPLIT', signalIntentAmountBaseUnits: input.signalIntentAmountBaseUnits,
+        conversionRateDecimal: input.conversionRateDecimal, remainingUsdcAmount: '1', currencyPerUsdRate: '1', paymentAmountFallback: '0',
+    });
+    const grossUnits = input.paidFiatAmount === undefined ? BigInt(input.signalIntentAmountBaseUnits)
+        : decimalUnits(paymentAmount, 18) * 1000000n / decimalUnits(input.conversionRateDecimal, 18);
+    return { paymentAmount, grossUsdcAmount: usdFromUnits(grossUnits) };
+}

package/dist/tiers.d.ts

@@ -4,6 +4,8 @@ export declare const TierChangeSource: {
     readonly SELF_SERVE: "SELF_SERVE";
     readonly ADMIN: "ADMIN";
     readonly MIGRATION: "MIGRATION";
+    /** A Master Merchant Account sub-merchant copied its Master Merchant Account's tier at creation. */
+    readonly SUB_MERCHANT: "SUB_MERCHANT";
 };
 export type TierChangeSourceType = typeof TierChangeSource[keyof typeof TierChangeSource];
 /**
@@ -60,7 +62,7 @@ export declare function canUseScanToPay(input: {
     readonly environment: MerchantEnvironmentType;
 }): boolean;
 /**
- * Formats a tier's monthly caps for display. `volumeUsdc` is a whole-USDC decimal string;
+ * Formats a tier's monthly caps for display; caps count fiat-paid orders only. `volumeUsdc` is a whole-USDC decimal string;
  * exact thousands render as `$10K`, anything else as `$2,500`.
  */
 export declare function formatTierMonthlyLimitsCopy(limits: TierMonthlyLimits | null): string;

package/dist/tiers.js

@@ -3,6 +3,8 @@ export const TierChangeSource = {
     SELF_SERVE: 'SELF_SERVE',
     ADMIN: 'ADMIN',
     MIGRATION: 'MIGRATION',
+    /** A Master Merchant Account sub-merchant copied its Master Merchant Account's tier at creation. */
+    SUB_MERCHANT: 'SUB_MERCHANT',
 };
 export const TIER_DEFINITIONS = {
     BASE: {
@@ -50,7 +52,7 @@ export function canUseScanToPay(input) {
     return input.environment === 'SANDBOX' || input.tier === 'PRO' || input.tier === 'CONCIERGE';
 }
 /**
- * Formats a tier's monthly caps for display. `volumeUsdc` is a whole-USDC decimal string;
+ * Formats a tier's monthly caps for display; caps count fiat-paid orders only. `volumeUsdc` is a whole-USDC decimal string;
  * exact thousands render as `$10K`, anything else as `$2,500`.
  */
 export function formatTierMonthlyLimitsCopy(limits) {
@@ -61,5 +63,5 @@ export function formatTierMonthlyLimitsCopy(limits) {
     const volume = whole.length > 3 && /^\d+000$/.test(whole)
         ? `$${whole.slice(0, -3)}K`
         : `$${whole.replace(/\B(?=(\d{3})+(?!\d))/g, ',')}`;
-    return `Up to ${volume} volume and ${limits.orderCount} orders per month`;
+    return `Up to ${volume} fiat volume and ${limits.orderCount} fiat orders per month`;
 }