@render-foundation/utils 0.0.237 → 0.0.239

package/lib/cjs/client/pg/v2Client.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pgClient = exports.batchFinishedAtMedian = exports.DISPERSED_BURN_CORRECTION_TABLE = exports.DISPERSED_SETTLEMENT_TABLE = exports.GRANT_BURN_TABLE = exports.GRANT_BURN_ID_TABLE = exports.USER_GRANT_SPEND_TABLE = exports.CURRENT_USER_GRANT_SPEND_TABLE = exports.POLYGON_UPGRADE_TABLE = exports.ENTITY_EPOCH_INFO_TABLE = exports.BURN_CORRECTION_TABLE = exports.NETWORK_REVENUE_TABLE = exports.BRIDGE_TRANSFER_TABLE = exports.BURN_TABLE = exports.JOB_TABLE = exports.JOB_ID_TABLE = exports.LIABILITY_ADJUSTMENT_BATCH_TABLE = exports.LIABILITY_ADJUSTMENT_TABLE = exports.LIABILITY_TABLE = exports.SOL_TRANSFER_TABLE = exports.ENTITY_TABLE = exports.MANUAL_BURN_TABLE = exports.EPOCH_TABLE = exports.SOL_TX_TABLE = void 0;
+exports.pgClient = exports.batchFinishedAtMedian = exports.foldGrantAllotment = exports.CREDIT_DECIMALS = exports.EUR_TO_CREDITS = exports.DISPERSED_BURN_CORRECTION_TABLE = exports.DISPERSED_SETTLEMENT_TABLE = exports.GRANT_BURN_TABLE = exports.GRANT_BURN_ID_TABLE = exports.OTOY_GRANT_TABLE = exports.USER_GRANT_SPEND_TABLE = exports.CURRENT_USER_GRANT_SPEND_TABLE = exports.POLYGON_UPGRADE_TABLE = exports.ENTITY_EPOCH_INFO_TABLE = exports.BURN_CORRECTION_TABLE = exports.NETWORK_REVENUE_TABLE = exports.BRIDGE_TRANSFER_TABLE = exports.BURN_TABLE = exports.JOB_TABLE = exports.JOB_ID_TABLE = exports.LIABILITY_ADJUSTMENT_BATCH_TABLE = exports.LIABILITY_ADJUSTMENT_TABLE = exports.LIABILITY_TABLE = exports.SOL_TRANSFER_TABLE = exports.ENTITY_TABLE = exports.MANUAL_BURN_TABLE = exports.EPOCH_TABLE = exports.SOL_TX_TABLE = void 0;
 const kysely_1 = require("kysely");
 const logger_1 = require("../../logger");
 const pg_1 = require("pg");
@@ -59,6 +59,7 @@ exports.ENTITY_EPOCH_INFO_TABLE = 'entity_epoch_info';
 exports.POLYGON_UPGRADE_TABLE = 'polygon_upgrade';
 exports.CURRENT_USER_GRANT_SPEND_TABLE = 'current_user_grant_spend';
 exports.USER_GRANT_SPEND_TABLE = 'user_grant_spend';
+exports.OTOY_GRANT_TABLE = 'otoy_grant';
 exports.GRANT_BURN_ID_TABLE = 'grant_burn_id';
 exports.GRANT_BURN_TABLE = 'grant_burn';
 exports.DISPERSED_SETTLEMENT_TABLE = 'dispersed_settlement';
@@ -66,6 +67,40 @@ exports.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.
+exports.EUR_TO_CREDITS = BigInt(4);
+exports.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.
+ */
+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 };
+};
+exports.foldGrantAllotment = foldGrantAllotment;
 const base_2 = require("./base");
 const moment_1 = __importDefault(require("moment"));
 pg.types.setTypeParser(1114, (str) => moment_1.default.utc(str).toDate());
