@codespar/cli 0.14.1 → 0.16.0

package/templates/bills-agent/packages/agent-core/src/receipt-verification.ts

@@ -0,0 +1,401 @@
+/**
+ * `receipt-verification`: the half of a receipt a party OUTSIDE CodeSpar can
+ * check.
+ *
+ * A receipt carries two signatures and they prove different things to
+ * different people.
+ *
+ *   `receipt_sig`          HMAC over the chain, under the consumer's secret.
+ *                          Verifying it means holding the key that also MINTS
+ *                          it, so it proves the payment to whoever runs the
+ *                          agent and to nobody else.
+ *   `receipt_sig_ed25519`  Ed25519 over `codespar-receipt:v1:<id>:<chain>`,
+ *                          made with CodeSpar's platform issuer key, whose
+ *                          PUBLIC half is served with no credential at
+ *                          `/.well-known/codespar-receipt-keys.json`. That one
+ *                          proves the payment to an accountant, a marketplace
+ *                          reconciling a payout, or a court — parties that
+ *                          have no relationship with CodeSpar at all.
+ *
+ * This module checks the second. It imports `node:crypto` and nothing else: no
+ * CodeSpar SDK, no key material, no token, no network of its own (the key
+ * document is passed in, or fetched by a function the caller supplies). A
+ * third party can read the forty lines that matter and reimplement them.
+ *
+ * WHAT A `verified` VERDICT PROVES, exactly: CodeSpar sealed a receipt with
+ * THIS id and THIS chain. The chain is a SHA-256 over the four links of the
+ * Control Record, so the seller, the amount and the payee are inside it — but
+ * recomputing that digest from the receipt body needs the canonical link
+ * shapes, which CodeSpar does not publish today. Binding the body to the chain
+ * is therefore not something this module can promise, and it does not pretend
+ * to: see `docs/OPEN_QUESTIONS.md` §47. It is also why the signature survives
+ * the proof bundle's masking — the bundle masks the payee, and the signature
+ * covers the id and the digest, not the copy in front of you.
+ *
+ * WHICH KEY SET. `kid` is `<did>#<n>` and the DID is the platform's, so it is
+ * the same string on every deployment while the KEY behind it is not: a
+ * sandbox receipt checked against the production key set finds a key of that
+ * name, fails to verify, and reads `tampered`. The verifier therefore points
+ * at ONE deployment's `/.well-known/codespar-receipt-keys.json` — the default
+ * is production, and `--url` names another. Nothing in the two documents tells
+ * them apart today; `docs/OPEN_QUESTIONS.md` §47 says so and names the ask.
+ *
+ * The signed string is the enterprise's `receiptSigningString`
+ * (`packages/api/src/receipt-signature.ts`, ent#1633), reproduced here rather
+ * than imported, because a verifier that has to install the signer's code
+ * proves nothing about the signer.
+ */
+import { createPublicKey, verify as verifyDetached } from "node:crypto";
+
+/** The domain tag. A receipt names the version it was sealed under through
+ *  this literal, so a future `v2` does not invalidate a `v1` signature. */
+export const RECEIPT_SIGNATURE_DOMAIN = "codespar-receipt:v1";
+
+/** The unauthenticated key set of the production API. `--url` points the
+ *  verifier at another deployment (staging), `--keys` at a file. */
+export const DEFAULT_RECEIPT_KEYS_URL = "https://api.codespar.dev/.well-known/codespar-receipt-keys.json";
+
+/** The key set of a deployment, from its base URL. */
+export function receiptKeysUrl(baseUrl: string): string {
+  return new URL("/.well-known/codespar-receipt-keys.json", baseUrl).toString();
+}
+
+/** The exact bytes the Ed25519 signature covers. Every segment is fixed-shape:
+ *  the domain is a literal, the id is `rcpt_` + 22 url-safe characters, and the
+ *  chain is 64 hex. No free text reaches this string. */
+export function receiptSigningString(receiptId: string, chain: string): string {
+  return `${RECEIPT_SIGNATURE_DOMAIN}:${receiptId}:${chain}`;
+}
+
+/**
+ * The six honest answers. Five of them are not "invalid", and keeping them
+ * apart is the point of the module:
+ *
+ *   `verified`     the signature is CodeSpar's, over this id and this chain.
+ *   `tampered`     a signature is there and it does not match. A refusal.
+ *   `unsigned`     no signature on this copy. NOT a failure: every receipt
+ *                  sealed before CodeSpar added Ed25519 has none and never
+ *                  will, because signing them today with today's key would
+ *                  attest to what the database says now, not to what happened.
+ *   `unknown_key`  the `kid` is not in the key set. Retired keys stay
+ *                  published precisely so old signatures keep verifying, so a
+ *                  missing kid means another deployment, or a revoked key.
+ *   `unreachable`  no usable key set. UNKNOWN — never "invalid".
+ *   `malformed`    the file is not a receipt this module can read. Distinct
+ *                  from `unsigned` on purpose: answering "unsigned" for an
+ *                  arbitrary JSON file would state that it is a receipt from
+ *                  before the capability existed, which is a claim about a
+ *                  file nobody checked.
+ */
+export type ReceiptVerdict = "verified" | "tampered" | "unsigned" | "unknown_key" | "unreachable" | "malformed";
+
+export interface ReceiptVerification {
+  verdict: ReceiptVerdict;
+  /** The receipt this is about, when the document names one. */
+  receipt_id: string | null;
+  /** The key the receipt names, when it names one. */
+  kid: string | null;
+  /** `active` or `retired`, as the key set publishes it. A retired key signs
+   *  nothing new and verifies everything it already signed. */
+  key_status: string | null;
+  /** The bytes that were verified, so a reader can reproduce the check by hand. */
+  signing_string: string | null;
+  /** Where the keys came from, or `null` when no key was needed. */
+  keys_from: string | null;
+  /** A stable machine code under the verdict. */
+  reason: string;
+  /** One sentence for a person. Never a stack trace. */
+  message: string;
+}
+
+/** One published key, RFC 8037 shape, as the JWKS serves it. */
+export interface PublishedReceiptKey {
+  kid: string;
+  kty: string;
+  crv: string;
+  /** base64url of the raw 32-byte public key. */
+  x: string;
+  alg?: string;
+  use?: string;
+  status?: string;
+  created_at?: string;
+  retired_at?: string | null;
+}
+
+export interface ReceiptKeyDocument {
+  issuer?: string;
+  algorithm?: string;
+  signing_string?: string;
+  keys: PublishedReceiptKey[];
+}
+
+/** The receipt fields this module reads. Everything else in the JSON is none
+ *  of its business — including the HMAC seal, which needs a secret it must
+ *  never be given. */
+export interface SignedReceiptFields {
+  receipt_id: string;
+  chain: string | null;
+  receipt_sig_ed25519: string | null;
+  receipt_sig_kid: string | null;
+}
+
+/** The caller's fetcher. Injected so the module has no network of its own and
+ *  a unit test needs none. */
+export type KeyDocumentFetcher = (url: string) => Promise<unknown>;
+
+export interface KeySource {
+  /** A key set already in hand — a file, a fixture, a document fetched once
+   *  and reused across a folder of receipts. */
+  document?: unknown;
+  /** Where to fetch it from, with the function that does the fetching. */
+  url?: string;
+  fetch?: KeyDocumentFetcher;
+  /** What to call the origin in the report. Defaults to the url, or `file`. */
+  label?: string;
+}
+
+/* ── Reading the documents ───────────────────────────────────── */
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+function stringOrNull(value: unknown): string | null {
+  return typeof value === "string" && value.length > 0 ? value : null;
+}
+
+/** base64url, strictly: Node's decoder accepts standard base64 and skips
+ *  characters it does not know, so a round trip is what proves the string was
+ *  the encoding it claims to be. */
+function decodeBase64Url(value: string, expectedBytes: number): Buffer | undefined {
+  if (!/^[A-Za-z0-9_-]+$/.test(value)) return undefined;
+  const buf = Buffer.from(value, "base64url");
+  if (buf.length !== expectedBytes || buf.toString("base64url") !== value) return undefined;
+  return buf;
+}
+
+export type ReceiptRead = { ok: true; fields: SignedReceiptFields } | { ok: false; reason: string; message: string; receipt_id: string | null };
+
+/**
+ * Read the four fields out of a receipt JSON, or say why it cannot be read.
+ *
+ * A signature without its `kid`, or a `kid` without its signature, is a
+ * MALFORMED document and not an unsigned one. The API writes both columns or
+ * neither, so half a pair means the file was edited — and "unsigned" is the
+ * benign verdict, which is exactly the one an edit must not be able to reach
+ * by deletion.
+ */
+export function readSignedReceipt(input: unknown): ReceiptRead {
+  if (!isRecord(input)) {
+    return { ok: false, reason: "not_an_object", receipt_id: null, message: "this file is not a JSON object, so it is not a receipt" };
+  }
+  const receiptId = stringOrNull(input["receipt_id"]);
+  if (receiptId === null) {
+    return { ok: false, reason: "receipt_id_missing", receipt_id: null, message: "this JSON carries no `receipt_id`, so it is not a CodeSpar receipt" };
+  }
+  const sigRaw = input["receipt_sig_ed25519"];
+  const kidRaw = input["receipt_sig_kid"];
+  const sig = stringOrNull(sigRaw);
+  const kid = stringOrNull(kidRaw);
+  const sigAbsent = sigRaw === undefined || sigRaw === null;
+  const kidAbsent = kidRaw === undefined || kidRaw === null;
+  if (!sigAbsent && sig === null) {
+    return { ok: false, reason: "signature_not_a_string", receipt_id: receiptId, message: `receipt ${receiptId} carries a \`receipt_sig_ed25519\` that is not a string` };
+  }
+  if (!kidAbsent && kid === null) {
+    return { ok: false, reason: "kid_not_a_string", receipt_id: receiptId, message: `receipt ${receiptId} carries a \`receipt_sig_kid\` that is not a string` };
+  }
+  if (sig !== null && kid === null) {
+    return { ok: false, reason: "kid_missing", receipt_id: receiptId, message: `receipt ${receiptId} carries a signature and no \`receipt_sig_kid\`, so there is no way to know which key to check it against; a receipt sealed before Ed25519 carries neither` };
+  }
+  if (kid !== null && sig === null) {
+    return { ok: false, reason: "signature_missing", receipt_id: receiptId, message: `receipt ${receiptId} names the key \`${kid}\` and carries no \`receipt_sig_ed25519\` to check against it` };
+  }
+  const chain = stringOrNull(input["chain"]);
+  if (sig !== null && chain === null) {
+    return { ok: false, reason: "chain_missing", receipt_id: receiptId, message: `receipt ${receiptId} carries a signature and no \`chain\`, so the signed string cannot be rebuilt` };
+  }
+  return { ok: true, fields: { receipt_id: receiptId, chain, receipt_sig_ed25519: sig, receipt_sig_kid: kid } };
+}
+
+export type KeyDocumentRead = { ok: true; document: ReceiptKeyDocument } | { ok: false; reason: string; message: string };
+
+/** Read a JWKS, or say why it is not one. Anything unusable is `unreachable`
+ *  territory: a key set we cannot read leaves us knowing nothing about the
+ *  signature, which is not the same as knowing it is bad. */
+export function readKeyDocument(input: unknown): KeyDocumentRead {
+  if (!isRecord(input)) return { ok: false, reason: "key_document_unreadable", message: "the key set is not a JSON object" };
+  const keys = input["keys"];
+  if (!Array.isArray(keys)) return { ok: false, reason: "key_document_unreadable", message: "the key set carries no `keys` array" };
+  const parsed: PublishedReceiptKey[] = [];
+  for (const entry of keys) {
+    if (!isRecord(entry)) continue;
+    const kid = stringOrNull(entry["kid"]);
+    const x = stringOrNull(entry["x"]);
+    const kty = stringOrNull(entry["kty"]);
+    const crv = stringOrNull(entry["crv"]);
+    if (kid === null || x === null || kty === null || crv === null) continue;
+    parsed.push({
+      kid,
+      kty,
+      crv,
+      x,
+      ...(stringOrNull(entry["alg"]) !== null ? { alg: entry["alg"] as string } : {}),
+      ...(stringOrNull(entry["status"]) !== null ? { status: entry["status"] as string } : {}),
+    });
+  }
+  const document: ReceiptKeyDocument = {
+    keys: parsed,
+    ...(stringOrNull(input["issuer"]) !== null ? { issuer: input["issuer"] as string } : {}),
+    ...(stringOrNull(input["signing_string"]) !== null ? { signing_string: input["signing_string"] as string } : {}),
+  };
+  return { ok: true, document };
+}
+
+/* ── The check ───────────────────────────────────────────────── */
+
+/**
+ * Verify a receipt against a key set already in hand. Synchronous, offline,
+ * and the whole of the cryptography: everything else in this file is reading
+ * JSON carefully.
+ */
+export function verifyReceiptWithKeys(receipt: unknown, keyDocument: unknown, label = "file"): ReceiptVerification {
+  const read = readSignedReceipt(receipt);
+  if (!read.ok) {
+    return { verdict: "malformed", receipt_id: read.receipt_id, kid: null, key_status: null, signing_string: null, keys_from: null, reason: read.reason, message: read.message };
+  }
+  const { receipt_id: receiptId, chain, receipt_sig_ed25519: signature, receipt_sig_kid: kid } = read.fields;
+
+  if (signature === null || kid === null || chain === null) {
+    return {
+      verdict: "unsigned",
+      receipt_id: receiptId,
+      kid: null,
+      key_status: null,
+      signing_string: null,
+      keys_from: null,
+      reason: "no_ed25519_signature",
+      message: `receipt ${receiptId} carries no Ed25519 signature. Receipts sealed before CodeSpar added one carry none and never will; its HMAC seal is unaffected and still proves the payment to whoever runs the agent`,
+    };
+  }
+
+  const signingString = receiptSigningString(receiptId, chain);
+  const doc = readKeyDocument(keyDocument);
+  if (!doc.ok) {
+    return { verdict: "unreachable", receipt_id: receiptId, kid, key_status: null, signing_string: signingString, keys_from: label, reason: doc.reason, message: `${doc.message}, so nothing is proved and nothing is disproved about receipt ${receiptId}` };
+  }
+
+  const key = doc.document.keys.find((k) => k.kid === kid);
+  if (!key) {
+    return {
+      verdict: "unknown_key",
+      receipt_id: receiptId,
+      kid,
+      key_status: null,
+      signing_string: signingString,
+      keys_from: label,
+      reason: "kid_not_published",
+      message: `the key \`${kid}\` is not among the ${doc.document.keys.length} published at ${label}. CodeSpar keeps retired keys published so old signatures go on verifying, so a missing kid is a key from another deployment, or one that was revoked`,
+    };
+  }
+  const keyStatus = key.status ?? null;
+
+  if (key.kty !== "OKP" || key.crv !== "Ed25519") {
+    return { verdict: "unreachable", receipt_id: receiptId, kid, key_status: keyStatus, signing_string: signingString, keys_from: label, reason: "key_unusable", message: `the published key \`${kid}\` is ${key.kty}/${key.crv} and not OKP/Ed25519, so this module cannot check the signature with it` };
+  }
+  const publicKey = decodeBase64Url(key.x, 32);
+  if (!publicKey) {
+    return { verdict: "unreachable", receipt_id: receiptId, kid, key_status: keyStatus, signing_string: signingString, keys_from: label, reason: "key_unusable", message: `the published key \`${kid}\` does not carry a 32-byte base64url public key, so this module cannot check the signature with it` };
+  }
+  const signatureBytes = decodeBase64Url(signature, 64);
+  if (!signatureBytes) {
+    return { verdict: "tampered", receipt_id: receiptId, kid, key_status: keyStatus, signing_string: signingString, keys_from: label, reason: "signature_malformed", message: `receipt ${receiptId} carries a \`receipt_sig_ed25519\` that is not a 64-byte base64url Ed25519 signature, so it is not the one CodeSpar wrote` };
+  }
+
+  let matches: boolean;
+  try {
+    matches = verifyDetached(null, Buffer.from(signingString, "utf8"), createPublicKey({ key: { kty: "OKP", crv: "Ed25519", x: key.x }, format: "jwk" }), signatureBytes);
+  } catch (err) {
+    return { verdict: "unreachable", receipt_id: receiptId, kid, key_status: keyStatus, signing_string: signingString, keys_from: label, reason: "key_unusable", message: `the published key \`${kid}\` could not be used: ${err instanceof Error ? err.message : String(err)}` };
+  }
+
+  if (!matches) {
+    return {
+      verdict: "tampered",
+      receipt_id: receiptId,
+      kid,
+      key_status: keyStatus,
+      signing_string: signingString,
+      keys_from: label,
+      reason: "signature_does_not_match",
+      message: `receipt ${receiptId} does not match its signature: the key \`${kid}\` did not sign this receipt id and this chain. The id or the chain was changed after the receipt was sealed, the signature was copied from another receipt, or this key set is not the one the deployment that sealed it publishes — a sandbox receipt checked against the production keys reads exactly like this, because every deployment publishes its own key under the same \`kid\``,
+    };
+  }
+  return {
+    verdict: "verified",
+    receipt_id: receiptId,
+    kid,
+    key_status: keyStatus,
+    signing_string: signingString,
+    keys_from: label,
+    reason: "signature_matches",
+    message: `receipt ${receiptId} was sealed by CodeSpar: the ${keyStatus ?? "published"} key \`${kid}\` signed this receipt id and this chain`,
+  };
+}
+
+/**
+ * Verify a receipt, fetching the key set when one is not in hand.
+ *
+ * The fetch is the caller's function, so this module opens no socket and a
+ * unit test needs no network. A fetch that fails is `unreachable` and never
+ * `tampered`: not knowing is not the same as knowing it is bad, and a
+ * verifier that conflated the two would call every receipt invalid the day
+ * its DNS broke.
+ */
+export async function verifyReceipt(receipt: unknown, source: KeySource = {}): Promise<ReceiptVerification> {
+  const read = readSignedReceipt(receipt);
+  if (!read.ok) {
+    return { verdict: "malformed", receipt_id: read.receipt_id, kid: null, key_status: null, signing_string: null, keys_from: null, reason: read.reason, message: read.message };
+  }
+  // An unsigned receipt needs no key, so it is answered before the network is
+  // touched: fetching a key set to check a signature that is not there would
+  // turn an offline answer into an outage.
+  if (read.fields.receipt_sig_ed25519 === null) return verifyReceiptWithKeys(receipt, { keys: [] }, source.label ?? "none");
+
+  if (source.document !== undefined) return verifyReceiptWithKeys(receipt, source.document, source.label ?? "file");
+
+  const url = source.url ?? DEFAULT_RECEIPT_KEYS_URL;
+  const label = source.label ?? url;
+  if (!source.fetch) {
+    return { verdict: "unreachable", receipt_id: read.fields.receipt_id, kid: read.fields.receipt_sig_kid, key_status: null, signing_string: null, keys_from: label, reason: "no_fetcher", message: "no key set was given and no way to fetch one: pass a document, or a fetch function" };
+  }
+  let fetched: unknown;
+  try {
+    fetched = await source.fetch(url);
+  } catch (err) {
+    return {
+      verdict: "unreachable",
+      receipt_id: read.fields.receipt_id,
+      kid: read.fields.receipt_sig_kid,
+      key_status: null,
+      signing_string: null,
+      keys_from: label,
+      reason: "fetch_failed",
+      message: `the published key set could not be read from ${label}: ${err instanceof Error ? err.message : String(err)}. Nothing is proved and nothing is disproved; the keys can also be saved to a file and passed in`,
+    };
+  }
+  return verifyReceiptWithKeys(receipt, fetched, label);
+}
+
+/** The exit code of `codespar-agent verify`, one per verdict, so a script can
+ *  branch on the answer instead of on "did it fail". `unsigned` is not 0: it is
+ *  not a failure, and it is not a verification either. 2 is the usage error the
+ *  other commands already use. */
+export const VERDICT_EXIT_CODES: Record<ReceiptVerdict, number> = {
+  verified: 0,
+  tampered: 1,
+  unsigned: 3,
+  unknown_key: 4,
+  unreachable: 5,
+  malformed: 6,
+};

