@bwalletx/connect 0.4.1 → 0.5.3

package/dist/server.cjs

@@ -20,30 +20,52 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/server.ts
 var server_exports = {};
 __export(server_exports, {
+  ACCESS_CHALLENGE_LIFETIME_S: () => ACCESS_CHALLENGE_LIFETIME_S,
+  ACCESS_ERROR_STATUS: () => ACCESS_ERROR_STATUS,
+  ACCESS_PROTOCOL: () => ACCESS_PROTOCOL,
+  ACCESS_VERSION: () => ACCESS_VERSION,
+  AccessError: () => AccessError,
   CHALLENGE_LIFETIME_MS: () => CHALLENGE_LIFETIME_MS,
   IdentityLinkConflictError: () => IdentityLinkConflictError,
   LOGIN_PROTOCOL: () => LOGIN_PROTOCOL,
+  MAX_HOLDING_PROOFS: () => MAX_HOLDING_PROOFS,
   MIN_SECRET_LENGTH: () => MIN_SECRET_LENGTH,
+  PROTOCOL_MEDIA: () => PROTOCOL_MEDIA,
   PaymentVerificationError: () => PaymentVerificationError,
+  accessErrorMessage: () => accessErrorMessage,
+  atLeastRaw: () => atLeastRaw,
+  bitSignResolver: () => bitSignResolver,
+  canonicalJson: () => canonicalJson,
+  challengeBytes: () => challengeBytes,
+  checkTokenHolding: () => checkTokenHolding,
+  createAccessChallenge: () => createAccessChallenge,
   createChallenge: () => createChallenge,
   isIdentityKey: () => isIdentityKey,
+  kindFor: () => kindFor,
   linkIdentity: () => linkIdentity,
   loginMessage: () => loginMessage,
   memoryStore: () => memoryStore,
+  normaliseRequirement: () => normaliseRequirement,
+  oneSatResolver: () => oneSatResolver,
   originAllowed: () => originAllowed,
+  parseAccessChallenge: () => parseAccessChallenge,
   pgNonceTableSql: () => pgNonceTableSql,
   pgStore: () => pgStore,
+  protocolMediaUrl: () => protocolMediaUrl,
   readCookie: () => readCookie,
   redisStore: () => redisStore,
   serializeCookie: () => serializeCookie,
   signInOrLink: () => signInOrLink,
   signSession: () => signSession,
+  tokenNeedRaw: () => tokenNeedRaw,
+  verifyAccess: () => verifyAccess,
+  verifyHoldingProof: () => verifyHoldingProof,
   verifyPayment: () => verifyPayment,
   verifySession: () => verifySession,
   verifySignIn: () => verifySignIn
 });
 module.exports = __toCommonJS(server_exports);
-var import_sdk2 = require("@bsv/sdk");
+var import_sdk3 = require("@bsv/sdk");
 
 // src/nonce-stores.ts
 var ttlSeconds = (c) => Math.max(1, Math.ceil((c.expiresAt - Date.now()) / 1e3));
@@ -349,6 +371,359 @@ async function signInOrLink(identityKey, o) {
   return { status: "created", userId, identityKey: key };
 }
 
