@render-foundation/utils 0.0.254 → 0.0.255

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

@@ -33,34 +33,114 @@ BigInt.prototype.toJSON = function () {
 // confirmed_amount = EUR, despite the column name); 1 render credit = EUR 0.25, so credits = EUR x 4.
 // job.render_amt / user_grant_spend.render_spent_delta are credits x 1e8.
 export const EUR_TO_CREDITS = BigInt(4);
+// Grant accounting window: otoy_grant mirrors OTOY RFG issuances from this date. Consumption against the
+// window counts EVERY job the user ran in it — buy-and-burn jobs consumed OTOY credits exactly like
+// 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.
- */
-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;
+// 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
+    const buckets = [];
+    const jobs = [];
+    const remaining = (b) => b.amount - b.reversed - b.drawnEmissions - b.drawnMisrouted;
+    let beyond = BigInt(0);
+    for (const e of sorted) {
+        if (e.src === 'grant') {
+            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 {
+            let need = -e.amt;
+            const total = need;
+            let emissionsLeft = e.emissions ?? need; // no split provided -> count it all as emissions
+            let jobEm = BigInt(0);
+            let jobMis = BigInt(0);
+            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;
+                jobEm += em;
+                jobMis += take - em;
+                emissionsLeft -= em;
+                need -= take;
+            }
+            beyond += need;
+            jobs.push({
+                id: e.id,
+                t: e.t,
+                need: total,
+                drawnEmissions: jobEm,
+                drawnMisrouted: jobMis,
+                beyond: need,
+            });
+        }
+    }
+    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,
+        jobs,
+        fifoGrantId,
+    };
 };
 import { begin } from './base';
 import moment from 'moment';
@@ -190,63 +270,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;
-        // Anything already booked against a pool grant, in EITHER direction:
-        //  - negative delta = spend drawn from the grant (this mechanism)
-        //  - positive delta = the grant was CREDITED into current_user_grant_spend (the one-off canary
-        //    route). That balance is already handed to the caller separately, so leaving it in the pool too
-        //    would hand out the same grant twice.
-        // Hence abs(): both directions retire pool capacity.
-        const spent = await db
-            .selectFrom(USER_GRANT_SPEND_TABLE)
-            .select((eb) => [
-            'user_id',
-            eb.fn.sum(sql `abs(render_spent_delta)`).as('net'),
-        ])
-            .where('user_id', 'in', p.userIds)
-            .where('otoy_grant_id', 'is not', null)
-            .groupBy('user_id')
-            .execute();
-        // jobs already settled by a burn correction — their grant is spoken for (double-spend guard)
-        const corrected = await db
-            .selectFrom(`${JOB_TABLE} as j`)
-            .innerJoin(`${BURN_CORRECTION_TABLE} as bc`, 'bc.job_id', 'j.id')
-            .select((eb) => ['j.user_id as user_id', eb.fn.sum('j.render_amt').as('amt')])
-            .where('j.user_id', 'in', p.userIds)
-            .groupBy('j.user_id')
-            .execute();
-        const spentBy = new Map(spent.map((r) => [r.user_id, BigInt(r.net ?? 0)]));
-        const corrBy = new Map(corrected.map((r) => [r.user_id, BigInt(r.amt ?? 0)]));
-        for (const g of grants) {
-            const u = g.user_id;
-            const cur = out[u] ??
-                (out[u] = { userId: u, granted: BigInt(0), consumed: BigInt(0), avail: BigInt(0), grants: [] });
-            // amount_credits is numeric EUR — truncate to whole base units after the x4 conversion
-            const credits = (BigInt(Math.round(Number(g.amount_credits) * 1e8)) * EUR_TO_CREDITS);
-            cur.granted += credits;
-            cur.grants.push({
-                id: Number(g.id),
-                amountCredits: credits,
-                createdAt: g.otoy_created_at ? new Date(g.otoy_created_at) : null,
+        // 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, 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', 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', 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', 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,
+                grantId: r.gid ?? undefined,
             });
+            byUser.set(r.u, arr);
         }