package/templates/bills-agent/packages/agent-core/src/state-machine.ts

@@ -6,7 +6,7 @@
  * does not compile; the runtime check below refuses the same pair when the
  * types were bypassed (a cast, a row read back from SQLite).
  */
-import type { Actor, ApprovalMode, EscalationTrigger, ExecutionItem, ExecutionReason, ItemOutcome, MandateRef } from "./types.js";
+import type { Actor, ApprovalMode, EscalationTrigger, ExecutionBatch, ExecutionItem, ExecutionReason, ItemOutcome, MandateRef } from "./types.js";
 
 export type ExecutionState =
   | "drafted"
@@ -76,6 +76,8 @@ export interface Execution<S extends ExecutionState = ExecutionState> {
   /** What the model claimed the total was, when it claimed one. Recorded, never used. */
   model_claimed_total?: number;
   items_hash: string;
+  /** Present when this execution is one line of a batch: the set it was presented inside, and where in it. */
+  batch?: ExecutionBatch;
   mandate: MandateRef;
   /** Written once, before the rail is called. Retrying reuses it. */
   idempotency_key: string;

package/templates/bills-agent/packages/agent-core/src/stubs/charge-rail.ts

@@ -139,6 +139,8 @@ export class StubChargeRail implements PaymentRail {
       payment: { amount_minor: req.amount_minor, payee: req.payee, attempt_id: req.attempt_id, money_moved: false, sandbox: true, at: raw.paid_at ?? sealed.at },
       chain: null,
       receipt_sig: null,
+      receipt_sig_ed25519: null,
+      receipt_sig_kid: null,
       actor,
       raw: { stub: true, charge_id: out.transaction_id, simulated: true, settled_against: "sandbox_fixture" },
     };

package/templates/bills-agent/packages/agent-core/src/stubs/rail.ts

@@ -17,6 +17,14 @@ export interface StubRailOptions {
   refusePayees?: string[];
   /** Attempt ids the stub answers `uncertain` for, once. */
   uncertainOnce?: string[];
+  /**
+   * Payees whose first presentation answers `uncertain`, the way a timeout
+   * does: the provider still took the attempt, so a later lookup finds it.
+   * The payee twin of `refusePayees`, for scripting an unknown outcome in the
+   * MIDDLE of a multi-item execution, where the attempt ids are not known
+   * until the execution exists.
+   */
+  uncertainPayees?: string[];
   /** Test hook: called after the attempt is persisted and before the outcome is returned. */
   afterDispatch?: (attemptId: string) => void;
   /** Attempt ids whose first lookup answers `in_flight` and whose second lookup finds the provider finished (settled), with no pay() in between. */
@@ -40,6 +48,8 @@ export class StubRail implements PaymentRail {
   private readonly inFlightSeen = new Set<string>();
   /** Attempts that answered `uncertain` because the stub was armed: the "provider" did take them, and a later lookup finds them finished. */
   private readonly lateAttempts = new Set<string>();
+  /** Attempts that already gave their one `uncertain`, so a re-presentation behaves normally. */
+  private readonly uncertainAnswered = new Set<string>();
   /** How many times pay() reached the point of persisting a NEW attempt. */
   payCount = 0;
 
@@ -52,8 +62,10 @@ export class StubRail implements PaymentRail {
     const existing = this.store.stubRailGet(payment.attempt_id);
     if (existing) return existing.outcome as RailOutcome;
 
-    if (this.uncertainArmed || this.uncertainPending.has(payment.attempt_id)) {
-      if (this.uncertainArmed) this.lateAttempts.add(payment.attempt_id);
+    const uncertainPayee = this.options.uncertainPayees?.includes(payment.payee) === true && !this.uncertainAnswered.has(payment.attempt_id);
+    if (this.uncertainArmed || this.uncertainPending.has(payment.attempt_id) || uncertainPayee) {
+      if (this.uncertainArmed || uncertainPayee) this.lateAttempts.add(payment.attempt_id);
+      this.uncertainAnswered.add(payment.attempt_id);
       this.uncertainArmed = false;
       this.uncertainPending.delete(payment.attempt_id);
       return { status: "uncertain", code: "psp_dispatch_uncertain", message: "stub: outcome unknown on first presentation" };
@@ -117,6 +129,11 @@ export class StubRail implements PaymentRail {
       ...body,
       chain,
       receipt_sig: `stub:${sha256Hex(`sig:${chain}`).slice(0, 32)}`,
+      // The stub holds no CodeSpar key and must not look as though it did:
+      // `npm run verify` answers `unsigned` on a stub receipt, which is the
+      // truth about it.
+      receipt_sig_ed25519: null,
+      receipt_sig_kid: null,
       actor,
       raw: { stub: true, transaction_id: out.transaction_id },
     };

package/templates/bills-agent/packages/agent-core/src/types.ts

@@ -26,6 +26,32 @@ export interface ExecutionItem {
   due_date?: string;
 }
 
+/**
+ * The SET a line belongs to, when the line is one execution of a batch.
+ *
+ * A batch of N lines is N executions, each attested by its own `items_hash`.
+ * That leaves the list itself unattested: a person who approved four lines
+ * while the agent ran three leaves a bundle that does not say a fourth
+ * existed. `batch_hash` binds the set — computed once over the ordered lines
+ * at the moment the list is presented for approval, and carried by every
+ * artifact of that batch together with the line's own position in it.
+ *
+ * Absent on an execution that is not part of a batch, and an artifact
+ * without it is the artifact of section 4.2 unchanged, byte for byte: the
+ * field is omitted rather than null, so the canonical payload it signs is
+ * the same payload it signed before this existed.
+ */
+export interface ExecutionBatch {
+  /** The batch's reference, as the kit names it (`folha-2026-10`). */
+  ref: string;
+  /** `batchHash` over the batch's ordered lines, as they were presented. */
+  batch_hash: string;
+  /** This line's position in that ordered list, counting from 0. */
+  index: number;
+  /** How many lines the presented list held. */
+  count: number;
+}
+
 /** The trigger of section 4.4 that sent a `mandate` execution to a human. */
 export type EscalationTrigger = "amount" | "new_beneficiary" | "outside_hours";
 
@@ -74,6 +100,8 @@ export interface ApprovalArtifact {
   mandate: MandateRef;
   items: ExecutionItem[];
   items_hash: string;
+  /** Present when this execution is one line of a batch: what binds the SET this line was approved inside. */
+  batch?: ExecutionBatch;
   /** Present when a section 4.4 trigger sent the execution to a human first. */
   escalation?: { trigger: EscalationTrigger; detail: string };
   actor: Actor;

package/templates/bills-agent/packages/agent-core/test/approval.test.ts

@@ -1,8 +1,8 @@
 import { describe, expect, it } from "vitest";
 import { checkApprovalArtifact, createApprovalArtifact, hmacSigner } from "../src/approval.js";
-import { itemsHash } from "../src/hash.js";
+import { batchHash, itemsHash } from "../src/hash.js";
 import type { Execution } from "../src/state-machine.js";
-import type { Actor, ExecutionItem } from "../src/types.js";
+import type { Actor, ExecutionBatch, ExecutionItem } from "../src/types.js";
 
 const actor: Actor = { type: "human", id: "usr_1", channel: "terminal" };
 const signer = hmacSigner("test", Buffer.alloc(32, 7));
@@ -30,6 +30,7 @@ function execution(items: ExecutionItem[]): Execution<"awaiting_approval"> {
 }
 
 const escola: ExecutionItem = { alias: "escola", beneficiary: "Escola", payee: "escola@exemplo.com.br", amount: 185000, currency: "BRL" };
+const mercado: ExecutionItem = { alias: "mercado", beneficiary: "Mercado", payee: "+5511999990001", amount: 42000, currency: "BRL" };
 
 describe("section 4.2: approval artifact", () => {
   it("has the schema of the spec and an HMAC signature that verifies", () => {
@@ -69,6 +70,39 @@ describe("section 4.2: approval artifact", () => {
     expect(checkApprovalArtifact(signer, artifact, { ...exe, mandate: { id: "mdt_1", version: 4 } }, now)).toEqual({ ok: false, problem: "wrong_mandate" });
   });
 
+  it("carries the batch this line belongs to, and the whole of it is signed", () => {
+    const batch: ExecutionBatch = { ref: "folha-2026-10", batch_hash: batchHash([escola, mercado]), index: 0, count: 2 };
+    const exe = { ...execution([escola]), batch };
+    const artifact = createApprovalArtifact(signer, { execution: exe, approver: { type: "person", id: "usr_1", channel: "terminal" }, actor, now });
+    expect(artifact.batch).toEqual(batch);
+    expect(checkApprovalArtifact(signer, artifact, exe, now)).toEqual({ ok: true });
+    // Moving the line inside the list, re-pricing the list, or renaming it:
+    // each is a different set, and the signature covers all of it.
+    for (const changed of [{ ...batch, index: 1 }, { ...batch, count: 3 }, { ...batch, ref: "folha-2026-11" }, { ...batch, batch_hash: batchHash([escola]) }]) {
+      expect(checkApprovalArtifact(signer, { ...artifact, batch: changed }, exe, now)).toEqual({ ok: false, problem: "signature_invalid" });
+      expect(checkApprovalArtifact(signer, artifact, { ...exe, batch: changed }, now)).toEqual({ ok: false, problem: "batch_mismatch" });
+    }
+  });
+
+  it("an artifact with no batch signs the payload it signed before batches existed", () => {
+    const exe = execution([escola]);
+    const artifact = createApprovalArtifact(signer, { execution: exe, approver: { type: "person", id: "usr_1", channel: "terminal" }, actor, now });
+    // Omitted, never null: a bills-agent run has no batch and must not grow a key.
+    expect("batch" in artifact).toBe(false);
+    expect(checkApprovalArtifact(signer, artifact, exe, now)).toEqual({ ok: true });
+    // An execution that gained a batch after the artifact was signed is not the one that was approved.
+    const joined = { ...exe, batch: { ref: "folha-2026-10", batch_hash: batchHash([escola]), index: 0, count: 1 } };
+    expect(checkApprovalArtifact(signer, artifact, joined, now)).toEqual({ ok: false, problem: "batch_mismatch" });
+  });
+
+  it("the batch hash IS the items hash of the whole ordered list, so a reader can recompute it", () => {
+    expect(batchHash([escola, mercado])).toBe(itemsHash([escola, mercado]));
+    // Order is part of it: `index` names a position, and a position only means something in a fixed order.
+    expect(batchHash([mercado, escola])).not.toBe(batchHash([escola, mercado]));
+    // A line dropped is a different set, which is the whole point.
+    expect(batchHash([escola])).not.toBe(batchHash([escola, mercado]));
+  });
+
   it("records the escalation trigger when there was one", () => {
     const exe = execution([escola]);
     const artifact = createApprovalArtifact(signer, {

package/templates/bills-agent/packages/agent-core/test/bundle.test.ts

@@ -0,0 +1,85 @@
+/**
+ * Section 11: what the proof bundle has to carry for `npm run inspect` to
+ * answer "why could the agent pay this" from the folder alone — the rail's
+ * request and its answer per attempt, and a receipt path that travels with
+ * the bundle instead of naming the machine that wrote it.
+ */
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { describe, expect, it } from "vitest";
+import { maskPayee } from "../src/bundle.js";
+import { harness } from "./helpers.js";
+
+const approver = { id: "usr_demo", channel: "terminal" };
+
+async function settledRun() {
+  const h = harness({ mode: "human" });
+  const draft = await h.engine.draft({ items: [{ payee: "escola", amount: 185000, description: "outubro" }] });
+  if (!draft.ok) throw new Error("refused");
+  const approved = h.engine.approve(draft.execution.id, approver);
+  const settled = await h.engine.execute(approved.id);
+  return { h, settled };
+}
+
+describe("the proof bundle records the rail call and its answer", () => {
+  it("rail.dispatch names the idempotency key that makes a retry the same payment", async () => {
+    const { h, settled } = await settledRun();
+    const dispatch = h.bundle.readEvents().find((e) => e["type"] === "rail.dispatch");
+    expect(dispatch).toBeDefined();
+    const payload = dispatch!["payload"] as Record<string, unknown>;
+    expect(payload["idempotency_key"]).toBe(settled.idempotency_key);
+    expect(payload["attempt_id"]).toBe(settled.outcomes[0]?.attempt_id);
+    expect(payload["rail"]).toBe("stub");
+  });
+
+  it("rail.outcome carries what the rail answered: transaction, receipt and whether money moved", async () => {
+    const { h, settled } = await settledRun();
+    const outcome = h.bundle.readEvents().find((e) => e["type"] === "rail.outcome");
+    const payload = outcome!["payload"] as Record<string, unknown>;
+    expect(payload["status"]).toBe("settled");
+    expect(payload["receipt_id"]).toBe(settled.outcomes[0]?.receipt_id);
+    expect(payload["transaction_id"]).toBe(settled.outcomes[0]?.transaction_id);
+    expect(payload["money_moved"]).toBe(false);
+    expect(payload["sandbox"]).toBe(true);
+    // Never the provider's echo: `raw` may carry payer data the bundle does not promise to mask.
+    expect(payload["raw"]).toBeUndefined();
+  });
+
+  it("a refused attempt records the rail's own code and message", async () => {
+    const h = harness({ mode: "human", rail: { refusePayees: ["escola@exemplo.com.br"] } });
+    const draft = await h.engine.draft({ items: [{ payee: "escola", amount: 185000 }] });
+    if (!draft.ok) throw new Error("refused");
+    const approved = h.engine.approve(draft.execution.id, approver);
+    await h.engine.execute(approved.id);
+    const outcome = h.bundle.readEvents().find((e) => e["type"] === "rail.outcome");
+    const payload = outcome!["payload"] as Record<string, unknown>;
+    expect(payload["status"]).toBe("failed");
+    expect(payload["code"]).toBeTypeOf("string");
+    expect(payload["message"]).toBeTypeOf("string");
+  });
+
+  it("receipt.saved names the file inside the bundle, not the machine that wrote it", async () => {
+    const { h } = await settledRun();
+    const saved = h.bundle.readEvents().find((e) => e["type"] === "receipt.saved");
+    const path = (saved!["payload"] as { path: string }).path;
+    expect(path).toMatch(/^receipts\//);
+    expect(path).not.toContain(h.bundle.dir);
+    const receipt = JSON.parse(readFileSync(join(h.bundle.dir, path), "utf8")) as { payment: { payee: string } };
+    expect(receipt.payment.payee).toBe(maskPayee("escola@exemplo.com.br"));
+  });
+
+  it("the mandate snapshot carries the version the approval artifact names", async () => {
+    const { h, settled } = await settledRun();
+    h.bundle.mandateSnapshot(h.engine.mandate);
+    const snapshot = JSON.parse(readFileSync(join(h.bundle.dir, "mandate.snapshot.json"), "utf8")) as { version: number; signature?: string };
+    expect(snapshot.version).toBe(settled.mandate.version);
+    expect(snapshot.signature).toBeUndefined();
+    expect(h.bundle.readApprovals()[0]?.mandate.version).toBe(snapshot.version);
+  });
+
+  it("maskPayee is idempotent, so a reader may apply it to a value the bundle already masked", () => {
+    for (const raw of ["escola@exemplo.com.br", "+5511999990001", "12345678909", "*"]) {
+      expect(maskPayee(maskPayee(raw))).toBe(maskPayee(raw));
+    }
+  });
+});