@phala/pay 0.8.3 → 0.9.0

package/src/server/index.ts

@@ -1,38 +0,0 @@
-/**
- * Server-side helpers of `@phala/pay`. Nothing here needs or takes an API key: webhook
- * verification uses your account's public webhook key, and the address and sweep helpers run
- * offline. Call the API itself from your backend with a restricted key (the Python SDK, or any
- * HTTP client with `Authorization: Bearer ppay_rk_…`); never ship a key to a browser. Recompute
- * every address with `verifyQuoteAddress` or `verifyDepositAddress` from the pins you configure
- * yourself before you show it.
- */
-export {
-  WebhookSignatureError,
-  constructEvent,
-  type ConstructEventOptions,
-  type WebhookEvent,
-} from "./webhook.js";
-export {
-  AddressMismatchError,
-  depositAddress,
-  depositAddressSalt,
-  forwarderAddress,
-  quoteSalt,
-  quoteAddress,
-  verifyDepositAddress,
-  verifyQuoteAddress,
-  type AddressPins,
-  type Forwarder,
-} from "./addresses.js";
-export {
-  batchChecksum,
-  flushTransaction,
-  flushTransactions,
-  safeBatch,
-  type BatchFile,
-  type BatchFileMeta,
-  type BatchTransaction,
-  type Call,
-  type ForwarderObject,
-  type SafeBatchOptions,
-} from "./sweeps.js";

package/src/server/sweeps.ts

