Skip to content
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.

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

If subgraph block handlers exist force realtime processing in watcher #524

Merged
merged 6 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"packages": [
"packages/*"
],
"version": "0.2.99",
"version": "0.2.100",
"npmClient": "yarn",
"useWorkspaces": true,
"command": {
Expand Down
2 changes: 1 addition & 1 deletion packages/cache/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/cache",
"version": "0.2.99",
"version": "0.2.100",
"description": "Generic object cache",
"main": "dist/index.js",
"scripts": {
Expand Down
12 changes: 6 additions & 6 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/cli",
"version": "0.2.99",
"version": "0.2.100",
"main": "dist/index.js",
"license": "AGPL-3.0",
"scripts": {
Expand All @@ -15,13 +15,13 @@
},
"dependencies": {
"@apollo/client": "^3.7.1",
"@cerc-io/cache": "^0.2.99",
"@cerc-io/ipld-eth-client": "^0.2.99",
"@cerc-io/cache": "^0.2.100",
"@cerc-io/ipld-eth-client": "^0.2.100",
"@cerc-io/libp2p": "^0.42.2-laconic-0.1.4",
"@cerc-io/nitro-node": "^0.1.15",
"@cerc-io/peer": "^0.2.99",
"@cerc-io/rpc-eth-client": "^0.2.99",
"@cerc-io/util": "^0.2.99",
"@cerc-io/peer": "^0.2.100",
"@cerc-io/rpc-eth-client": "^0.2.100",
"@cerc-io/util": "^0.2.100",
"@ethersproject/providers": "^5.4.4",
"@graphql-tools/utils": "^9.1.1",
"@ipld/dag-cbor": "^8.0.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/codegen/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/codegen",
"version": "0.2.99",
"version": "0.2.100",
"description": "Code generator",
"private": true,
"main": "index.js",
Expand All @@ -20,7 +20,7 @@
},
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@cerc-io/util": "^0.2.99",
"@cerc-io/util": "^0.2.100",
"@graphql-tools/load-files": "^6.5.2",
"@npmcli/package-json": "^5.0.0",
"@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",
Expand Down
3 changes: 1 addition & 2 deletions packages/codegen/src/templates/config-template.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
checkpointInterval = 2000

# Enable state creation
# CAUTION: Disable only if state creation is not desired or can be filled subsequently
enableState = true
enableState = false

{{#if (subgraphPath)}}
subgraphPath = "./subgraph-build"
Expand Down
23 changes: 22 additions & 1 deletion packages/codegen/src/templates/indexer-template.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,7 @@ export class Indexer implements IndexerInterface {
{{/each}}
}

// eslint-disable-next-line @typescript-eslint/no-empty-function
_populateRelationsMap (): void {
{{#each subgraphEntities as | subgraphEntity |}}
{{#if subgraphEntity.relations}}
Expand Down Expand Up @@ -867,7 +868,27 @@ export class Indexer implements IndexerInterface {
assert(blockHash);
assert(blockNumber);

const { events: dbEvents, transactions } = await this._baseIndexer.fetchEvents(blockHash, blockNumber, this.eventSignaturesMap, this.parseEventNameAndArgs.bind(this));
{{#if (subgraphPath)}}
let dbEvents: DeepPartial<Event>[] = [];
let transactions: EthFullTransaction[] = [];

// Fetch events and txs only if subgraph config has any event handlers
if (this._graphWatcher.eventHandlerExists) {
({ events: dbEvents, transactions } = await this._baseIndexer.fetchEvents(
blockHash,
blockNumber,
this.eventSignaturesMap,
this.parseEventNameAndArgs.bind(this)
));
}
{{else~}}
const { events: dbEvents, transactions } = await this._baseIndexer.fetchEvents(
blockHash,
blockNumber,
this.eventSignaturesMap,
this.parseEventNameAndArgs.bind(this)
);
{{/if}}

const dbTx = await this._db.createTransactionRunner();
try {
Expand Down
10 changes: 5 additions & 5 deletions packages/codegen/src/templates/package-template.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@apollo/client": "^3.3.19",
"@cerc-io/cli": "^0.2.99",
"@cerc-io/ipld-eth-client": "^0.2.99",
"@cerc-io/solidity-mapper": "^0.2.99",
"@cerc-io/util": "^0.2.99",
"@cerc-io/cli": "^0.2.100",
"@cerc-io/ipld-eth-client": "^0.2.100",
"@cerc-io/solidity-mapper": "^0.2.100",
"@cerc-io/util": "^0.2.100",
{{#if (subgraphPath)}}
"@cerc-io/graph-node": "^0.2.99",
"@cerc-io/graph-node": "^0.2.100",
{{/if}}
"@ethersproject/providers": "^5.4.4",
"debug": "^4.3.1",
Expand Down
10 changes: 5 additions & 5 deletions packages/graph-node/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@cerc-io/graph-node",
"version": "0.2.99",
"version": "0.2.100",
"main": "dist/index.js",
"license": "AGPL-3.0",
"devDependencies": {
"@cerc-io/solidity-mapper": "^0.2.99",
"@cerc-io/solidity-mapper": "^0.2.100",
"@ethersproject/providers": "^5.4.4",
"@graphprotocol/graph-ts": "^0.22.0",
"@nomiclabs/hardhat-ethers": "^2.0.2",
Expand Down Expand Up @@ -51,9 +51,9 @@
"dependencies": {
"@apollo/client": "^3.3.19",
"@cerc-io/assemblyscript": "0.19.10-watcher-ts-0.1.2",
"@cerc-io/cache": "^0.2.99",
"@cerc-io/ipld-eth-client": "^0.2.99",
"@cerc-io/util": "^0.2.99",
"@cerc-io/cache": "^0.2.100",
"@cerc-io/ipld-eth-client": "^0.2.100",
"@cerc-io/util": "^0.2.100",
"@types/json-diff": "^0.5.2",
"@types/yargs": "^17.0.0",
"bn.js": "^4.11.9",
Expand Down
15 changes: 15 additions & 0 deletions packages/graph-node/src/watcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ export class GraphWatcher {

_context: Context;

_blockHandlerExists = false;
_eventHandlerExists = false;

constructor (database: GraphDatabase, ethClient: EthClient, ethProvider: providers.BaseProvider, serverConfig: ServerConfig) {
this._database = database;
this._ethClient = ethClient;
Expand Down Expand Up @@ -110,6 +113,10 @@ export class GraphWatcher {
};
}, {});

// Check if handlers exist for deciding watcher behaviour
this._blockHandlerExists = this._dataSources.some(dataSource => Boolean(dataSource.mapping.blockHandlers));
this._eventHandlerExists = this._dataSources.some(dataSource => Boolean(dataSource.mapping.eventHandlers));

const data = await Promise.all(dataPromises);

// Create a map from dataSource contract address to instance and contract interface.
Expand Down Expand Up @@ -151,6 +158,14 @@ export class GraphWatcher {
return this._dataSources;
}

get blockHandlerExists (): boolean {
return this._blockHandlerExists;
}

get eventHandlerExists (): boolean {
return this._eventHandlerExists;
}

async addContracts () {
assert(this._indexer);
assert(this._indexer.watchContract);
Expand Down
6 changes: 3 additions & 3 deletions packages/ipld-eth-client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/ipld-eth-client",
"version": "0.2.99",
"version": "0.2.100",
"description": "IPLD ETH Client",
"main": "dist/index.js",
"scripts": {
Expand All @@ -20,8 +20,8 @@
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@apollo/client": "^3.7.1",
"@cerc-io/cache": "^0.2.99",
"@cerc-io/util": "^0.2.99",
"@cerc-io/cache": "^0.2.100",
"@cerc-io/util": "^0.2.100",
"cross-fetch": "^3.1.4",
"debug": "^4.3.1",
"ethers": "^5.4.4",
Expand Down
2 changes: 1 addition & 1 deletion packages/peer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/peer",
"version": "0.2.99",
"version": "0.2.100",
"description": "libp2p module",
"main": "dist/index.js",
"exports": "./dist/index.js",
Expand Down
8 changes: 4 additions & 4 deletions packages/rpc-eth-client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/rpc-eth-client",
"version": "0.2.99",
"version": "0.2.100",
"description": "RPC ETH Client",
"main": "dist/index.js",
"scripts": {
Expand All @@ -19,9 +19,9 @@
},
"homepage": "https://github.com/cerc-io/watcher-ts#readme",
"dependencies": {
"@cerc-io/cache": "^0.2.99",
"@cerc-io/ipld-eth-client": "^0.2.99",
"@cerc-io/util": "^0.2.99",
"@cerc-io/cache": "^0.2.100",
"@cerc-io/ipld-eth-client": "^0.2.100",
"@cerc-io/util": "^0.2.100",
"chai": "^4.3.4",
"ethers": "^5.4.4",
"left-pad": "^1.3.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/solidity-mapper/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/solidity-mapper",
"version": "0.2.99",
"version": "0.2.100",
"main": "dist/index.js",
"license": "AGPL-3.0",
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/test/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/test",
"version": "0.2.99",
"version": "0.2.100",
"main": "dist/index.js",
"license": "AGPL-3.0",
"private": true,
Expand Down
2 changes: 1 addition & 1 deletion packages/tracing-client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/tracing-client",
"version": "0.2.99",
"version": "0.2.100",
"description": "ETH VM tracing client",
"main": "dist/index.js",
"scripts": {
Expand Down
8 changes: 4 additions & 4 deletions packages/util/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "@cerc-io/util",
"version": "0.2.99",
"version": "0.2.100",
"main": "dist/index.js",
"license": "AGPL-3.0",
"dependencies": {
"@apollo/utils.keyvaluecache": "^1.0.1",
"@cerc-io/nitro-node": "^0.1.15",
"@cerc-io/peer": "^0.2.99",
"@cerc-io/solidity-mapper": "^0.2.99",
"@cerc-io/peer": "^0.2.100",
"@cerc-io/solidity-mapper": "^0.2.100",
"@cerc-io/ts-channel": "1.0.3-ts-nitro-0.1.1",
"@ethersproject/properties": "^5.7.0",
"@ethersproject/providers": "^5.4.4",
Expand Down Expand Up @@ -54,7 +54,7 @@
"yargs": "^17.0.1"
},
"devDependencies": {
"@cerc-io/cache": "^0.2.99",
"@cerc-io/cache": "^0.2.100",
"@nomiclabs/hardhat-waffle": "^2.0.1",
"@types/bunyan": "^1.8.8",
"@types/express": "^4.17.14",
Expand Down
12 changes: 9 additions & 3 deletions packages/util/src/events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,15 @@ export class EventWatcher {
startBlockNumber = syncStatus.chainHeadBlockNumber + 1;
}

// Check if filter for logs is enabled
// Check if starting block for watcher is before latest canonical block
if (this._config.jobQueue.useBlockRanges && startBlockNumber < latestCanonicalBlockNumber) {
// Perform checks before starting historical block processing
if (
// Skip historical block processing if any block handler exists
!this._indexer.graphWatcher?.blockHandlerExists &&
// Run historical block processing if useBlockRanges is enabled
this._config.jobQueue.useBlockRanges &&
// Only run historical block processing if we are below the frothy region
startBlockNumber < latestCanonicalBlockNumber
) {
await this.startHistoricalBlockProcessing(startBlockNumber, latestCanonicalBlockNumber);

return;
Expand Down
8 changes: 4 additions & 4 deletions packages/util/src/fill.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ export const fillBlocks = async (
const completePercentage = Math.round(blocksProcessed / numberOfBlocks * 100);
log(`Processed ${blocksProcessed} of ${numberOfBlocks} blocks (${completePercentage}%)`);

await processBlockByNumber(jobQueue, blockNumber + 1);

if (blockNumber + 1 >= endBlock) {
// Break the async loop when blockProgress event is for the endBlock and processing is complete.
if (blockNumber + 1 > endBlock) {
// Break the async loop when next block to be processed is more than endBlock.
break;
}

await processBlockByNumber(jobQueue, blockNumber + 1);
}
}

Expand Down
2 changes: 2 additions & 0 deletions packages/util/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,8 @@ export interface GraphDatabaseInterface {
}

export interface GraphWatcherInterface {
readonly blockHandlerExists: boolean;
readonly eventHandlerExists: boolean;
init (): Promise<void>;
setIndexer (indexer: IndexerInterface): void;
}
Expand Down
Loading