@@ -190,6 +225,73 @@ 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 = (db, p, log = logger_1.consoleLogger) => __awaiter(void 0, void 0, void 0, function* () {
+        var _b, _c, _d;
+        const out = {};
+        if (!p.userIds.length)
+            return out;
+        const grants = yield db
+            .selectFrom(exports.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 = yield db
+            .selectFrom(exports.USER_GRANT_SPEND_TABLE)
+            .select((eb) => [
+            'user_id',
+            eb.fn.sum((0, kysely_1.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 = yield db
+            .selectFrom(`${exports.JOB_TABLE} as j`)
+            .innerJoin(`${exports.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) => { var _a; return [r.user_id, BigInt((_a = r.net) !== null && _a !== void 0 ? _a : 0)]; }));
+        const corrBy = new Map(corrected.map((r) => { var _a; return [r.user_id, BigInt((_a = r.amt) !== null && _a !== void 0 ? _a : 0)]; }));
+        for (const g of grants) {
+            const u = g.user_id;
+            const cur = (_b = out[u]) !== null && _b !== void 0 ? _b : (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)) * exports.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 = (_c = spentBy.get(u)) !== null && _c !== void 0 ? _c : BigInt(0); // abs() — spend drawn or grant already credited
+            const viaCorrection = (_d = corrBy.get(u)) !== null && _d !== void 0 ? _d : BigInt(0);
+            const f = (0, exports.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 = (db, p, totalRndr, savedAt, log) => __awaiter(void 0, void 0, void 0, function* () {
         const res = (yield db
             .updateTable(exports.EPOCH_TABLE)
@@ -1081,11 +1183,23 @@ 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 = yield getGrantAllotments(db.trx, { userIds: [p.userId] }, log);
+                        const a = allots[p.userId];
+                        if (a) {
+                            otoyGrantId = (0, exports.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 = yield db.trx
                         .insertInto(exports.USER_GRANT_SPEND_TABLE)
@@ -1446,6 +1560,116 @@ const pgClient = (config) => {
                 return burns;
             });
         },
+        fetchBurnsPage(db, f, log = logger_1.consoleLogger) {
+            var _a;
+            return __awaiter(this, void 0, void 0, function* () {
+                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 = (_a = f.limit) !== null && _a !== void 0 ? _a : 1000;
+                q = q.limit(limit).orderBy('burn.id');
+                const comp = q.compile();
+                const { rows } = yield (0, base_1.timedQuery)(pgPool, comp.sql, comp.parameters, 'fetchBurnsPage', log);
+                const burns = rows.map((r) => {
+                    var _a, _b;
+                    return ({
+                        jobs: [],
+                        id: Number(r.id),
+                        renderToUsdc: r.render_to_usdc,
+                        solTx: r.sig,
+                        executedAt: r.executed_at,
+                        pricedAt: r.priced_at,
+                        usdcSpent: BigInt((_a = r.usdc_spent) !== null && _a !== void 0 ? _a : 0),
+                        quoteAmt: BigInt((_b = r.quote_amt) !== null && _b !== void 0 ? _b : 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,
+                };
+            });
+        },
+        fetchBurnJobs(db, burnId, log = logger_1.consoleLogger) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const rows = yield 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,
+                }));
+            });
+        },
+        fetchDailyBurnStats(db, f, log = logger_1.consoleLogger) {
+            return __awaiter(this, void 0, void 0, function* () {
+                // 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 = (0, kysely_1.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((0, kysely_1.sql) `date_trunc('day', sol_tx.executed_at)`)
+                    .orderBy((0, kysely_1.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 } = yield (0, base_1.timedQuery)(pgPool, comp.sql, comp.parameters, 'fetchDailyBurnStats', log);
+                log.info(`fetchDailyBurnStats len ${rows.length}`);
+                return rows.map((r) => {
+                    var _a, _b, _c;
+                    return ({
+                        day: r.day,
+                        renderBurned: BigInt((_a = r.render_burned) !== null && _a !== void 0 ? _a : 0),
+                        usdcSpent: BigInt((_b = r.usdc_spent) !== null && _b !== void 0 ? _b : 0),
+                        burnCount: Number((_c = r.burn_count) !== null && _c !== void 0 ? _c : 0),
+                    });
+                });
+            });
+        },
         fetchBurnsAndGrants(db, f, log = logger_1.consoleLogger) {
             var _a, _b;
             return __awaiter(this, void 0, void 0, function* () {
@@ -1881,7 +2105,6 @@ const pgClient = (config) => {
                     .select([
                     'tx_signature',
                     'claim_uuid',
-                    'obligation_uuids',
                     'settled_amount',
                     'burned_amount',
                     'usdc_spent',
@@ -1897,7 +2120,6 @@ const pgClient = (config) => {
                     return ({
                         txSignature: r.tx_signature,
                         claimUuid: r.claim_uuid,
-                        obligationUuids: r.obligation_uuids,
                         settledAmount: r.settled_amount,
                         burnedAmount: r.burned_amount,
                         usdcSpent: (_a = r.usdc_spent) !== null && _a !== void 0 ? _a : null,
@@ -2134,6 +2356,11 @@ const pgClient = (config) => {
                 return yield getCurrentUserGrantSpend(db.trx, f, log);
             });
         },
+        getGrantAllotments(db, f, log = logger_1.consoleLogger) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return yield getGrantAllotments(db.trx, f, log);
+            });
+        },
         deleteAll(log = logger_1.consoleLogger) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (config.database.includes('render')) {