@swype-org/deposit 0.3.31 → 0.3.34

package/README.md

@@ -257,6 +257,30 @@ overflow.
 
 Your CSP needs `frame-src https://pay.blink.cash`.
 
+### Merchant balance
+
+If your users hold a balance on your platform, pass it on the request and the
+flow shows it under the deposit header — "Acme balance: $20.70" — so the user
+tops up with their number in view:
+
+```typescript
+await deposit.requestDeposit({
+  amount: null,
+  chainId: 8453,
+  address: userWalletAddress,
+  token: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+  balance: 20.7,            // USD — display only
+});
+```
+
+Display-only by design: the value is never part of the signed payload and never
+reaches your signer, so no signer changes are needed — and it cannot affect the
+transfer amount or destination. It must be a finite number, `>= 0` and below
+`1e12`; the SDK floors it to whole cents (`20.789` shows as `$20.78`). Anything
+else is dropped with a console error naming the field, and the deposit proceeds
+without the subtitle. When you don't pass it, Blink may fall back to showing
+the destination wallet's on-chain balance instead.
+
 ## Error Handling
 
 Every error is a `DepositError` with a machine-readable `code`:

package/dist/{chunk-HBW7IVRJ.js → chunk-24WCJE4H.js}

@@ -548,12 +548,14 @@ function parseWidthHint(key, value) {
 function buildRevealMessage() {
   return { type: "blink:reveal" };
 }
-function buildSignedPayloadMessage(merchantId, payload, signature) {
+function buildSignedPayloadMessage(merchantId, payload, signature, balance, minimumDeposit) {
   return {
     type: "blink:signed-payload",
     merchantId,
     payload,
-    signature
+    signature,
+    ...balance === void 0 ? {} : { balance },
+    ...minimumDeposit === void 0 ? {} : { minimumDeposit }
   };
 }
 
@@ -574,6 +576,26 @@ function normalizeBrandHex(value) {
   return `#${digits[0]}${digits[0]}${digits[1]}${digits[1]}${digits[2]}${digits[2]}`;
 }
 
+// src/balanceParam.ts
+var MAX_BALANCE_USD = 1e12;
+function normalizeDisplayBalance(value) {
+  if (typeof value !== "number" || !Number.isFinite(value)) return null;
+  if (value < 0 || value >= MAX_BALANCE_USD) return null;
+  const cents = Math.floor(Number((value * 100).toPrecision(15)));
+  if (cents < 0 || cents >= MAX_BALANCE_USD * 100) return null;
+  return (cents / 100).toFixed(2);
+}
+
+// src/minimumDepositParam.ts
+var MAX_MINIMUM_DEPOSIT_USD = 1e6;
+function normalizeMinimumDeposit(value) {
+  if (typeof value !== "number" || !Number.isFinite(value)) return null;
+  if (value <= 0 || value >= MAX_MINIMUM_DEPOSIT_USD) return null;
+  const cents = Math.ceil(Number((value * 100).toPrecision(15)));
+  if (cents <= 0 || cents >= MAX_MINIMUM_DEPOSIT_USD * 100) return null;
+  return (cents / 100).toFixed(2);
+}
+
 // src/viewportMetrics.ts
 function measureViewportMetrics() {
   const unavailable = { viewportLvh: 0, safeAreaBottom: 0 };
@@ -1571,6 +1593,53 @@ var Deposit = class {
     const encoded = Object.keys(BRAND_COLOR_PARAM_KEYS).filter((key) => accepted[key] !== void 0).map((key) => `${BRAND_COLOR_PARAM_KEYS[key]}-${accepted[key].slice(1)}`).join(".");
     if (encoded) url.searchParams.set("brand", encoded);
   }
+  /**
+   * Normalizes the display-only {@link DepositRequest.balance} for the wire,
+   * or returns `undefined` to omit it everywhere — the `blink:signed-payload`
+   * sibling field and the legacy fallback URL param alike. Additive wire
+   * discipline: an unset or rejected balance leaves both channels
+   * byte-for-byte what they always were, and old webviews ignore the field
+   * by construction.
+   *
+   * Validated here purely so the merchant sees the complaint in their OWN
+   * console (same rationale as {@link applyBrandParam}); the hosted flow
+   * re-validates whatever arrives, since both channels are host-controlled
+   * input. A rejected balance never blocks the deposit — the flow proceeds
+   * without the subtitle.
+   */
+  normalizeRequestBalance(balance) {
+    if (balance === void 0 || balance === null) return void 0;
+    const normalized = normalizeDisplayBalance(balance);
+    if (normalized === null) {
+      const received = typeof balance === "number" ? String(balance) : JSON.stringify(balance) ?? String(balance);
+      console.error(
+        `[blink] balance must be a finite number >= 0 and < 1e12 (USD, display only); received ${received}. Ignoring it.`
+      );
+      return void 0;
+    }
+    return normalized;
+  }
+  /**
+   * Normalizes {@link DepositRequest.minimumDeposit} for the wire, or returns
+   * `undefined` to omit it everywhere. Same additive discipline and same
+   * console-complaint rationale as {@link normalizeRequestBalance}.
+   *
+   * A rejected minimum never blocks the deposit — the flow proceeds on
+   * Blink's own per-route floor, which is the safe direction to fail: the
+   * merchant loses their higher floor, nobody is locked out of depositing.
+   */
+  normalizeRequestMinimumDeposit(minimumDeposit) {
+    if (minimumDeposit === void 0 || minimumDeposit === null) return void 0;
+    const normalized = normalizeMinimumDeposit(minimumDeposit);
+    if (normalized === null) {
+      const received = typeof minimumDeposit === "number" ? String(minimumDeposit) : JSON.stringify(minimumDeposit) ?? String(minimumDeposit);
+      console.error(
+        `[blink] minimumDeposit must be a finite number > 0 and < 1e6 (USD); received ${received}. Ignoring it.`
+      );
+      return void 0;
+    }
+    return normalized;
+  }
   /**
    * Fluid is the default; `layout: 'fixed'` opts back into the legacy
    * container. Embedded is a separate presentation and never fluid — the
@@ -1629,6 +1698,8 @@ var Deposit = class {
         signer: typeof this.config.signer === "string" ? this.config.signer : "<function>"
       });
       const signerRequest = buildSignerRequest(request, webviewBaseUrl);
+      const displayBalance = this.normalizeRequestBalance(request.balance);
+      const minimumDeposit = this.normalizeRequestMinimumDeposit(request.minimumDeposit);
       let preloadIframe;
       let iframeReadyPromise;
       const warm = this.takeWarmIframe();
@@ -1681,7 +1752,9 @@ var Deposit = class {
             buildSignedPayloadMessage(
               signerResponse.merchantId,
               signerResponse.payload,
-              signerResponse.signature
+              signerResponse.signature,
+              displayBalance,
+              minimumDeposit
             ),
             this.hostedOrigin
           );
@@ -1695,6 +1768,12 @@ var Deposit = class {
         hostedUrl.searchParams.set("merchantId", signerResponse.merchantId);
         hostedUrl.searchParams.set("payload", signerResponse.payload);
         hostedUrl.searchParams.set("signature", signerResponse.signature);
+        if (displayBalance !== void 0) {
+          hostedUrl.searchParams.set("balance", displayBalance);
+        }
+        if (minimumDeposit !== void 0) {
+          hostedUrl.searchParams.set("minDeposit", minimumDeposit);
+        }
         this.applyFullWidgetParam(hostedUrl);
         if (this.isEmbedded()) {
           this.applyLayoutParam(hostedUrl);
@@ -1867,5 +1946,5 @@ function detectMerchantColorScheme() {
 var Checkout = Deposit;
 
 export { ALLOWED_RPC_METHODS, BRIDGE_PROTOCOL_VERSION, Checkout, CheckoutError, DEFAULT_WEBVIEW_BASE_URL, Deposit, DepositError, SANDBOX_WEBVIEW_BASE_URL, attachRpcHost, createWalletDiscoverer, getDisplayMessage, parseBridgeMessage };
-//# sourceMappingURL=chunk-HBW7IVRJ.js.map
-//# sourceMappingURL=chunk-HBW7IVRJ.js.map
+//# sourceMappingURL=chunk-24WCJE4H.js.map
+//# sourceMappingURL=chunk-24WCJE4H.js.map