Skip to content

Commit

Permalink
fix: offload ticker lookup from BRC-20 activity query (#293)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rafaelcr
rafaelcr committed Jan 16, 2024
1 parent 644ca9c commit e70c222
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 74 deletions.
22 changes: 22 additions & 0 deletions migrations/1705363472553_locations-block-height-indexes.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* eslint-disable @typescript-eslint/naming-convention */
import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';

export const shorthands: ColumnDefinitions | undefined = undefined;

export function up(pgm: MigrationBuilder): void {
pgm.dropIndex('locations', ['block_hash']);
pgm.dropIndex('locations', ['block_height']);
pgm.createIndex('locations', [
{ name: 'block_height', sort: 'DESC' },
{ name: 'tx_index', sort: 'DESC' },
]);
}

export function down(pgm: MigrationBuilder): void {
pgm.dropIndex('locations', [
{ name: 'block_height', sort: 'DESC' },
{ name: 'tx_index', sort: 'DESC' },
]);
pgm.createIndex('locations', ['block_hash']);
pgm.createIndex('locations', ['block_height']);
}
153 changes: 79 additions & 74 deletions src/pg/brc20/brc20-pg-store.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -761,9 +761,9 @@ export class Brc20PgStore extends BasePgStoreModule {
address?: string;
}
): Promise<DbPaginatedResult<DbBrc20Activity>> {
// Do we need a specific result count such as total activity or activity per address?
objRemoveUndefinedValues(filters);
const filterLength = Object.keys(filters).length;
// Do we need a specific result count such as total activity or activity per address?
const needsGlobalEventCount =
filterLength === 0 ||
(filterLength === 1 && filters.operation && filters.operation.length > 0);
Expand All @@ -775,86 +775,91 @@ export class Brc20PgStore extends BasePgStoreModule {
filters.address != undefined &&
filters.address != '');
const needsTickerCount = filterLength === 1 && filters.ticker && filters.ticker.length > 0;

// Which operations do we need if we're filtering by address?
const sanitizedOperations: DbBrc20EventOperation[] = [];
for (const i of filters.operation ?? BRC20_OPERATIONS)
if (BRC20_OPERATIONS.includes(i)) sanitizedOperations?.push(i as DbBrc20EventOperation);

// Which tickers are we filtering for?
const tickerConditions = this.sqlOr(
filters.ticker?.map(t => this.sql`d.ticker_lower = LOWER(${t})`)
filters.ticker?.map(t => this.sql`ticker_lower = LOWER(${t})`)
);

const results = await this.sql<(DbBrc20Activity & { total: number })[]>`
WITH event_count AS (${
// Select count from the correct count cache table.
needsGlobalEventCount
? this.sql`
SELECT COALESCE(SUM(count), 0) AS count
FROM brc20_counts_by_event_type
${
filters.operation
? this.sql`WHERE event_type IN ${this.sql(filters.operation)}`
: this.sql``
}
`
: needsAddressEventCount
? this.sql`
SELECT COALESCE(${this.sql.unsafe(sanitizedOperations.join('+'))}, 0) AS count
FROM brc20_counts_by_address_event_type
WHERE address = ${filters.address}
`
: needsTickerCount
? this.sql`
SELECT COALESCE(SUM(tx_count), 0) AS count
FROM brc20_deploys AS d
WHERE (${tickerConditions})
`
: this.sql`SELECT NULL AS count`
})
SELECT
e.operation,
d.ticker,
l.genesis_id AS inscription_id,
l.block_height,
l.block_hash,
l.tx_id,
l.address,
l.timestamp,
l.output,
l.offset,
d.max AS deploy_max,
d.limit AS deploy_limit,
d.decimals AS deploy_decimals,
(SELECT amount FROM brc20_mints WHERE id = e.mint_id) AS mint_amount,
(SELECT amount || ';' || from_address || ';' || COALESCE(to_address, '') FROM brc20_transfers WHERE id = e.transfer_id) AS transfer_data,
${
needsGlobalEventCount || needsAddressEventCount || needsTickerCount
? this.sql`(SELECT count FROM event_count)`
: this.sql`COUNT(*) OVER()`
} AS total
FROM brc20_events AS e
INNER JOIN brc20_deploys AS d ON e.brc20_deploy_id = d.id
INNER JOIN locations AS l ON e.genesis_location_id = l.id
WHERE TRUE
${
filters.operation ? this.sql`AND operation IN ${this.sql(filters.operation)}` : this.sql``
}
${tickerConditions ? this.sql`AND (${tickerConditions})` : this.sql``}
${
filters.block_height ? this.sql`AND l.block_height = ${filters.block_height}` : this.sql``
}
${
filters.address
? this.sql`AND (e.address = ${filters.address} OR e.from_address = ${filters.address})`
: this.sql``
}
ORDER BY l.block_height DESC, l.tx_index DESC
LIMIT ${page.limit}
OFFSET ${page.offset}
`;
return {
total: results[0]?.total ?? 0,
results: results ?? [],
};
return this.sqlTransaction(async sql => {
// The postgres query planner has trouble selecting an optimal plan when the WHERE condition
// checks any column from the `brc20_deploys` table. If the user is filtering by ticker, we
// should get the token IDs first and use those to filter directly in the `brc20_events`
// table.
const tickerIds = tickerConditions
? (await sql<{ id: string }[]>`SELECT id FROM brc20_deploys WHERE ${tickerConditions}`).map(
i => i.id
)
: undefined;
const results = await sql<(DbBrc20Activity & { total: number })[]>`
WITH event_count AS (${
// Select count from the correct count cache table.
needsGlobalEventCount
? sql`
SELECT COALESCE(SUM(count), 0) AS count
FROM brc20_counts_by_event_type
${filters.operation ? sql`WHERE event_type IN ${sql(filters.operation)}` : sql``}
`
: needsAddressEventCount
? sql`
SELECT COALESCE(${sql.unsafe(sanitizedOperations.join('+'))}, 0) AS count
FROM brc20_counts_by_address_event_type
WHERE address = ${filters.address}
`
: needsTickerCount && tickerIds !== undefined
? sql`
SELECT COALESCE(SUM(tx_count), 0) AS count
FROM brc20_deploys AS d
WHERE id IN ${sql(tickerIds)}
`
: sql`SELECT NULL AS count`
})
SELECT
e.operation,
d.ticker,
l.genesis_id AS inscription_id,
l.block_height,
l.block_hash,
l.tx_id,
l.address,
l.timestamp,
l.output,
l.offset,
d.max AS deploy_max,
d.limit AS deploy_limit,
d.decimals AS deploy_decimals,
(SELECT amount FROM brc20_mints WHERE id = e.mint_id) AS mint_amount,
(SELECT amount || ';' || from_address || ';' || COALESCE(to_address, '') FROM brc20_transfers WHERE id = e.transfer_id) AS transfer_data,
${
needsGlobalEventCount || needsAddressEventCount || needsTickerCount
? sql`(SELECT count FROM event_count)`
: sql`COUNT(*) OVER()`
} AS total
FROM brc20_events AS e
INNER JOIN brc20_deploys AS d ON e.brc20_deploy_id = d.id
INNER JOIN locations AS l ON e.genesis_location_id = l.id
WHERE TRUE
${filters.operation ? sql`AND e.operation IN ${sql(filters.operation)}` : sql``}
${tickerIds ? sql`AND e.brc20_deploy_id IN ${sql(tickerIds)}` : sql``}
${filters.block_height ? sql`AND l.block_height = ${filters.block_height}` : sql``}
${
filters.address
? sql`AND (e.address = ${filters.address} OR e.from_address = ${filters.address})`
: sql``
}
ORDER BY l.block_height DESC, l.tx_index DESC
LIMIT ${page.limit}
OFFSET ${page.offset}
`;
return {
total: results[0]?.total ?? 0,
results: results ?? [],
};
});
}
}

0 comments on commit e70c222

Please sign in to comment.