@@ -1,197 +0,0 @@
-import {
-  encodeFunctionData,
-  getAddress,
-  isHex,
-  keccak256,
-  stringToBytes,
-  type Address,
-  type Hex,
-} from "viem";
-
-const FLUSH_ABI = [
-  {
-    type: "function",
-    name: "flush",
-    stateMutability: "nonpayable",
-    inputs: [
-      { name: "treasury", type: "address" },
-      { name: "salts", type: "bytes32[]" },
-      { name: "token", type: "address" },
-    ],
-    outputs: [],
-  },
-] as const;
-
-/** A contract call as a wallet or the Safe Transaction Builder takes it. */
-export interface Call {
-  to: Address;
-  data: Hex;
-  /** Native value in wei, a decimal string: `"0"` for a flush. */
-  value: string;
-}
-
-/**
- * `factory.flush(treasury, salts, token)`, encoded offline from the exported forwarders
- * (`GET /v1/forwarders`): every listed forwarder's whole balance of `token` moves to `treasury`,
- * the only address it can pay. Anyone may send it; the sender pays the gas.
- */
-export function flushTransaction(
-  factory: string,
-  treasury: string,
-  salts: readonly Hex[],
-  token: string,
-): Call {
-  if (salts.length === 0) {
-    throw new TypeError("flush needs at least one salt");
-  }
-  if (!salts.every((salt) => isHex(salt) && salt.length === 66)) {
-    throw new TypeError("a salt is 32 bytes of hex");
-  }
-  return {
-    to: getAddress(factory),
-    data: encodeFunctionData({
-      abi: FLUSH_ABI,
-      functionName: "flush",
-      args: [getAddress(treasury), salts, getAddress(token)],
-    }),
-    value: "0",
-  };
-}
-
-/** A forwarder as `GET /v1/forwarders` returns it. */
-export interface ForwarderObject {
-  chain_id: number;
-  factory: string;
-  treasury: string;
-  salt: string;
-}
-
-/**
- * Groups forwarders of one chain, such as `GET /v1/forwarders?sweepable=<token>` lists, into
- * `flushTransaction` calls: one per factory and treasury, of at most `maxSalts` forwarders.
- */
-export function flushTransactions(
-  forwarders: Iterable<ForwarderObject>,
-  token: string,
-  maxSalts = 200,
-): Call[] {
-  const groups = new Map<string, { factory: string; treasury: string; salts: Hex[] }>();
-  const chains = new Set<number>();
-  for (const forwarder of forwarders) {
-    chains.add(forwarder.chain_id);
-    const factory = getAddress(forwarder.factory);
-    const treasury = getAddress(forwarder.treasury);
-    const key = `${factory}:${treasury}`;
-    const group = groups.get(key) ?? { factory, treasury, salts: [] };
-    if (!isHex(forwarder.salt)) {
-      throw new TypeError("a salt is 32 bytes of hex");
-    }
-    group.salts.push(forwarder.salt);
-    groups.set(key, group);
-  }
-  if (chains.size > 1) {
-    throw new TypeError("a batch of flush calls is for one chain");
-  }
-  const calls: Call[] = [];
-  for (const { factory, treasury, salts } of groups.values()) {
-    for (let start = 0; start < salts.length; start += maxSalts) {
-      calls.push(flushTransaction(factory, treasury, salts.slice(start, start + maxSalts), token));
-    }
-  }
-  return calls;
-}
-
-/**
- * The Safe Transaction Builder's batch file, its `BatchFile` type
- * (safe-global/safe-react-apps, `apps/tx-builder/src/typings/models.ts` at commit
- * e8cccfb9a1042fa2954087988bae59c3b8c81780).
- */
-export interface BatchFile {
-  version: string;
-  chainId: string;
-  createdAt: number;
-  meta: BatchFileMeta;
-  transactions: BatchTransaction[];
-}
-
-export interface BatchFileMeta {
-  txBuilderVersion?: string;
-  checksum?: string;
-  createdFromSafeAddress?: string;
-  createdFromOwnerAddress?: string;
-  name: string;
-  description?: string;
-}
-
-export interface BatchTransaction {
-  to: string;
-  value: string;
-  data?: string;
-  contractMethod?: { inputs: unknown[]; name: string; payable: boolean };
-  contractInputsValues?: { [key: string]: string };
-}
-
-export interface SafeBatchOptions {
-  name?: string;
-  description?: string;
-  /** Milliseconds; now by default. */
-  createdAt?: number;
-}
-
-/**
- * A Transaction Builder batch file of `calls` for the Safe `safe` on `chainId`, with the app's
- * `meta.checksum`, so it imports without the "modified since it was generated" warning. A Safe
- * owner imports it in Safe{Wallet} > Apps > Transaction Builder; the owners sign and execute it.
- */
-export function safeBatch(
-  chainId: number,
-  safe: string,
-  calls: readonly Call[],
-  options: SafeBatchOptions = {},
-): BatchFile {
-  if (calls.length === 0) {
-    throw new TypeError("a batch needs at least one call");
-  }
-  const batch: BatchFile = {
-    version: "1.0",
-    chainId: String(chainId),
-    createdAt: options.createdAt ?? Date.now(),
-    meta: {
-      name: options.name ?? "Phala Pay sweep",
-      description: options.description ?? "",
-      createdFromSafeAddress: getAddress(safe),
-    },
-    transactions: calls.map((call) => {
-      if (!/^\d+$/.test(call.value) || !isHex(call.data)) {
-        throw new TypeError("a call needs hex data and a decimal value");
-      }
-      return { to: getAddress(call.to), value: call.value, data: call.data };
-    }),
-  };
-  batch.meta.checksum = batchChecksum(batch);
-  return batch;
-}
-
-/**
- * The Transaction Builder's `meta.checksum` (`apps/tx-builder/src/lib/checksum.ts`): Keccak-256
- * of its key-sorted serialization with `meta.name` set to `null`, over the file without its
- * checksum, as the app's `validateChecksum` recomputes it.
- */
-export function batchChecksum(batch: BatchFile): Hex {
-  const meta: Record<string, unknown> = { ...batch.meta, name: null };
-  delete meta["checksum"];
-  return keccak256(stringToBytes(serialize({ ...batch, meta })));
-}
-
-/** The app's `serializeJSONObject`. */
-function serialize(value: unknown): string {
-  if (Array.isArray(value)) {
-    return `[${value.map(serialize).join(",")}]`;
-  }
-  if (typeof value === "object" && value !== null) {
-    const record = value as Record<string, unknown>;
-    const keys = Object.keys(record).sort();
-    return `{${JSON.stringify(keys)}${keys.map((key) => `${serialize(record[key])},`).join("")}}`;
-  }
-  return JSON.stringify(value === undefined ? null : value);
-}

package/src/server/webhook.ts

