@render-foundation/utils 0.0.249 → 0.0.250

package/lib/esm/src/client/pg/v2Client.js

@@ -38,70 +38,94 @@ export const EUR_TO_CREDITS = BigInt(4);
 // emissions-funded ones (counting only emissions-attributed spend over-issued ~2.58M credits, 2026-08-04).
 export const GRANT_WINDOW_START = '2025-05-01';
 export const CREDIT_DECIMALS = BigInt(100000000); // 1e8
-/**
- * Pure core of the grant allotment: fold a user's OTOY grants against what's already been spent.
- *
- * consumed = attributedSpend (spend already stamped with an otoy_grant_id)
- *          + correctionSettled (jobs whose grant is already being settled by a burn_correction)
- *
- * The correctionSettled term is the DOUBLE-SPEND GUARD: an escrow_credit correction means we're
- * recovering that job's dollars from escrow, so its grant is already committed. Counting it here stops
- * the same grant from also funding a future emissions burn.
- *
- * fifoGrantId = the oldest grant still holding room, i.e. the one the next spend draws from.
- */
-/**
- * Time-aware reservoir fold. Events = grant issuances (+, at issue time) and job spend (−, at job time),
- * processed chronologically: a job may only draw entitlement that existed WHEN IT RAN. Spend beyond the
- * balance at that moment is purchase-paid forever — a later grant must not retroactively absorb it
- * (the aggregate `granted − allSpend` formula did exactly that, under-issuing 256 users / 44,243 credits;
- * it also let the UI attribute jobs to grants issued days after they ran).
- *
- * Identity used everywhere (SQL + client): with net = Σamt and overshoot = max prefix deficit,
- *   avail = max(net + overshoot, 0);  beyondGrants = overshoot.
- */
-export const foldTimeAware = (events) => {
-    // True reservoir semantics, chronological:
-    //   grant +  -> capacity += amt
-    //   grant −  -> capacity = max(capacity + amt, 0)  (a REVERSAL claws back capacity; it is not spend
-    //               and can never create "beyond grants" — the linear min-run identity got this wrong:
-    //               a reversal ordered before its covering positives produced phantom overshoot)
-    //   job      -> draw min(need, capacity); the un-drawable remainder is purchase-paid forever
+// A grant is consumable for this long after issuance; whatever is left after that EXPIRES (2026-08-05
+// model change). A job can only draw grants issued within the lookback window before it ran.
+export const GRANT_LOOKBACK_DAYS = 60;
+export const GRANT_LOOKBACK_MS = GRANT_LOOKBACK_DAYS * 24 * 3600 * 1000;
+export const foldGrantWindow = (events, opts = {}) => {
+    const lookback = opts.lookbackMs ?? GRANT_LOOKBACK_MS;
+    const now = opts.now ?? Date.now();
     const sorted = [...events].sort((a, b) => a.t - b.t || (a.amt > b.amt ? -1 : 1)); // credits first on ties
-    let cap = BigInt(0);
+    const buckets = [];
+    const remaining = (b) => b.amount - b.reversed - b.drawnEmissions - b.drawnMisrouted;
     let beyond = BigInt(0);
-    let charged = BigInt(0);
     for (const e of sorted) {
         if (e.src === 'grant') {
-            cap += e.amt;
-            if (cap < BigInt(0))
-                cap = BigInt(0);
+            if (e.amt > BigInt(0)) {
+                buckets.push({
+                    grantId: e.grantId,
+                    t: e.t,
+                    amount: e.amt,
+                    reversed: BigInt(0),
+                    drawnEmissions: BigInt(0),
+                    drawnMisrouted: BigInt(0),
+                    expired: BigInt(0),
+                    left: BigInt(0),
+                });
+            }
+            else {
+                let claw = -e.amt; // clawback hits remaining capacity oldest-first; excess is dropped
+                for (const b of buckets) {
+                    if (claw <= BigInt(0))
+                        break;
+                    const take = remaining(b) < claw ? remaining(b) : claw;
+                    if (take > BigInt(0)) {
+                        b.reversed += take;
+                        claw -= take;
+                    }
+                }
+            }
         }
         else {
-            const need = -e.amt; // job events are negative
-            const take = need < cap ? need : cap;
-            cap -= take;
-            charged += take;
-            beyond += need - take;
+            let need = -e.amt;
+            let emissionsLeft = e.emissions ?? need; // no split provided -> count it all as emissions
+            for (const b of buckets) {
+                if (need <= BigInt(0))
+                    break;
+                if (b.t + lookback < e.t)
+                    continue; // grant expired before this job ran
+                const take = remaining(b) < need ? remaining(b) : need;
+                if (take <= BigInt(0))
+                    continue;
+                const em = emissionsLeft < take ? emissionsLeft : take;
+                b.drawnEmissions += em;
+                b.drawnMisrouted += take - em;
+                emissionsLeft -= em;
+                need -= take;
+            }
+            beyond += need;
         }
     }
-    return { avail: cap, beyondGrants: beyond, jobCharged: charged };
-};
-export const foldGrantAllotment = (grants, attributedSpend, correctionSettled) => {
-    const granted = grants.reduce((s, g) => s + g.amountCredits, BigInt(0));
-    const consumed = (attributedSpend > BigInt(0) ? attributedSpend : BigInt(0)) +
-        (correctionSettled > BigInt(0) ? correctionSettled : BigInt(0));
-    const avail = granted > consumed ? granted - consumed : BigInt(0);
-    let drawn = consumed;
+    let avail = BigInt(0);
+    let expired = BigInt(0);
+    let usedEmissions = BigInt(0);
+    let usedMisrouted = BigInt(0);
     let fifoGrantId;
-    for (const g of grants) {
-        if (drawn < g.amountCredits) {
-            fifoGrantId = g.id;
-            break;
+    for (const b of buckets) {
+        usedEmissions += b.drawnEmissions;
+        usedMisrouted += b.drawnMisrouted;
+        const rem = remaining(b);
+        if (b.t + lookback < now) {
+            b.expired = rem;
+        }
+        else {
+            b.left = rem;
+            avail += rem;
+            if (fifoGrantId === undefined && rem > BigInt(0) && b.grantId !== undefined)
+                fifoGrantId = b.grantId;
         }
-        drawn -= g.amountCredits;
+        expired += b.expired;
     }
-    return { granted, consumed, avail, fifoGrantId };
+    return {
+        avail,
+        beyondGrants: beyond,
+        jobCharged: usedEmissions + usedMisrouted,
+        usedEmissions,
+        usedMisrouted,
+        expired,
+        buckets,
+        fifoGrantId,
+    };
 };
 import { begin } from './base';
 import moment from 'moment';
@@ -231,75 +255,50 @@ export const pgClient = (config) => {
         const out = {};
         if (!p.userIds.length)
             return out;
-        const grants = await db
-            .selectFrom(OTOY_GRANT_TABLE)
-            .select(['id', 'user_id', 'amount_credits', 'otoy_created_at'])
-            .where('user_id', 'in', p.userIds)
-            .orderBy('otoy_created_at', 'asc')
-            .orderBy('id', 'asc')
-            .execute();
-        if (!grants.length)
-            return out;
-        // EVERY grant-ledger row retires pool capacity, in either direction:
-        //  - negative delta = an emissions burn. ALL of them count, not just ones stamped with an
-        //    otoy_grant_id. Historical grants are now backfilled to cover the Sep/Oct-2025 burns, so those
-        //    burns must net against them; counting only stamped rows would re-issue ~1.06M credits of
-        //    already-spent grant.
-        //  - positive delta = the grant was CREDITED into current_user_grant_spend (the one-off canary
-        //    route). That balance reaches the split separately, so leaving it in the pool double-issues it.
-        // Hence abs() over the whole ledger.
-        // NOT abs() over the whole ledger — that would charge the Sep/Oct-2025 CSV *credits* as if they
-        // were spend, double-penalising those users (464e8e33: 376,749 burned + 79,304 credited = 456,053).
-        // A positive only retires capacity when it is tied to a pool grant (the canary route, where the
-        // grant was moved into current_user_grant_spend and reaches the split from there).
-        const spent = await db
-            .selectFrom(USER_GRANT_SPEND_TABLE)
-            .select((eb) => [
-            'user_id',
-            eb.fn
-                .sum(sql `case when render_spent_delta < 0 then -render_spent_delta
-                     when otoy_grant_id is not null then render_spent_delta
-                     else 0 end`)
-                .as('net'),
-        ])
-            .where('user_id', 'in', p.userIds)
-            .groupBy('user_id')
-            .execute();
-        // Fetch the raw event stream and fold in code (foldTimeAware — reservoir semantics; reversals
-        // clamp capacity, only jobs create beyond-grants). SQL window identities can't express the clamp.
+        // Raw event stream, folded in code (foldGrantWindow — per-grant buckets, 60-day consumable window,
+        // reversals clamp capacity, only jobs create beyond-grants). SQL can't express the bucketed clamp.
         const evRes = await sql `
       select user_id::text as u, coalesce(otoy_created_at, ${GRANT_WINDOW_START}::timestamp) as t,
-             (amount_credits * 4 * 1e8)::numeric::text as amt, 'grant' as src
+             (amount_credits * 4 * 1e8)::numeric::text as amt, 'grant' as src, id as gid
         from otoy_grant where user_id = any(${p.userIds}::uuid[])
       union all
-      select user_id::text, ${GRANT_WINDOW_START}::timestamp, sum(render_spent_delta)::text, 'grant'
+      select user_id::text, ${GRANT_WINDOW_START}::timestamp, sum(render_spent_delta)::text, 'grant', null
         from user_grant_spend
        where user_id = any(${p.userIds}::uuid[]) and render_spent_delta > 0 and otoy_grant_id is null
        group by user_id
       union all
-      select user_id::text, created_at, (-render_spent_delta)::text, 'grant'
+      select user_id::text, created_at, (-render_spent_delta)::text, 'grant', null
         from user_grant_spend
        where user_id = any(${p.userIds}::uuid[]) and render_spent_delta > 0 and otoy_grant_id is not null
       union all
-      select user_id, completed_at, (-render_amt)::text, 'job'
+      select user_id, completed_at, (-render_amt)::text, 'job', null
         from job
        where user_id = any(${p.userIds}::text[]) and completed_at >= ${GRANT_WINDOW_START}::timestamp
     `.execute(db); // db is always a Kysely trx at runtime
         const byUser = new Map();
         for (const r of evRes.rows) {
             const arr = byUser.get(r.u) ?? [];
-            arr.push({ t: new Date(r.t).getTime(), amt: BigInt(Math.round(Number(r.amt))), src: r.src });
+            arr.push({
+                t: new Date(r.t).getTime(),
+                amt: BigInt(Math.round(Number(r.amt))),
+                src: r.src,
+                grantId: r.gid ?? undefined,
+            });
             byUser.set(r.u, arr);
         }
         for (const [u, events] of byUser) {
-            const cur = out[u] ??
-                (out[u] = { userId: u, granted: BigInt(0), consumed: BigInt(0), avail: BigInt(0), grants: [] });
-            const f = foldTimeAware(events);
-            cur.granted = events.reduce((a, e) => (e.src === 'grant' && e.amt > BigInt(0) ? a + e.amt : a), BigInt(0));
-            cur.consumed = f.jobCharged;
-            cur.avail = f.avail;
+            const f = foldGrantWindow(events);
+            out[u] = {
+                userId: u,
+                granted: events.reduce((a, e) => (e.src === 'grant' && e.amt > BigInt(0) ? a + e.amt : a), BigInt(0)),
+                consumed: f.jobCharged,
+                avail: f.avail,
+                expired: f.expired,
+                fifoGrantId: f.fifoGrantId,
+            };
             if (f.beyondGrants > BigInt(0)) {
-                log.info(`grant allotment ${u}: ${f.beyondGrants} beyond grants (purchase-paid at the time) — avail ${f.avail}`);
+                log.info(`grant allotment ${u}: ${f.beyondGrants} beyond grants (purchase-paid at the time), ` +
+                    `${f.expired} expired past the ${GRANT_LOOKBACK_DAYS}d window — avail ${f.avail}`);
             }
         }
         return out;
@@ -1153,16 +1152,13 @@ export const pgClient = (config) => {
                         return;
                     }
                 }
-                // FIFO-attribute this spend to the user's oldest OTOY grant that still has room. Stamping
-                // otoy_grant_id is what makes getGrantAllotments count it as consumed — an unattributed row
-                // would leave the grant looking unspent and let it fund a second burn.
+                // FIFO-attribute this spend to the user's oldest LIVE OTOY grant that still has room (the fold
+                // already applies the lookback window). Stamping otoy_grant_id is what shows the draw in the
+                // admin drill-down — an unattributed row would leave the grant looking unspent there.
                 let otoyGrantId = p.otoyGrantId;
                 if (otoyGrantId === undefined && p.renderSpentDelta < BigInt(0)) {
                     const allots = await getGrantAllotments(db.trx, { userIds: [p.userId] }, log);
-                    const a = allots[p.userId];
-                    if (a) {
-                        otoyGrantId = foldGrantAllotment(a.grants, a.consumed, BigInt(0)).fifoGrantId;
-                    }
+                    otoyGrantId = allots[p.userId]?.fifoGrantId;
                 }
                 const v = {
                     user_id: p.userId,