+// src/access.ts
+var ACCESS_VERSION = 1;
+var ACCESS_PROTOCOL = [2, "bwalletx access"];
+var ACCESS_CHALLENGE_LIFETIME_S = 120;
+var MAX_HOLDING_PROOFS = 50;
+var ACCESS_ERROR_STATUS = {
+  not_installed: 424,
+  user_rejected: 403,
+  wrong_account: 409,
+  insufficient_tokens: 403,
+  identity_level_too_low: 403,
+  kyc_required: 403,
+  indexer_unavailable: 503,
+  expired: 401,
+  replay: 401,
+  invalid_signature: 401,
+  bad_request: 400
+};
+var AccessError = class extends Error {
+  code;
+  have;
+  need;
+  constructor(code, message, extra = {}) {
+    super(message ?? code);
+    this.name = "AccessError";
+    this.code = code;
+    this.have = extra.have;
+    this.need = extra.need;
+  }
+  toJSON() {
+    const b = { error: this.code, message: this.message };
+    if (this.have !== void 0) b.have = this.have;
+    if (this.need !== void 0) b.need = this.need;
+    return b;
+  }
+};
+var PROTOCOL_MEDIA = {
+  "401": { name: "Identity", color: "#22c55e", video: "assets/protocol/401.mp4", poster: "assets/protocol/401.jpg" },
+  "402": { name: "Payment", color: "#3b82f6", video: "assets/protocol/402.mp4", poster: "assets/protocol/402.jpg" },
+  "403": { name: "Access", color: "#ef4444", video: "assets/protocol/403.mp4", poster: "assets/protocol/403.jpg" }
+};
+function protocolMediaUrl(kind, which, version = "latest") {
+  return `https://unpkg.com/@bwalletx/connect@${version}/${PROTOCOL_MEDIA[kind][which]}`;
+}
+function canonicalJson(v) {
+  if (v === null) return "null";
+  if (typeof v === "string" || typeof v === "boolean") return JSON.stringify(v);
+  if (typeof v === "number") {
+    if (!Number.isFinite(v)) throw new Error("canonicalJson: non-finite number");
+    return JSON.stringify(v);
+  }
+  if (Array.isArray(v)) return `[${v.map((x) => canonicalJson(x)).join(",")}]`;
+  if (typeof v === "object") {
+    const o = v;
+    const keys2 = Object.keys(o).filter((k) => o[k] !== void 0).sort();
+    return `{${keys2.map((k) => `${JSON.stringify(k)}:${canonicalJson(o[k])}`).join(",")}}`;
+  }
+  throw new Error(`canonicalJson: unsupported ${typeof v}`);
+}
+function challengeBytes(challenge) {
+  return Array.from(new TextEncoder().encode(challenge));
+}
+var TOKEN_ID = /^bsv21:[0-9a-f]{64}_\d{1,6}$/;
+var RAW = /^[1-9]\d{0,38}$/;
+function normaliseRequirement(r) {
+  if (!r || typeof r !== "object") throw new AccessError("bad_request", "require must be an object");
+  const req = r;
+  const out = {};
+  if (req.token !== void 0) {
+    const t = req.token;
+    if (!t || typeof t !== "object" || typeof t.id !== "string") throw new AccessError("bad_request", "require.token.id is required");
+    const id = t.id.trim().toLowerCase();
+    if (!TOKEN_ID.test(id)) throw new AccessError("bad_request", "require.token.id must be 'bsv21:<txid>_<vout>'");
+    const hasMin = t.min !== void 0;
+    const hasBps = t.minBps !== void 0;
+    if (hasMin === hasBps) throw new AccessError("bad_request", "require.token needs exactly one of min or minBps");
+    out.token = { id };
+    if (hasMin) {
+      if (typeof t.min !== "string" || !RAW.test(t.min)) throw new AccessError("bad_request", "require.token.min must be a positive integer string (raw units)");
+      out.token.min = t.min;
+    } else {
+      if (!Number.isInteger(t.minBps) || t.minBps < 1 || t.minBps > 1e4) {
+        throw new AccessError("bad_request", "require.token.minBps must be an integer 1..10000");
+      }
+      out.token.minBps = t.minBps;
+    }
+  }
+  if (req.identityLevel !== void 0) {
+    if (!Number.isInteger(req.identityLevel) || req.identityLevel < 1 || req.identityLevel > 10) {
+      throw new AccessError("bad_request", "require.identityLevel must be an integer 1..10");
+    }
+    out.identityLevel = req.identityLevel;
+  }
+  if (req.kyc !== void 0) {
+    if (typeof req.kyc !== "boolean") throw new AccessError("bad_request", "require.kyc must be a boolean");
+    if (req.kyc) out.kyc = true;
+  }
+  if (!out.token && !out.identityLevel && !out.kyc) throw new AccessError("bad_request", "require is empty");
+  return out;
+}
+function kindFor(r) {
+  return r.token ? "403" : "401";
+}
+function parseAccessChallenge(s) {
+  if (typeof s !== "string" || s.length > 4096) throw new AccessError("bad_request", "challenge must be a string");
+  let c;
+  try {
+    c = JSON.parse(s);
+  } catch {
+    throw new AccessError("bad_request", "challenge is not JSON");
+  }
+  if (!c || typeof c !== "object" || c.v !== 1) throw new AccessError("bad_request", "unsupported challenge version");
+  if (c.kind !== "401" && c.kind !== "402" && c.kind !== "403") throw new AccessError("bad_request", "bad kind");
+  if (typeof c.origin !== "string" || typeof c.nonce !== "string" || !/^[A-Za-z0-9_-]{16,64}$/.test(c.nonce)) {
+    throw new AccessError("bad_request", "bad origin or nonce");
+  }
+  if (!Number.isInteger(c.iat) || !Number.isInteger(c.exp) || c.exp <= c.iat) throw new AccessError("bad_request", "bad iat/exp");
+  if (c.sub !== void 0 && (typeof c.sub !== "string" || !/^0[23][0-9a-f]{64}$/.test(c.sub))) throw new AccessError("bad_request", "bad sub");
+  c.require = normaliseRequirement(c.require);
+  if (canonicalJson(c) !== s) throw new AccessError("bad_request", "challenge is not canonical");
+  return c;
+}
+function tokenNeedRaw(t, supplyRaw) {
+  if (t.min) return t.min;
+  if (supplyRaw === void 0 || !/^\d+$/.test(supplyRaw)) throw new AccessError("indexer_unavailable", "token supply unknown");
+  const n = BigInt(supplyRaw) * BigInt(t.minBps);
+  const need = (n + 9999n) / 10000n;
+  return (need < 1n ? 1n : need).toString();
+}
+function atLeastRaw(have, need) {
+  try {
+    return BigInt(have) >= BigInt(need);
+  } catch {
+    return false;
+  }
+}
+function accessErrorMessage(code, e = {}) {
+  switch (code) {
+    case "not_installed":
+      return "No bWalletX (or other BRC-100 wallet) was found.";
+    case "user_rejected":
+      return "The request was declined in the wallet.";
+    case "wrong_account":
+      return "The wallet is signed in to a different account than this site expects.";
+    case "insufficient_tokens":
+      return `Not enough tokens: holding ${e.have ?? 0}, need ${e.need ?? "?"}.`;
+    case "identity_level_too_low":
+      return `Identity level ${e.have ?? 0} is below the required level ${e.need ?? "?"}.`;
+    case "kyc_required":
+      return "A verified identity (KYC) is required.";
+    case "indexer_unavailable":
+      return "Holdings could not be checked right now. Try again shortly.";
+    case "expired":
+      return "The request expired. Try again.";
+    case "replay":
+      return "That request was already used. Try again.";
+    case "invalid_signature":
+      return "The wallet signature did not verify.";
+    case "bad_request":
+      return "The request was malformed.";
+  }
+}
+
+// src/access-server.ts
+var import_sdk2 = require("@bsv/sdk");
+var bare = (tokenId) => tokenId.replace(/^bsv21:/, "");
+function oneSatResolver(o = {}) {
+  const base = (o.base ?? "https://api.1sat.app/1sat").replace(/\/$/, "");
+  const f = o.fetch ?? globalThis.fetch;
+  const t = o.timeoutMs ?? 12e3;
+  const call = async (path, init) => {
+    const res = await f(`${base}${path}`, { ...init, signal: AbortSignal.timeout(t), cache: "no-store" });
+    if (!res.ok) throw new Error(`1sat ${res.status} for ${path}`);
+    return res.json();
+  };
+  return {
+    async tokenBalance(tokenId, addresses) {
+      const sorted = [...new Set(addresses)].sort();
+      let total = 0n;
+      for (let i = 0; i < sorted.length; i += 100) {
+        const j = await call(`/bsv21/${bare(tokenId)}/p2pkh/balance`, {
+          method: "POST",
+          headers: { "content-type": "application/json" },
+          body: JSON.stringify(sorted.slice(i, i + 100))
+        });
+        const b = j?.balance ?? 0;
+        const s = typeof b === "number" ? String(Math.trunc(b)) : String(b).split(".")[0] || "0";
+        if (!/^\d+$/.test(s)) throw new Error("1sat returned a bad balance");
+        total += BigInt(s);
+      }
+      return total.toString();
+    },
+    async tokenSupply(tokenId) {
+      const j = await call(`/bsv21/${bare(tokenId)}`);
+      const tok = (j?.token ?? j) || {};
+      const v = tok.amt ?? tok.max ?? tok.supply;
+      const s = v === void 0 || v === null ? "" : String(v).split(".")[0];
+      if (!/^\d+$/.test(s) || s === "0") throw new Error("1sat did not report a supply");
+      return s;
+    }
+  };
+}
+function bitSignResolver(o = {}) {
+  const base = (o.base ?? "https://bit-sign.online").replace(/\/$/, "");
+  const f = o.fetch ?? globalThis.fetch;
+  const tokens = o.tokens ?? oneSatResolver({ fetch: f });
+  return {
+    tokenBalance: (id, a) => tokens.tokenBalance(id, a),
+    tokenSupply: tokens.tokenSupply ? (id) => tokens.tokenSupply(id) : void 0,
+    async identity(identityKey, response) {
+      const res = await f(`${base}/api/access/verify`, {
+        method: "POST",
+        headers: { "content-type": "application/json" },
+        body: JSON.stringify({ response, only: "identity" }),
+        signal: AbortSignal.timeout(o.timeoutMs ?? 12e3),
+        cache: "no-store"
+      });
+      const j = await res.json().catch(() => null);
+      if (!j?.identity || j.identityKey !== identityKey) throw new Error(`bit-sign ${res.status}`);
+      return { level: Number(j.identity.level) || 0, kyc: j.identity.kyc === true };
+    }
+  };
+}
+function normalOrigin(origin) {
+  const u = new URL(origin);
+  if (u.origin === "null" || u.origin !== origin.replace(/\/$/, "")) throw new Error(`origin must be scheme://host[:port], got ${origin}`);
+  return u.origin;
+}
+function randomNonce() {
+  const b = new Uint8Array(18);
+  globalThis.crypto.getRandomValues(b);
+  let s = "";
+  for (const x of b) s += String.fromCharCode(x);
+  return btoa(s).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
+}
+async function createAccessChallenge(o) {
+  const origin = normalOrigin(o.origin);
+  const require2 = normaliseRequirement(o.require);
+  let sub;
+  if (o.identityKey !== void 0 && o.identityKey !== null && o.identityKey !== "") {
+    if (!isIdentityKey(o.identityKey)) throw new AccessError("bad_request", "identityKey must be a compressed public key");
+    sub = o.identityKey.toLowerCase();
+  }
+  const iat = Math.floor((o.now ?? Date.now()) / 1e3);
+  const exp = iat + (o.lifetimeS ?? ACCESS_CHALLENGE_LIFETIME_S);
+  const nonce = randomNonce();
+  const c = { v: 1, kind: o.kind ?? kindFor(require2), origin, nonce, iat, exp, sub, require: require2 };
+  const challenge = canonicalJson(c);
+  await o.store.put(nonce, { identityKey: sub ?? "", origin, message: challenge, expiresAt: exp * 1e3 });
+  return { challenge, nonce, kind: c.kind, protocolID: ACCESS_PROTOCOL, keyID: nonce, exp };
+}
+var isByteArray = (s) => Array.isArray(s) && s.length >= 8 && s.length <= 80 && s.every((b) => Number.isInteger(b) && b >= 0 && b <= 255);
+function verifyHoldingProof(challenge, p) {
+  const proof = p;
+  if (!proof || typeof proof.pubkey !== "string" || !/^0[23][0-9a-fA-F]{64}$/.test(proof.pubkey) || !isByteArray(proof.signature)) return null;
+  try {
+    const pub = import_sdk2.PublicKey.fromString(proof.pubkey);
+    const sig = import_sdk2.Signature.fromDER(proof.signature);
+    return pub.verify(challengeBytes(challenge), sig) ? pub.toAddress() : null;
+  } catch {
+    return null;
+  }
+}
+async function verifyAccess(o) {
+  const r = o.response;
+  if (!r || typeof r !== "object" || r.v !== 1) throw new AccessError("bad_request", "response must be { v: 1, challenge, identityKey, signature }");
+  const c = parseAccessChallenge(r.challenge);
+  const nowS = Math.floor((o.now ?? Date.now()) / 1e3);
+  const pending = await o.store.take(c.nonce);
+  if (!pending) throw new AccessError(nowS >= c.exp ? "expired" : "replay");
+  if (nowS >= c.exp || (o.now ?? Date.now()) > pending.expiresAt) throw new AccessError("expired");
+  if (pending.message !== r.challenge) throw new AccessError("replay", "challenge does not match the one issued");
+  let origin;
+  try {
+    origin = normalOrigin(o.origin);
+  } catch {
+    throw new AccessError("bad_request", "server origin is misconfigured");
+  }
+  if (c.origin !== origin || pending.origin !== origin) throw new AccessError("bad_request", "origin mismatch");
+  if (o.require && canonicalJson(normaliseRequirement(o.require)) !== canonicalJson(c.require)) {
+    throw new AccessError("bad_request", "challenge requirement does not match this gate");
+  }
+  if (!isIdentityKey(r.identityKey)) throw new AccessError("bad_request", "identityKey must be a compressed public key");
+  const identityKey = r.identityKey.toLowerCase();
+  if (c.sub && c.sub !== identityKey) throw new AccessError("wrong_account");
+  if (!isByteArray(r.signature)) throw new AccessError("invalid_signature");
+  let valid = false;
+  try {
+    ({ valid } = await new import_sdk2.ProtoWallet("anyone").verifySignature({
+      protocolID: ACCESS_PROTOCOL,
+      keyID: c.nonce,
+      counterparty: identityKey,
+      data: challengeBytes(r.challenge),
+      signature: r.signature
+    }));
+  } catch {
+    valid = false;
+  }
+  if (!valid) throw new AccessError("invalid_signature");
+  const grant = { ok: true, identityKey, kind: c.kind, require: c.require, addresses: [], have: {} };
+  if (c.require.identityLevel || c.require.kyc) {
+    if (!o.resolver.identity) throw new AccessError("indexer_unavailable", "no identity resolver configured");
+    let id;
+    try {
+      id = await o.resolver.identity(identityKey, r);
+    } catch (e) {
+      throw new AccessError("indexer_unavailable", `identity lookup failed: ${e.message}`);
+    }
+    grant.have.identityLevel = id.level;
+    grant.have.kyc = id.kyc;
+    if (c.require.kyc && !id.kyc) throw new AccessError("kyc_required");
+    if (c.require.identityLevel && id.level < c.require.identityLevel) {
+      throw new AccessError("identity_level_too_low", void 0, { have: id.level, need: c.require.identityLevel });
+    }
+  }
+  if (c.require.token) {
+    const proofs = Array.isArray(r.holdings) ? r.holdings.slice(0, MAX_HOLDING_PROOFS) : [];
+    const addresses = /* @__PURE__ */ new Set();
+    for (const p of proofs) {
+      const a = verifyHoldingProof(r.challenge, p);
+      if (a) addresses.add(a);
+    }
+    grant.addresses = [...addresses].sort();
+    const check = await checkTokenHolding(c.require, grant.addresses, o.resolver);
+    grant.have.tokenRaw = check.have;
+    grant.have.needRaw = check.need;
+  }
+  return grant;
+}
+async function checkTokenHolding(require2, addresses, resolver) {
+  const t = require2.token;
+  if (!t) return { have: "0", need: "0" };
+  let supply;
+  if (t.minBps) {
+    if (!resolver.tokenSupply) throw new AccessError("indexer_unavailable", "no supply resolver configured");
+    try {
+      supply = await resolver.tokenSupply(t.id);
+    } catch (e) {
+      throw new AccessError("indexer_unavailable", `supply lookup failed: ${e.message}`);
+    }
+  }
+  const need = tokenNeedRaw(t, supply);
+  if (!addresses.length) throw new AccessError("insufficient_tokens", void 0, { have: "0", need });
+  let have;
+  try {
+    have = await resolver.tokenBalance(t.id, addresses);
+  } catch (e) {
+    throw new AccessError("indexer_unavailable", `balance lookup failed: ${e.message}`);
+  }
+  if (!atLeastRaw(have, need)) throw new AccessError("insufficient_tokens", void 0, { have, need });
+  return { have, need };
+}
+
 // src/server.ts
 var LOGIN_PROTOCOL = [2, "bwallet sign in"];
 var CHALLENGE_LIFETIME_MS = 2 * 60 * 1e3;