@@ -1,208 +0,0 @@
-/**
- * Standard Webhooks `v1a` verification of Phala Pay deliveries (design D11): an ed25519 signature
- * over `{webhook-id}.{webhook-timestamp}.{body}` by your account's webhook key in the endpoint's
- * mode, pinned from `GET /v1/attestation`. Uses WebCrypto, so it runs on Node 20+, Deno, Bun, and
- * edge runtimes.
- */
-
-/** A delivery that did not verify: answer `400` and do nothing. */
-export class WebhookSignatureError extends Error {
-  override readonly name = "WebhookSignatureError";
-}
-
-/** A verified event. `data.object` is the object the event is about, such as a deposit. */
-export interface WebhookEvent {
-  /** `evt_…`, stable across retries and resends: process each id once. */
-  id: string;
-  object: "event";
-  /** Your account, `acct_…`. */
-  account: string;
-  livemode: boolean;
-  /** Such as `deposit.credited`; claw back a `deposit.reversed` deposit's credit. */
-  type: string;
-  created: number;
-  /** Who caused it: an API key id (`key_…`), `admin`, or `system`. */
-  actor: string;
-  /**
-   * The API request that caused it, with the `Idempotency-Key` it sent; `null` when the
-   * service's own workers did (a payment credited, a quote expired).
-   */
-  request: { id: string; idempotency_key: string | null } | null;
-  /**
-   * `object` is the object as it was when the event happened, never re-rendered; `*.updated`
-   * events add `previous_attributes`, the former values of what changed.
-   */
-  data: { object: Record<string, unknown>; previous_attributes?: Record<string, unknown> };
-}
-
-export interface ConstructEventOptions {
-  /** Your account id, `acct_…`: an event of another account fails closed. */
-  expectedAccount: string;
-  /** The mode of the endpoint receiving it: an event of the other mode fails closed. */
-  expectedLivemode: boolean;
-  /** Finite, non-negative seconds a delivery's timestamp may differ from now; default 300. */
-  tolerance?: number;
-  /** Finite current time in Unix seconds; for tests. */
-  now?: number;
-}
-
-/**
- * Verifies a delivery and returns its event, as Stripe's `constructEvent` does, failing closed
- * unless a `v1a` signature verifies with one of `publicKeys` (ed25519 keys in Standard Webhooks'
- * `whpk_` form, as `GET /v1/attestation` lists them; pass both while a rotation overlaps), the
- * timestamp is within tolerance, the body's id is the `webhook-id`, and the event is
- * `expectedAccount`'s in `expectedLivemode`.
- *
- * `payload` is the raw request body, before any JSON parsing.
- */
-export async function constructEvent(
-  payload: string | Uint8Array,
-  headers: Headers | Record<string, string | string[] | undefined>,
-  publicKeys: string | readonly string[],
-  options: ConstructEventOptions,
-): Promise<WebhookEvent> {
-  if (options.expectedAccount === "") {
-    throw new TypeError("expectedAccount is required");
-  }
-  const now = options.now ?? Math.floor(Date.now() / 1000);
-  const tolerance = options.tolerance ?? 300;
-  if (!Number.isFinite(now) || !Number.isFinite(tolerance) || tolerance < 0) {
-    throw new TypeError("webhook now must be finite and tolerance finite and non-negative");
-  }
-  const body = typeof payload === "string" ? new TextEncoder().encode(payload) : payload;
-  const id = header(headers, "webhook-id");
-  const timestamp = header(headers, "webhook-timestamp");
-  const signatures = header(headers, "webhook-signature");
-  if (id === undefined || timestamp === undefined || signatures === undefined) {
-    throw new WebhookSignatureError("webhook headers missing");
-  }
-  if (!/^\d+$/.test(timestamp) || !Number.isSafeInteger(Number(timestamp))) {
-    throw new WebhookSignatureError("webhook timestamp malformed");
-  }
-  if (Math.abs(now - Number(timestamp)) > tolerance) {
-    throw new WebhookSignatureError("webhook timestamp outside tolerance");
-  }
-  const signed = concat(new TextEncoder().encode(`${id}.${timestamp}.`), body);
-  const keys = await Promise.all(
-    (typeof publicKeys === "string" ? [publicKeys] : publicKeys).map(importKey),
-  );
-  if (keys.length === 0) {
-    throw new TypeError("no webhook public key pinned");
-  }
-  let verified = false;
-  for (const entry of signatures.split(" ")) {
-    const [version, encoded] = entry.split(",", 2);
-    const signature = version === "v1a" && encoded !== undefined ? base64(encoded) : undefined;
-    if (signature === undefined) {
-      continue;
-    }
-    for (const key of keys) {
-      if (await crypto.subtle.verify("Ed25519", key, signature, signed)) {
-        verified = true;
-      }
-    }
-  }
-  if (!verified) {
-    throw new WebhookSignatureError("no valid webhook signature");
-  }
-  let event: unknown;
-  try {
-    event = JSON.parse(new TextDecoder().decode(body));
-  } catch {
-    throw new TypeError("webhook body is not an event");
-  }
-  if (!isRecord(event)) {
-    throw new TypeError("webhook body is not an event");
-  }
-  const e = event;
-  const data = e["data"];
-  const object: unknown = isRecord(data) ? data["object"] : null;
-  const { id: eventId, type, account, livemode, created, actor, request } = e;
-  if (
-    e["object"] !== "event" ||
-    typeof eventId !== "string" ||
-    typeof type !== "string" ||
-    typeof account !== "string" ||
-    typeof livemode !== "boolean" ||
-    typeof created !== "number" ||
-    !Number.isSafeInteger(created) ||
-    !isRecord(object) ||
-    typeof actor !== "string" ||
-    !(request === null || isRequest(request))
-  ) {
-    throw new TypeError("webhook body is not an event");
-  }
-  if (eventId !== id) {
-    throw new WebhookSignatureError("webhook id does not match the event");
-  }
-  if (account !== options.expectedAccount) {
-    throw new WebhookSignatureError("webhook event is for another account");
-  }
-  if (livemode !== options.expectedLivemode) {
-    throw new WebhookSignatureError("webhook event is for the other mode");
-  }
-  const previous = isRecord(data) ? data["previous_attributes"] : undefined;
-  return {
-    id: eventId,
-    object: "event",
-    account,
-    livemode,
-    type,
-    created,
-    actor,
-    request,
-    data: {
-      object,
-      ...(isRecord(previous) ? { previous_attributes: previous } : {}),
-    },
-  };
-}
-
-function header(
-  headers: Headers | Record<string, string | string[] | undefined>,
-  name: string,
-): string | undefined {
-  if (headers instanceof Headers) {
-    return headers.get(name)?.trim() ?? undefined;
-  }
-  for (const [key, value] of Object.entries(headers)) {
-    if (key.toLowerCase() === name) {
-      return (Array.isArray(value) ? value.join(" ") : value)?.trim();
-    }
-  }
-  return undefined;
-}
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function isRequest(value: unknown): value is { id: string; idempotency_key: string | null } {
-  if (!isRecord(value)) {
-    return false;
-  }
-  const { id, idempotency_key: key } = value;
-  return typeof id === "string" && (key === null || typeof key === "string");
-}
-
-async function importKey(encoded: string): Promise<CryptoKey> {
-  const raw = encoded.startsWith("whpk_") ? base64(encoded.slice("whpk_".length)) : undefined;
-  if (raw?.length !== 32) {
-    throw new TypeError("a webhook public key is whpk_ and the base64 of 32 bytes");
-  }
-  return crypto.subtle.importKey("raw", raw, "Ed25519", false, ["verify"]);
-}
-
-function base64(value: string): Uint8Array<ArrayBuffer> | undefined {
-  if (!/^[A-Za-z0-9+/]*={0,2}$/.test(value) || value.length % 4 !== 0) {
-    return undefined;
-  }
-  return Uint8Array.from(atob(value), (char) => char.charCodeAt(0));
-}
-
-function concat(left: Uint8Array, right: Uint8Array): Uint8Array<ArrayBuffer> {
-  const joined = new Uint8Array(left.length + right.length);
-  joined.set(left);
-  joined.set(right, left.length);
-  return joined;
-}

