Skip to content

api: estimate counts by default, cache /blockchain burn totals #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NayiemW wants to merge 1 commit into
base: main
Choose a base branch
from
Open

api: estimate counts by default, cache /blockchain burn totals #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions packages/api/src/controllers/blockchain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ import { WalletSearchResource } from "../resources-new";
import { WalletSearchService } from "../services";
import { Controller } from "./controller";

// Burn totals only change when a new block carrying burned fees or burn
// transactions is forged, so recomputing them on every /blockchain request
// is wasteful — both queries are unbounded SUMs over the transactions table
// and take tens of seconds on a mature mainnet. Cache the result and refresh
// lazily in the background; a stale-but-fresh-on-read pattern is fine for an
// endpoint whose primary consumers are explorer dashboards.
interface BurnCache {
fees: string;
transactions: string;
ts: number;
refreshing: Promise<void> | null;
}

const burnCache: BurnCache = {
fees: "0",
transactions: "0",
ts: 0,
refreshing: null,
};

const BURN_CACHE_TTL_MS = 10 * 60 * 1000;

export class BlockchainController extends Controller {
@Container.inject(Container.Identifiers.BlockHistoryService)
@Container.tagged("connection", "api")
Expand All @@ -34,8 +56,25 @@ export class BlockchainController extends Controller {
public async index(_: Hapi.Request, h: Hapi.ResponseToolkit) {
const { data } = this.stateStore.getLastBlock();

const fees = Utils.BigNumber.make(await this.transactionRepository.getFeesBurned());
const transactions = Utils.BigNumber.make(await this.transactionRepository.getBurnTransactionTotal());
if (Date.now() - burnCache.ts > BURN_CACHE_TTL_MS && !burnCache.refreshing) {
const repo = this.transactionRepository;
burnCache.refreshing = (async () => {
try {
const [feesRaw, txRaw] = await Promise.all([
repo.getFeesBurned(),
repo.getBurnTransactionTotal(),
]);
burnCache.fees = String(feesRaw);
burnCache.transactions = String(txRaw);
burnCache.ts = Date.now();
} finally {
burnCache.refreshing = null;
}
})();
}

const fees = Utils.BigNumber.make(burnCache.fees);
const transactions = Utils.BigNumber.make(burnCache.transactions);
const total = fees.plus(transactions);

return {
Expand Down
2 changes: 1 addition & 1 deletion packages/api/src/defaults.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export const defaults = {
},
options: {
basePath: "/api",
estimateTotalCount: !!process.env.CORE_API_ESTIMATED_TOTAL_COUNT,
estimateTotalCount: process.env.CORE_API_ESTIMATED_TOTAL_COUNT !== "false",
},
ws: {
banSeconds: 10,
Expand Down