@@ -380,13 +755,13 @@ var storeOrDefault = (s) => s ?? (defaultStore ??= memoryStore());
 function isIdentityKey(x) {
   if (typeof x !== "string" || !/^0[23][0-9a-fA-F]{64}$/.test(x)) return false;
   try {
-    import_sdk2.PublicKey.fromString(x);
+    import_sdk3.PublicKey.fromString(x);
     return true;
   } catch {
     return false;
   }
 }
-function normalOrigin(origin) {
+function normalOrigin2(origin) {
   const u = new URL(origin);
   if (u.origin === "null" || u.origin !== origin.replace(/\/$/, "")) {
     throw new Error(`origin must be scheme://host[:port], got ${origin}`);
@@ -404,7 +779,7 @@ function loginMessage(origin, nonce, expiresAt) {
     `Expires: ${new Date(expiresAt).toISOString()}`
   ].join("\n");
 }
-function randomNonce() {
+function randomNonce2() {
   const b = new Uint8Array(16);
   globalThis.crypto.getRandomValues(b);
   let s = "";
@@ -413,8 +788,8 @@ function randomNonce() {
 }
 async function createChallenge(opts) {
   if (!isIdentityKey(opts.identityKey)) throw new Error("identityKey must be a compressed public key (66 hex chars)");
-  const origin = normalOrigin(opts.origin);
-  const nonce = randomNonce();
+  const origin = normalOrigin2(opts.origin);
+  const nonce = randomNonce2();
   const expiresAt = Date.now() + CHALLENGE_LIFETIME_MS;
   const message = loginMessage(origin, nonce, expiresAt);
   await storeOrDefault(opts.store).put(nonce, { identityKey: opts.identityKey.toLowerCase(), origin, message, expiresAt });
@@ -426,7 +801,7 @@ async function verifySignIn(opts) {
   if (!c || Date.now() > c.expiresAt) return null;
   let origin;
   try {
-    origin = normalOrigin(opts.origin);
+    origin = normalOrigin2(opts.origin);
   } catch {
     return null;
   }
@@ -439,7 +814,7 @@ async function verifySignIn(opts) {
     return null;
   }
   try {
-    const { valid } = await new import_sdk2.ProtoWallet("anyone").verifySignature({
+    const { valid } = await new import_sdk3.ProtoWallet("anyone").verifySignature({
       protocolID: LOGIN_PROTOCOL,
       keyID: opts.nonce,
       counterparty: identityKey,
@@ -453,31 +828,53 @@ async function verifySignIn(opts) {
 }
 function originAllowed(requestOrigin, origin) {
   try {
-    return !!requestOrigin && requestOrigin === normalOrigin(origin);
+    return !!requestOrigin && requestOrigin === normalOrigin2(origin);
   } catch {
     return false;
   }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ACCESS_CHALLENGE_LIFETIME_S,
+  ACCESS_ERROR_STATUS,
+  ACCESS_PROTOCOL,
+  ACCESS_VERSION,
+  AccessError,
   CHALLENGE_LIFETIME_MS,
   IdentityLinkConflictError,
   LOGIN_PROTOCOL,
+  MAX_HOLDING_PROOFS,
   MIN_SECRET_LENGTH,
+  PROTOCOL_MEDIA,
   PaymentVerificationError,
+  accessErrorMessage,
+  atLeastRaw,
+  bitSignResolver,
+  canonicalJson,
+  challengeBytes,
+  checkTokenHolding,
+  createAccessChallenge,
   createChallenge,
   isIdentityKey,
+  kindFor,
   linkIdentity,
   loginMessage,
   memoryStore,
+  normaliseRequirement,
+  oneSatResolver,
   originAllowed,
+  parseAccessChallenge,
   pgNonceTableSql,
   pgStore,
+  protocolMediaUrl,
   readCookie,
   redisStore,
   serializeCookie,
   signInOrLink,
   signSession,
+  tokenNeedRaw,
+  verifyAccess,
+  verifyHoldingProof,
   verifyPayment,
   verifySession,
   verifySignIn