@render-foundation/utils 0.0.237 → 0.0.239

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

@@ -21,6 +21,7 @@ export const ENTITY_EPOCH_INFO_TABLE = 'entity_epoch_info';
 export const POLYGON_UPGRADE_TABLE = 'polygon_upgrade';
 export const CURRENT_USER_GRANT_SPEND_TABLE = 'current_user_grant_spend';
 export const USER_GRANT_SPEND_TABLE = 'user_grant_spend';
+export const OTOY_GRANT_TABLE = 'otoy_grant';
 export const GRANT_BURN_ID_TABLE = 'grant_burn_id';
 export const GRANT_BURN_TABLE = 'grant_burn';
 export const DISPERSED_SETTLEMENT_TABLE = 'dispersed_settlement';
@@ -28,6 +29,39 @@ export const DISPERSED_BURN_CORRECTION_TABLE = 'dispersed_burn_correction';
 BigInt.prototype.toJSON = function () {
     return this.toString();
 };
+// EUR -> render credits. OTOY issues grants in EUR (otoy_grant.amount_credits holds the raw OTOY
+// 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);
+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;
+    let fifoGrantId;
+    for (const g of grants) {
+        if (drawn < g.amountCredits) {
+            fifoGrantId = g.id;
+            break;
+        }
+        drawn -= g.amountCredits;
+    }
+    return { granted, consumed, avail, fifoGrantId };
+};
 import { begin } from './base';
 import moment from 'moment';
 pg.types.setTypeParser(1114, (str) => moment.utc(str).toDate());
@@ -150,6 +184,73 @@ export const pgClient = (config) => {
             }
             : undefined;
     };