-        for (const u of Object.keys(out)) {
-            const attributed = spentBy.get(u) ?? BigInt(0); // abs() — spend drawn or grant already credited
-            const viaCorrection = corrBy.get(u) ?? BigInt(0);
-            const f = foldGrantAllotment(out[u].grants, attributed, viaCorrection);
-            out[u].granted = f.granted;
-            out[u].consumed = f.consumed;
-            out[u].avail = f.avail;
-            if (viaCorrection > BigInt(0)) {
-                log.info(`grant allotment ${u}: granted ${f.granted} - attributed ${attributed} - correction-settled ${viaCorrection} = ${f.avail}`);
+        for (const [u, events] of byUser) {
+            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), ` +
+                    `${f.expired} expired past the ${GRANT_LOOKBACK_DAYS}d window — avail ${f.avail}`);
             }
         }
         return out;
@@ -328,7 +395,7 @@ export const pgClient = (config) => {
         const sequenceNumbers = [];
         const dbEpochIds = [];
         for (const bt of bts) {
-            let { solKey: toSolKey, seq, createdAt, amount, upgradeBracket, priorSupply, points, epochId, } = bt;
+            let { solKey: toSolKey, seq, createdAt, amount, upgradeBracket, priorSupply, points, epochId, sender, } = bt;
             let entityId;
             if (toSolKey && toSolKey != '') {
                 entityId = await getOrInsertEntity(db, { solKey: toSolKey });
@@ -349,6 +416,7 @@ export const pgClient = (config) => {
                 prior_supply: priorSupply,
                 points: points,
                 epoch_id: dbEpochId,
+                sender: sender,
             })
                 .onConflict((oc) => oc.column('sequence').doUpdateSet({
                 created_at: createdAt,
@@ -358,6 +426,7 @@ export const pgClient = (config) => {
                 points: points,
                 epoch_id: dbEpochId,
                 entity_id: entityId,
+                sender: sender,
             }))
                 .returning('sequence');
             const c = q.compile();
@@ -1100,16 +1169,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,
@@ -1440,6 +1506,7 @@ export const pgClient = (config) => {
                     eurToUsdc: r.eur_to_usdc,
                     markedBurnedAt: r.marked_burned_at,
                     tags: r.tags ? r.tags.split(',') : [],
+                    fromEscrowUsdc: BigInt(r.from_escrow_usdc ?? 0),
                 });
                 burnIdToIdx[r.id] = burns.length - 1;
             }
@@ -1609,8 +1676,8 @@ export const pgClient = (config) => {
                 .innerJoin('sol_tx', 'sol_tx.id', 'burn.sol_tx_id')
                 .select(({ fn }) => [
                 dayExpr.as('day'),
-                fn.sum('burn.burned').as('render_burned'),
-                fn.sum('burn.usdc_spent').as('usdc_spent'),
+                sql `SUM(CASE WHEN burn.burned > 0 THEN burn.burned WHEN COALESCE(burn.from_escrow_usdc, 0) > 0 AND burn.render_to_usdc > 0 THEN (burn.from_escrow_usdc::numeric / burn.render_to_usdc * 100)::bigint ELSE 0 END)`.as('render_burned'),
+                sql `SUM(CASE WHEN burn.usdc_spent > 0 THEN burn.usdc_spent ELSE COALESCE(burn.from_escrow_usdc, 0) END)`.as('usdc_spent'),
                 fn.count('burn.id').as('burn_count'),
             ])
                 .groupBy(sql `date_trunc('day', sol_tx.executed_at)`)
@@ -1912,6 +1979,8 @@ export const pgClient = (config) => {
                     usdc_spent: p.usdcSpent ?? null,
                     correction_id: p.correctionId ?? null,
                     correction_render: p.correctionRender ?? null,
+                    usage_from: p.usageFrom ?? null,
+                    usage_to: p.usageTo ?? null,
                 })
                     .onConflict((oc) => oc.column('tx_signature').doNothing())
                     .executeTakeFirst();