Implement Effective Reorg Handling Mechanism #48
+253
−39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aruokhai
force-pushed
the
debt/reorg
branch
3 times, most recently
from
606d73c
to
a7bfbc8
Compare
We Only store |
This is not good, ideally we should be able to handle reorgs of any length. Reorgs greater than 6 are rare, but we should be prepared for the worst. Let's store the last 2016 blocks to be very conservative. |
theanmolsharma
requested changes
Oct 20, 2024
There was a problem hiding this comment.
please add this to .gitignore
Comment on lines
+32
to
+33
| // Ensure the cache size does not exceed 2016 | ||
| await this.trimState(); |
There was a problem hiding this comment.
let's save the entire state ie don't trim to 2016 block
| } | ||
|
|
||
| // Remove and return the latest item in the state cache | ||
| async dequeue_operation_state(): Promise<BlockState | null> { |
There was a problem hiding this comment.
Suggested change
| async dequeue_operation_state(): Promise<BlockState | null> { | |
| async dequeueState(): Promise<BlockState | null> { |
| @Entity() | ||
| export class BlockState { | ||
| @PrimaryColumn('integer') | ||
| indexedBlockHeight: number; |
There was a problem hiding this comment.
Suggested change
| indexedBlockHeight: number; | |
| blockHeight: number; |
| indexedBlockHeight: number; | ||
|
|
||
| @Column('text') | ||
| indexedBlockHash: string; |
There was a problem hiding this comment.
Suggested change
| indexedBlockHash: string; | |
| blockHash: string; |
Comment on lines
+14
to
+16
| const isVerbose = configService.get<boolean>('app.verbose') ?? false; | ||
|
|
||
| const isDebug = configService.get<boolean>('app.debug') ?? false; |
There was a problem hiding this comment.
nit
Suggested change
| const isVerbose = configService.get<boolean>('app.verbose') ?? false; | |
| const isDebug = configService.get<boolean>('app.debug') ?? false; | |
| const isVerbose = configService.get<boolean>('app.verbose') ?? false; | |
| const isDebug = configService.get<boolean>('app.debug') ?? false; |
Comment on lines
+58
to
+60
| if (state == null) { | ||
| return null; | ||
| } |
There was a problem hiding this comment.
nit
Suggested change
| if (state == null) { | |
| return null; | |
| } | |
| if (state == null) return null; |
| return null; | ||
| } | ||
|
|
||
| while (true) { |
There was a problem hiding this comment.
I don't like while true loops because they could lead to nasty infinite loop bugs. We should replace it with a suitable condition.
Comment on lines
+63
to
+65
| if (state === null) { | ||
| throw new Error('Reorgs levels deep'); | ||
| } |
There was a problem hiding this comment.
nit
Suggested change
| if (state === null) { | |
| throw new Error('Reorgs levels deep'); | |
| } | |
| if (state === null) throw new Error('Reorgs levels deep'); |
There was a problem hiding this comment.
if we store the entire block chain, I don't think we'll ever run into this case
Comment on lines
+137
to
+140
| await this.blockStateService.addBlockState({ | ||
| indexedBlockHash: blockHash, | ||
| indexedBlockHeight: height, | ||
| }); |
There was a problem hiding this comment.
this should be done inside setState
|
Here's a diff that addresses most but not all comments diff --git a/src/block-data-providers/base-block-data-provider.abstract.ts b/src/block-data-providers/base-block-data-provider.abstract.ts
index 05b5e6c..e631d69 100644
--- a/src/block-data-providers/base-block-data-provider.abstract.ts
+++ b/src/block-data-providers/base-block-data-provider.abstract.ts
@@ -7,6 +7,7 @@ import {
} from '@/indexer/indexer.service';
import { ConfigService } from '@nestjs/config';
import { BlockStateService } from '@/block-state/block-state.service';
+import { BlockState } from '@/block-state/block-state.entity';
export abstract class BaseBlockDataProvider<OperationState> {
protected abstract readonly logger: Logger;
@@ -43,11 +44,16 @@ export abstract class BaseBlockDataProvider<OperationState> {
)?.state;
}
- async setState(state: OperationState): Promise<void> {
+ async setState(
+ state: OperationState,
+ blockState: BlockState,
+ ): Promise<void> {
await this.operationStateService.setOperationState(
this.operationStateKey,
state,
);
+
+ await this.blockStateService.addBlockState(blockState);
}
abstract getBlockHash(height: number): Promise<string>;
@@ -55,24 +61,16 @@ export abstract class BaseBlockDataProvider<OperationState> {
async traceReorg(): Promise<number> {
let state = await this.blockStateService.getCurrentBlockState();
- if (state == null) {
- return null;
- }
+ if (state === null) return null;
while (true) {
- if (state === null) {
- throw new Error('Reorgs levels deep');
- }
+ if (state === null) throw new Error('Reorgs levels deep');
- const fetchedBlockHash = await this.getBlockHash(
- state.indexedBlockHeight,
- );
+ const fetchedBlockHash = await this.getBlockHash(state.blockHeight);
- if (state.indexedBlockHash === fetchedBlockHash) {
- return state.indexedBlockHeight;
- }
+ if (state.blockHash === fetchedBlockHash) return state.blockHeight;
- state = await this.blockStateService.dequeue_operation_state();
+ state = await this.blockStateService.dequeueState();
}
}
}
diff --git a/src/block-data-providers/bitcoin-core/provider.ts b/src/block-data-providers/bitcoin-core/provider.ts
index 5c8b9a4..b44bd16 100644
--- a/src/block-data-providers/bitcoin-core/provider.ts
+++ b/src/block-data-providers/bitcoin-core/provider.ts
@@ -73,15 +73,23 @@ export class BitcoinCoreProvider
);
} else {
this.logger.log('No previous state found. Starting from scratch.');
- const updatedState: BitcoinCoreOperationState = {
- indexedBlockHeight:
- this.configService.get<BitcoinNetwork>('app.network') ===
- BitcoinNetwork.MAINNET
- ? TAPROOT_ACTIVATION_HEIGHT - 1
- : 0,
- };
-
- await this.setState(updatedState);
+
+ const blockHeight =
+ this.configService.get<BitcoinNetwork>('app.network') ===
+ BitcoinNetwork.MAINNET
+ ? TAPROOT_ACTIVATION_HEIGHT - 1
+ : 0;
+ const blockHash = await this.getBlockHash(blockHeight);
+
+ await this.setState(
+ {
+ indexedBlockHeight: blockHeight,
+ },
+ {
+ blockHash,
+ blockHeight,
+ },
+ );
}
}
@@ -132,11 +140,9 @@ export class BitcoinCoreProvider
}
state.indexedBlockHeight = height;
- await this.setState(state);
-
- await this.blockStateService.addBlockState({
- indexedBlockHash: blockHash,
- indexedBlockHeight: height,
+ await this.setState(state, {
+ blockHash: blockHash,
+ blockHeight: height,
});
}
} finally {
diff --git a/src/block-data-providers/esplora/provider.ts b/src/block-data-providers/esplora/provider.ts
index 0403979..5dc36f5 100644
--- a/src/block-data-providers/esplora/provider.ts
+++ b/src/block-data-providers/esplora/provider.ts
@@ -71,16 +71,25 @@ export class EsploraProvider
);
} else {
this.logger.log('No previous state found. Starting from scratch.');
- const updatedState: EsploraOperationState = {
- currentBlockHeight: 0,
- indexedBlockHeight:
- this.configService.get<BitcoinNetwork>('app.network') ===
- BitcoinNetwork.MAINNET
- ? TAPROOT_ACTIVATION_HEIGHT - 1
- : 0,
- lastProcessedTxIndex: 0, // we dont take coinbase txn in account
- };
- await this.setState(updatedState);
+
+ const blockHeight =
+ this.configService.get<BitcoinNetwork>('app.network') ===
+ BitcoinNetwork.MAINNET
+ ? TAPROOT_ACTIVATION_HEIGHT - 1
+ : 0;
+ const blockHash = await this.getBlockHash(blockHeight);
+
+ await this.setState(
+ {
+ currentBlockHeight: 0,
+ indexedBlockHeight: blockHeight,
+ lastProcessedTxIndex: 0, // we don't take coinbase txn into account
+ },
+ {
+ blockHash,
+ blockHeight,
+ },
+ );
}
}
@@ -162,11 +171,9 @@ export class EsploraProvider
state.indexedBlockHeight = height;
state.lastProcessedTxIndex = i + this.batchSize - 1;
- await this.setState(state);
-
- await this.blockStateService.addBlockState({
- indexedBlockHash: hash,
- indexedBlockHeight: height,
+ await this.setState(state, {
+ blockHeight: height,
+ blockHash: hash,
});
} catch (error) {
this.logger.error(
diff --git a/src/block-state/block-state.entity.ts b/src/block-state/block-state.entity.ts
index 661700f..f31a7d7 100644
--- a/src/block-state/block-state.entity.ts
+++ b/src/block-state/block-state.entity.ts
@@ -3,8 +3,8 @@ import { Column, Entity, PrimaryColumn } from 'typeorm';
@Entity()
export class BlockState {
@PrimaryColumn('integer')
- indexedBlockHeight: number;
+ blockHeight: number;
@Column('text')
- indexedBlockHash: string;
+ blockHash: string;
}
diff --git a/src/block-state/block-state.service.ts b/src/block-state/block-state.service.ts
index e1e53b8..0faa6d9 100644
--- a/src/block-state/block-state.service.ts
+++ b/src/block-state/block-state.service.ts
@@ -15,60 +15,32 @@ export class BlockStateService {
) {}
async getCurrentBlockState(): Promise<BlockState> {
- const state = (
- await this.blockStateRepository.find({
- order: {
- indexedBlockHeight: 'DESC',
- },
- take: 1,
- })
- )[0];
-
- return state;
+ return this.blockStateRepository.findOne({
+ order: {
+ blockHeight: 'DESC',
+ },
+ });
}
async addBlockState(state: BlockState): Promise<void> {
- this.blockStateRepository.save(state);
- // Ensure the cache size does not exceed 2016
- await this.trimState();
+ await this.blockStateRepository.save(state);
}
// Remove and return the latest item in the state cache
- async dequeue_operation_state(): Promise<BlockState | null> {
- const latest_state = (
- await this.blockStateRepository.find({
- order: {
- indexedBlockHeight: 'DESC',
- },
- take: 1,
- })
- )[0];
-
- if (latest_state) {
- await this.blockStateRepository.remove(latest_state);
+ async dequeueState(): Promise<BlockState | null> {
+ const latestState = await this.blockStateRepository.findOne({
+ order: {
+ blockHeight: 'DESC',
+ },
+ });
+
+ if (latestState) {
+ await this.blockStateRepository.remove(latestState);
await this.transactionService.deleteTransactionByBlockHash(
- latest_state.indexedBlockHash,
+ latestState.blockHash,
);
- return latest_state;
}
- return null;
- }
-
- private async trimState(): Promise<void> {
- const queueCount = await this.blockStateRepository.count();
-
- if (queueCount >= this.cacheSize) {
- // Delete the oldest entries from the cache
- const old_states = await this.blockStateRepository.find({
- order: {
- indexedBlockHeight: 'ASC',
- },
- take: queueCount - this.cacheSize + 1,
- });
- await this.blockStateRepository.delete(
- old_states.map((state) => state.indexedBlockHeight),
- );
- }
+ return latestState;
}
}
diff --git a/src/main.ts b/src/main.ts
index 68f5ccf..6488ce1 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -12,18 +12,12 @@ async function bootstrap() {
const port = configService.get<number>('app.port');
const isVerbose = configService.get<boolean>('app.verbose') ?? false;
-
const isDebug = configService.get<boolean>('app.debug') ?? false;
const loggerLevels: LogLevel[] = ['error', 'warn', 'log'];
- if (isVerbose) {
- loggerLevels.push('verbose');
- }
-
- if (isDebug) {
- loggerLevels.push('debug');
- }
+ if (isVerbose) loggerLevels.push('verbose');
+ if (isDebug) loggerLevels.push('debug');
app.useLogger(loggerLevels);
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Reorgs Can be fatal to a blockchain indexer if not handled properly, this is because the during Reorgs, blocks are replaced with other blocks, leading to inconsistent state of the indexer. This inconsistency must be handled effectively to ensure correctness of such indexer.
Changes
OperationStatehandling logicScope Of Change
-The scope of change is critical because it affects the core functioning of the indexer.