+    // Spendable grant per user, straight off otoy_grant (FIFO), net of what's already been spent or
+    // already settled by a burn correction. See GrantAllotment for the units + the double-spend guard.
+    const getGrantAllotments = async (db, p, log = consoleLogger) => {
+        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,
+            });
+        }
+        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}`);
+            }
+        }
+        return out;
+    };
     const updateTotalRndr = async (db, p, totalRndr, savedAt, log) => {
         const res = (await db
             .updateTable(EPOCH_TABLE)
@@ -999,11 +1100,23 @@ 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.
+                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;
+                    }
+                }
                 const v = {
                     user_id: p.userId,
                     render_spent_delta: p.renderSpentDelta,
                     grant_burn_id: p.grantBurnId,
                     job_id: p.jobId,
+                    otoy_grant_id: otoyGrantId,
                 };
                 const res = await db.trx
                     .insertInto(USER_GRANT_SPEND_TABLE)
@@ -1348,6 +1461,103 @@ export const pgClient = (config) => {
             }
             return burns;
         },
+        async fetchBurnsPage(db, f, log = consoleLogger) {
+            const lastId = f.cursor ? atob(f.cursor) : undefined;
+            let q = db.trx
+                .selectFrom('burn')
+                .selectAll('burn')
+                .innerJoin('sol_tx', 'sol_tx.id', 'burn.sol_tx_id')
+                .select(['sol_tx.executed_at', 'sol_tx.sig']);
+            if (!f.inclManual) {
+                q = q.where('burn.usdc_spent', '>', String(0));
+            }
+            if (f.executedAfter) {
+                q = q.where('sol_tx.executed_at', '>=', f.executedAfter);
+            }
+            if (f.executedBefore) {
+                q = q.where('sol_tx.executed_at', '<=', f.executedBefore);
+            }
+            if (lastId) {
+                q = q.where('burn.id', '>', lastId);
+            }
+            const limit = f.limit ?? 1000;
+            q = q.limit(limit).orderBy('burn.id');
+            const comp = q.compile();
+            const { rows } = await timedQuery(pgPool, comp.sql, comp.parameters, 'fetchBurnsPage', log);
+            const burns = rows.map((r) => ({
+                jobs: [],
+                id: Number(r.id),
+                renderToUsdc: r.render_to_usdc,
+                solTx: r.sig,
+                executedAt: r.executed_at,
+                pricedAt: r.priced_at,
+                usdcSpent: BigInt(r.usdc_spent ?? 0),
+                quoteAmt: BigInt(r.quote_amt ?? 0),
+                burned: BigInt(r.burned),
+                eurToUsdc: r.eur_to_usdc,
+                markedBurnedAt: r.marked_burned_at,
+                tags: r.tags ? r.tags.split(',') : [],
+            }));
+            return {
+                burns,
+                // Only hand back a cursor on a full page; a short page means we're done.
+                cursor: burns.length === limit
+                    ? btoa(String(burns[burns.length - 1].id))
+                    : undefined,
+            };
+        },
+        async fetchBurnJobs(db, burnId, log = consoleLogger) {
+            const rows = await db.trx
+                .selectFrom('job')
+                .selectAll('job')
+                .where('burn_id', '=', String(burnId))
+                .execute();
+            log.debug(`fetchBurnJobs burn ${burnId} -> ${rows.length} jobs`);
+            return rows.map((r) => ({
+                id: Number(r.id),
+                completedAt: r.completed_at,
+                rndrUsed: BigInt(r.render_amt),
+                obhUsed: r.obh_used ? Number(r.obh_used) : undefined,
+            }));
+        },
+        async fetchDailyBurnStats(db, f, log = consoleLogger) {
+            // sol_tx.executed_at is `timestamp WITHOUT time zone` already holding UTC wall-clock, so truncate it
+            // DIRECTLY. Do not write `executed_at at time zone 'UTC'`: that promotes it to timestamptz, after which
+            // date_trunc truncates in the Postgres session's TimeZone — measured against prod, a Tokyo session moved
+            // the bucket boundary to 15:00Z and a Los_Angeles session changed the bucket COUNT (783 vs 786).
+            // Truncating the naive column is pure arithmetic and identical under every session timezone, and
+            // to_char hands back a plain 'YYYY-MM-DD' so node-postgres has no Date to decode in local time.
+            const dayExpr = sql `to_char(date_trunc('day', sol_tx.executed_at), 'YYYY-MM-DD')`;
+            let q = db.trx
+                .selectFrom('burn')
+                .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'),
+                fn.count('burn.id').as('burn_count'),
+            ])
+                .groupBy(sql `date_trunc('day', sol_tx.executed_at)`)
+                .orderBy(sql `date_trunc('day', sol_tx.executed_at)`);
+            if (!f.inclManual) {
+                q = q.where('burn.usdc_spent', '>', String(0));
+            }
+            if (f.executedAfter) {
+                q = q.where('sol_tx.executed_at', '>=', f.executedAfter);
+            }
+            if (f.executedBefore) {
+                q = q.where('sol_tx.executed_at', '<=', f.executedBefore);
+            }
+            const comp = q.compile();
+            const { rows } = await timedQuery(pgPool, comp.sql, comp.parameters, 'fetchDailyBurnStats', log);
+            log.info(`fetchDailyBurnStats len ${rows.length}`);
+            return rows.map((r) => ({
+                day: r.day,
+                renderBurned: BigInt(r.render_burned ?? 0),
+                usdcSpent: BigInt(r.usdc_spent ?? 0),
+                burnCount: Number(r.burn_count ?? 0),
+            }));
+        },
         async fetchBurnsAndGrants(db, f, log = consoleLogger) {
             // Build a unified query to get all transactions with both buy burns and grant burns
             let baseQuery = db.trx
@@ -1751,7 +1961,6 @@ export const pgClient = (config) => {
                 .select([
                 'tx_signature',
                 'claim_uuid',
-                'obligation_uuids',
                 'settled_amount',
                 'burned_amount',
                 'usdc_spent',
@@ -1765,7 +1974,6 @@ export const pgClient = (config) => {
             return rows.map((r) => ({
                 txSignature: r.tx_signature,
                 claimUuid: r.claim_uuid,
-                obligationUuids: r.obligation_uuids,
                 settledAmount: r.settled_amount,
                 burnedAmount: r.burned_amount,
                 usdcSpent: r.usdc_spent ?? null,
@@ -1979,6 +2187,9 @@ export const pgClient = (config) => {
         async getCurrentUserGrantSpend(db, f, log = consoleLogger) {
             return await getCurrentUserGrantSpend(db.trx, f, log);
         },
+        async getGrantAllotments(db, f, log = consoleLogger) {
+            return await getGrantAllotments(db.trx, f, log);
+        },
         async deleteAll(log = consoleLogger) {
             if (config.database.includes('render')) {
                 throw new Error('cannot nuke from deployed database. call from tests only');