@obbyx/x402-obyte 0.2.1 → 0.2.2

package/src/batch/facilitator.ts

@@ -186,8 +186,7 @@ export class BatchObyteFacilitator implements SchemeNetworkFacilitator {
     channelKey: string,
     network: Network,
   ): Promise<SettleResponse> {
-    const store = this.options.store;
-    let commitment = await store.commitmentByHash(c.packageHash);
+    let commitment = await this.options.store.commitmentByHash(c.packageHash);
     if (commitment !== undefined && commitment.binding !== c.voucher.binding) {
       return failure(
         network,
@@ -196,96 +195,123 @@ export class BatchObyteFacilitator implements SchemeNetworkFacilitator {
       );
     }
     if (commitment === undefined) {
-      const appended = await store.appendPending({
-        channelKey,
-        network: c.req.network.caip2,
-        aa: c.voucher.aa_address,
-        payTo: c.req.payTo,
-        payer: c.payer,
-        asset: c.req.asset,
-        period: c.voucher.period,
-        amountSpent: BigInt(c.voucher.amount_spent),
-        paymentAmount: BigInt(c.voucher.payment_amount),
-        binding: c.voucher.binding,
-        packageHash: c.packageHash,
-        packageJson: c.packageJson,
-      });
-      if (!appended.ok) {
-        const reason =
-          appended.reason === 'channel_busy'
-            ? R.busy
-            : appended.reason === 'period_mismatch'
-              ? R.period
-              : R.cumulative;
-        await this.emit({
-          key: channelKey,
-          kind: 'voucher_refused',
-          data: {
-            reason,
-            amountSpent: c.voucher.amount_spent,
-            committed: appended.committed.toString(),
-          },
-        });
-        return {
-          ...failure(network, reason, `Voucher rejected: ${appended.reason}`),
-          extra: { chargedCumulativeAmount: appended.committed.toString() },
-        };
-      }
-      commitment = appended.commitment;
-      await this.emit({
-        key: channelKey,
-        kind: 'voucher_pending',
-        data: {
-          seq: commitment.seq,
-          period: commitment.period,
-          amountSpent: commitment.amountSpent.toString(),
-        },
-      });
-      this.log.info(
-        { seq: commitment.seq, amountSpent: commitment.amountSpent.toString() },
-        'voucher pending',
-      );
+      const appended = await this.append(c, channelKey, network);
+      if ('success' in appended) return appended;
+      commitment = appended;
     }
-
     if (commitment.state === 'pending') {
-      const delivered = await this.options.gateway.deliver(commitment, this.ackTimeoutMs);
-      if (delivered !== 'acked') {
-        // Stored here but not yet confirmed by the seller's watcher: the outcome
-        // is unknown to the client → settlement_pending (x402: non-empty
-        // transaction), retried with the SAME voucher. Distinct from the
-        // definite refusal `…_watcher_unavailable` at verification.
-        this.log.warn(
-          { seq: commitment.seq },
-          'watcher did not ack in time; voucher stays pending',
-        );
-        await this.emit({ key: channelKey, kind: 'ack_timeout', data: { seq: commitment.seq } });
-        return {
-          success: false,
-          errorReason: 'settlement_pending',
-          errorMessage:
-            "Waiting for the seller's watcher to store this voucher; retry with the same voucher",
-          transaction: commitmentIdOf(network, commitment),
-          network,
-          payer: c.payer,
-        };
-      }
-      commitment =
-        (await store.commit(commitment.seq, {
-          payTo: commitment.payTo,
-          network: commitment.network,
-        })) ?? commitment;
-      this.log.info({ seq: commitment.seq }, 'voucher committed (watcher ack)');
+      const committed = await this.handToWatcher(c, commitment, channelKey, network);
+      if ('success' in committed) return committed;
+      commitment = committed;
+    }
+    return this.success(network, c, commitment);
+  }
+
+  /**
+   * Appends the voucher to the channel journal as pending. The store enforces
+   * committed + price, the period and one voucher in flight per channel; a
+   * refusal reports the committed amount so an honest client can resync.
+   */
+  private async append(
+    c: Authenticated,
+    channelKey: string,
+    network: Network,
+  ): Promise<CommitmentRow | SettleResponse> {
+    const appended = await this.options.store.appendPending({
+      channelKey,
+      network: c.req.network.caip2,
+      aa: c.voucher.aa_address,
+      payTo: c.req.payTo,
+      payer: c.payer,
+      asset: c.req.asset,
+      period: c.voucher.period,
+      amountSpent: BigInt(c.voucher.amount_spent),
+      paymentAmount: BigInt(c.voucher.payment_amount),
+      binding: c.voucher.binding,
+      packageHash: c.packageHash,
+      packageJson: c.packageJson,
+    });
+    if (!appended.ok) {
+      const reason =
+        appended.reason === 'channel_busy'
+          ? R.busy
+          : appended.reason === 'period_mismatch'
+            ? R.period
+            : R.cumulative;
       await this.emit({
         key: channelKey,
-        kind: 'voucher_committed',
+        kind: 'voucher_refused',
         data: {
-          seq: commitment.seq,
-          period: commitment.period,
-          amountSpent: commitment.amountSpent.toString(),
+          reason,
+          amountSpent: c.voucher.amount_spent,
+          committed: appended.committed.toString(),
         },
       });
+      return {
+        ...failure(network, reason, `Voucher rejected: ${appended.reason}`),
+        extra: { chargedCumulativeAmount: appended.committed.toString() },
+      };
     }
-    return this.success(network, c, commitment);
+    const commitment = appended.commitment;
+    await this.emit({
+      key: channelKey,
+      kind: 'voucher_pending',
+      data: {
+        seq: commitment.seq,
+        period: commitment.period,
+        amountSpent: commitment.amountSpent.toString(),
+      },
+    });
+    this.log.info(
+      { seq: commitment.seq, amountSpent: commitment.amountSpent.toString() },
+      'voucher pending',
+    );
+    return commitment;
+  }
+
+  /**
+   * Delivers a pending voucher to the seller's watcher and commits it on its
+   * ack. Without the ack the voucher is stored here but not confirmed by the
+   * watcher: the outcome is unknown to the client → settlement_pending (x402:
+   * non-empty transaction), retried with the SAME voucher. Distinct from the
+   * definite refusal `…_watcher_unavailable` at verification.
+   */
+  private async handToWatcher(
+    c: Authenticated,
+    pending: CommitmentRow,
+    channelKey: string,
+    network: Network,
+  ): Promise<CommitmentRow | SettleResponse> {
+    const delivered = await this.options.gateway.deliver(pending, this.ackTimeoutMs);
+    if (delivered !== 'acked') {
+      this.log.warn({ seq: pending.seq }, 'watcher did not ack in time; voucher stays pending');
+      await this.emit({ key: channelKey, kind: 'ack_timeout', data: { seq: pending.seq } });
+      return {
+        success: false,
+        errorReason: 'settlement_pending',
+        errorMessage:
+          "Waiting for the seller's watcher to store this voucher; retry with the same voucher",
+        transaction: commitmentIdOf(network, pending),
+        network,
+        payer: c.payer,
+      };
+    }
+    const commitment =
+      (await this.options.store.commit(pending.seq, {
+        payTo: pending.payTo,
+        network: pending.network,
+      })) ?? pending;
+    this.log.info({ seq: commitment.seq }, 'voucher committed (watcher ack)');
+    await this.emit({
+      key: channelKey,
+      kind: 'voucher_committed',
+      data: {
+        seq: commitment.seq,
+        period: commitment.period,
+        amountSpent: commitment.amountSpent.toString(),
+      },
+    });
+    return commitment;
   }
 
   private success(

package/src/exact/client.ts

@@ -9,7 +9,11 @@ import { type Logger, moduleLogger } from '@obbyx/obyte/logger';
 import type obyte from 'obyte';
 import type { ReservingComposer } from '../coins/index.js';
 import { type PaymentRequirementsV1, requirementsV1ToV2 } from './facilitator-v1.js';
-import { EXACT_SCHEME, parseExactRequirements } from './requirements.js';
+import {
+  EXACT_SCHEME,
+  type ParsedExactRequirements,
+  parseExactRequirements,
+} from './requirements.js';
 
 /**
  * Client side of `exact` on Obyte: composes and signs (but does NOT
@@ -55,6 +59,36 @@ export class ExactObyteClient implements SchemeNetworkClient {
     requirements: PaymentRequirements,
     context?: PaymentPayloadContext,
   ): Promise<PaymentPayloadResult> {
+    const req = this.acceptable(x402Version, requirements, context);
+    const unit = await this.signUnit(req);
+    this.log.info(
+      {
+        proofId: unit['unit'],
+        payTo: req.payTo,
+        asset: req.asset,
+        amount: req.amount.toString(),
+        binding: req.extra.binding,
+      },
+      'payment unit signed (not broadcast)',
+    );
+    // v1: the mechanism returns the complete payload (core passes it through as-is).
+    if (x402Version === 1) {
+      return {
+        x402Version: 1,
+        scheme: EXACT_SCHEME,
+        network: requirements.network,
+        payload: { unit },
+      } as unknown as PaymentPayloadResult;
+    }
+    return { x402Version, payload: { unit } };
+  }
+
+  /** The requirements, if this client may pay them (network, limits, offer still valid). */
+  private acceptable(
+    x402Version: number,
+    requirements: PaymentRequirements,
+    context: PaymentPayloadContext | undefined,
+  ): ParsedExactRequirements {
     if (x402Version !== 1 && x402Version !== 2) {
       throw new ObbyxError('invalid_x402_version', 'Only x402 v1 and v2 are supported');
     }
@@ -85,7 +119,14 @@ export class ExactObyteClient implements SchemeNetworkClient {
     if (req.extra.validUntil < Math.floor(Date.now() / 1000)) {
       throw new ObbyxError('quote_expired', 'The payment offer has expired');
     }
+    return req;
+  }
 
+  /**
+   * Composes and signs (never broadcasts) the unit: one output to payTo and the
+   * binding in a data message. Refuses it when the network fee is above the limit.
+   */
+  private async signUnit(req: ParsedExactRequirements): Promise<Record<string, unknown>> {
     const output = { address: req.payTo, amount: toSafeNumber(req.amount) };
     const payment =
       req.asset === 'base'
@@ -95,7 +136,6 @@ export class ExactObyteClient implements SchemeNetworkClient {
       app: 'data',
       payload: { x402: { binding: req.extra.binding, quoteId: req.extra.quoteId } },
     };
-
     const compose = () =>
       this.options.client.compose.message('multi', [payment, data] as never, {
         privateKey: this.options.privateKey,
@@ -120,25 +160,6 @@ export class ExactObyteClient implements SchemeNetworkClient {
         `Network fee ${fee} exceeds the limit ${this.options.maxFee} bytes`,
       );
     }
-    this.log.info(
-      {
-        proofId: unit['unit'],
-        payTo: req.payTo,
-        asset: req.asset,
-        amount: req.amount.toString(),
-        binding: req.extra.binding,
-      },
-      'payment unit signed (not broadcast)',
-    );
-    // v1: the mechanism returns the complete payload (core passes it through as-is).
-    if (x402Version === 1) {
-      return {
-        x402Version: 1,
-        scheme: EXACT_SCHEME,
-        network: requirements.network,
-        payload: { unit },
-      } as unknown as PaymentPayloadResult;
-    }
-    return { x402Version, payload: { unit } };
+    return unit;
   }
 }

package/src/exact/facilitator.ts

@@ -90,6 +90,8 @@ export class ExactObyteFacilitator implements SchemeNetworkFacilitator {
   private readonly now: () => number;
   /** Serializes settle/resume per settlement key inside this process. */
   private readonly inFlight = new Map<string, Promise<SettleResponse>>();
+  /** Known plain (non-AA) recipients; an address can never turn into an AA. */
+  private readonly plainRecipients = new Set<string>();
 
   constructor(private readonly options: ExactObyteFacilitatorOptions) {
     this.log = moduleLogger(options.logger, 'x402.exact', { scheme: EXACT_SCHEME });
@@ -264,7 +266,6 @@ export class ExactObyteFacilitator implements SchemeNetworkFacilitator {
         now: this.now,
       },
       client,
-      req,
       facts,
       unit as Record<string, unknown>,
     );
@@ -272,9 +273,6 @@ export class ExactObyteFacilitator implements SchemeNetworkFacilitator {
     return { ok: true, value: { facts, req } };
   }
 
-  /** Known plain (non-AA) recipients; an address can never turn into an AA. */
-  private readonly plainRecipients = new Set<string>();
-
   private async recipientIsNotAa(client: obyte.Client, payTo: string): Promise<Check<null>> {
     if (this.plainRecipients.has(payTo)) return { ok: true, value: null };
     const res = await hubCall(() => client.api.getDefinition(payTo), this.hubTimeoutMs);

package/src/exact/ledger-checks.ts

@@ -3,7 +3,6 @@ import type { ExactUnitFacts } from '@obbyx/obyte';
 import { hubCall } from '../hub/hub-call.js';
 import { type LedgerUnit, parseHistory, parseLedgerUnit } from '../hub/schemas.js';
 import { type Check, EXACT_SETTLE_REASONS, fail } from './reasons.js';
-import type { ParsedExactRequirements } from './requirements.js';
 
 export interface LedgerCheckContext {
   readonly hubTimeoutMs: number;
@@ -18,12 +17,25 @@ export interface LedgerCheckContext {
 export async function checkLedger(
   ctx: LedgerCheckContext,
   client: obyte.Client,
-  req: ParsedExactRequirements,
   facts: ExactUnitFacts,
   unit: Record<string, unknown>,
 ): Promise<Check<null>> {
-  const t = ctx.hubTimeoutMs;
-  const lastBall = await hubCall(() => client.api.getJoint(facts.lastBallUnit), t);
+  const recent = await lastBallIsRecent(ctx, client, facts);
+  if (!recent.ok) return recent;
+  const totals = await inputTotals(ctx, client, facts);
+  if (!totals.ok) return totals;
+  const balanced = inputsBalance(totals.value, facts, unit);
+  if (!balanced.ok) return balanced;
+  return inputsUnspent(ctx, client, facts);
+}
+
+/** The unit's last ball exists and is not older than the configured limit. */
+async function lastBallIsRecent(
+  ctx: LedgerCheckContext,
+  client: obyte.Client,
+  facts: ExactUnitFacts,
+): Promise<Check<null>> {
+  const lastBall = await hubCall(() => client.api.getJoint(facts.lastBallUnit), ctx.hubTimeoutMs);
   if (lastBall.kind !== 'ok')
     return fail(EXACT_SETTLE_REASONS.ledger, `last ball: ${lastBall.error}`);
   const lastBallTs = lastBall.value.joint?.unit.timestamp;
@@ -36,14 +48,21 @@ export async function checkLedger(
       `Last ball is ${lastBallAge} s old; the limit is ${ctx.maxLastBallAgeSeconds} s (MAX_LAST_BALL_AGE_SECONDS)`,
     );
   }
+  return { ok: true, value: null };
+}
 
-  // Inputs: each referenced output exists, belongs to the payer, has the right asset.
+/** Each input refers to an existing output of the payer in its asset; sums per asset. */
+async function inputTotals(
+  ctx: LedgerCheckContext,
+  client: obyte.Client,
+  facts: ExactUnitFacts,
+): Promise<Check<Map<string, bigint>>> {
   const totals = new Map<string, bigint>();
   const sources = new Map<string, LedgerUnit>();
   for (const input of facts.inputs) {
     let source = sources.get(input.unit);
     if (source === undefined) {
-      const res = await hubCall(() => client.api.getJoint(input.unit), t);
+      const res = await hubCall(() => client.api.getJoint(input.unit), ctx.hubTimeoutMs);
       if (res.kind !== 'ok') return fail(EXACT_SETTLE_REASONS.ledger, `input source: ${res.error}`);
       if (res.value.joint === undefined)
         return fail(EXACT_SETTLE_REASONS.inputs, 'Input source unit not found');
@@ -71,6 +90,15 @@ export async function checkLedger(
     }
     totals.set(asset, (totals.get(asset) ?? 0n) + BigInt(output.amount));
   }
+  return { ok: true, value: totals };
+}
+
+/** Inputs equal outputs per asset; bytes also cover every fee of the unit. */
+function inputsBalance(
+  totals: ReadonlyMap<string, bigint>,
+  facts: ExactUnitFacts,
+  unit: Record<string, unknown>,
+): Check<null> {
   const fees =
     BigInt(facts.commissions.headers + facts.commissions.payload) +
     BigInt((unit['tps_fee'] as number | undefined) ?? 0) +
@@ -81,9 +109,18 @@ export async function checkLedger(
       return fail(EXACT_SETTLE_REASONS.inputs, `Inputs and outputs do not balance in ${asset}`);
     }
   }
+  return { ok: true, value: null };
+}
 
-  // Unspent: no other unit of the payer spends these inputs (best effort
-  // until stability; the network decides double-spends definitively).
+/**
+ * No other unit of the payer spends these inputs (best effort until
+ * stability; the network decides double spends definitively).
+ */
+async function inputsUnspent(
+  ctx: LedgerCheckContext,
+  client: obyte.Client,
+  facts: ExactUnitFacts,
+): Promise<Check<null>> {
   const history = await hubCall(
     () =>
       client.api
@@ -91,7 +128,7 @@ export async function checkLedger(
         .then((witnesses) =>
           client.api.getHistory({ witnesses, addresses: [facts.payer] } as never),
         ),
-    t,
+    ctx.hubTimeoutMs,
   );
   if (history.kind !== 'ok') return fail(EXACT_SETTLE_REASONS.ledger, `history: ${history.error}`);
   const parsedHistory = parseHistory(history.value);

package/src/hub/schemas.ts

@@ -87,3 +87,32 @@ export function parseStateVars(raw: unknown): Record<string, unknown> | undefine
   const parsed = z.record(z.string(), z.unknown()).safeParse(raw);
   return parsed.success ? parsed.data : undefined;
 }
+
+/** Balance of one asset: confirmed (stable) and not yet confirmed (pending), atomic units. */
+export interface AssetBalance {
+  readonly stable: bigint;
+  readonly pending: bigint;
+}
+
+const balancesSchema = z.record(
+  z.string(),
+  z.record(z.string(), z.object({ stable: safeAmount, pending: safeAmount }).loose()),
+);
+
+/**
+ * `light/get_balances` for one address: balances by asset ('base' = bytes);
+ * an address without funds has none. Undefined when the answer is malformed.
+ */
+export function parseBalances(
+  raw: unknown,
+  address: string,
+): Record<string, AssetBalance> | undefined {
+  const parsed = balancesSchema.safeParse(raw);
+  if (!parsed.success) return undefined;
+  return Object.fromEntries(
+    Object.entries(parsed.data[address] ?? {}).map(([asset, b]) => [
+      asset,
+      { stable: BigInt(b.stable), pending: BigInt(b.pending) },
+    ]),
+  );
+}

package/src/index.ts

@@ -107,5 +107,7 @@ export {
   parseHistory,
   parseLedgerUnit,
   parseStateVars,
+  type AssetBalance,
+  parseBalances,
 } from './hub/schemas.js';
 export { KeyedQueue } from './util/keyed-queue.js';