package/src/styles.css

@@ -1,80 +0,0 @@
-.pp-root {
-  --pp-color-primary: #0f62fe;
-  --pp-accessible-color-on-color-primary: #ffffff;
-  --pp-color-background: #ffffff;
-  --pp-color-text: #1a1a1a;
-  --pp-color-text-secondary: #5c5f66;
-  --pp-color-border: #d9dce1;
-  --pp-color-danger: #c62828;
-  --pp-color-success: #1b7f3b;
-  --pp-font-family: system-ui, -apple-system, "Segoe UI", Roboto, sans-serif;
-  --pp-border-radius: 8px;
-  box-sizing: border-box;
-  max-width: var(--pp-root-max-width, 440px);
-  padding: var(--pp-root-padding, 20px);
-  border: var(--pp-root-border, 1px solid var(--pp-color-border));
-  border-radius: var(--pp-border-radius);
-  background: var(--pp-root-background, var(--pp-color-background));
-  color: var(--pp-color-text);
-  font-family: var(--pp-font-family);
-  font-size: 14px;
-  line-height: 1.45;
-}
-.pp-root[data-theme="dark"] {
-  --pp-color-primary: #78a9ff;
-  --pp-color-background: #161616;
-  --pp-color-text: #f4f4f4;
-  --pp-color-text-secondary: #a8a8a8;
-  --pp-color-border: #393939;
-  --pp-color-danger: #ff8389;
-  --pp-color-success: #42be65;
-}
-.pp-root *, .pp-root *::before, .pp-root *::after { box-sizing: inherit; }
-.pp-amount { margin: 0; overflow-wrap: anywhere; font-size: 22px; font-weight: 600; }
-.pp-subtitle { margin: 2px 0 12px; color: var(--pp-color-text-secondary); }
-.pp-badge { font-weight: 600; }
-.pp-payments { list-style: none; margin: 12px 0 0; padding: 0; }
-.pp-payments li { margin: 4px 0; }
-.pp-status { display: flex; gap: 8px; align-items: baseline; justify-content: space-between;
-  margin-bottom: 10px; padding: 8px 10px; border-radius: var(--pp-border-radius);
-  border: 1px solid var(--pp-color-border); }
-.pp-status[data-tone="success"] { border-color: var(--pp-color-success); color: var(--pp-color-success); }
-.pp-status[data-tone="danger"] { border-color: var(--pp-color-danger); color: var(--pp-color-danger); }
-.pp-countdown { font-variant-numeric: tabular-nums; white-space: nowrap; }
-.pp-notice { margin: 0 0 12px; color: var(--pp-color-text-secondary); font-size: 13px; }
-.pp-notice strong { color: var(--pp-color-text); }
-.pp-tabs { display: flex; gap: 4px; border-bottom: 1px solid var(--pp-color-border); margin-bottom: 12px; }
-.pp-tab { appearance: none; border: 0; border-bottom: 2px solid transparent; background: none;
-  color: var(--pp-color-text-secondary); font: inherit; min-height: 44px; white-space: nowrap; padding: 8px 10px; cursor: pointer; }
-.pp-tab[aria-selected="true"] { color: var(--pp-color-text); border-bottom-color: var(--pp-color-primary); font-weight: 600; }
-.pp-root button:focus-visible, .pp-root a:focus-visible { outline: 2px solid var(--pp-color-primary); outline-offset: 2px; }
-.pp-wallets { display: grid; gap: 8px; }
-.pp-button { display: flex; gap: 10px; align-items: center; justify-content: center; width: 100%;
-  appearance: none; border: 1px solid var(--pp-color-primary); border-radius: var(--pp-border-radius);
-  background: var(--pp-color-primary); color: var(--pp-accessible-color-on-color-primary); font: inherit; font-weight: 600; min-height: 44px; padding: 10px 14px; cursor: pointer; }
-.pp-button:disabled { opacity: 0.6; cursor: progress; }
-.pp-button img { width: 20px; height: 20px; }
-.pp-wallet-name { font-weight: 400; opacity: 0.85; }
-.pp-message { margin: 8px 0 0; color: var(--pp-color-text-secondary); }
-.pp-message:empty { display: none; }
-.pp-message[data-tone="danger"] { color: var(--pp-color-danger); }
-.pp-qr-panel { display: grid; justify-items: center; gap: 8px; text-align: center; }
-.pp-qr { border-radius: 4px; }
-.pp-fields { display: grid; gap: 8px; margin: 0; }
-.pp-field dt { color: var(--pp-color-text-secondary); font-size: 12px; }
-.pp-field dd { display: flex; gap: 8px; align-items: center; margin: 2px 0 0; }
-.pp-value { font-family: ui-monospace, SFMono-Regular, Menlo, monospace; word-break: break-all; }
-.pp-copy { flex: none; margin-inline-start: auto; appearance: none; border: 1px solid var(--pp-color-border); border-radius: 6px;
-  background: none; color: var(--pp-color-text); font: inherit; font-size: 12px; min-height: 44px; min-width: 44px; padding: 3px 8px; cursor: pointer; }
-.pp-tx { margin: 0 0 12px; font-size: 13px; }
-.pp-tx a { color: inherit; text-decoration: underline; text-underline-offset: 2px; }
-.pp-tx .pp-value { overflow-wrap: anywhere; }
-
-.pp-choices { display: flex; flex-wrap: wrap; gap: 8px; border: 0; padding: 0; margin: 0 0 12px; }
-.pp-choices legend { padding: 0; margin-bottom: 6px; font-weight: 600; }
-.pp-choices label { display: flex; align-items: center; gap: 4px; min-height: 44px; cursor: pointer; }
-.pp-choices input { margin: 0; accent-color: var(--pp-color-primary); }
-.pp-choices input:focus-visible { outline: 2px solid var(--pp-color-primary); outline-offset: 2px; }
-
-.pp-icon-label { display: inline-flex; align-items: center; gap: 4px; vertical-align: middle; white-space: nowrap; }
-.pp-icon { display: inline-block; flex: none; vertical-align: middle; }