Implement WebSocket to Stream Silent Blocks #46
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
theanmolsharma
requested changes
Sep 28, 2024
There was a problem hiding this comment.
A few more thoughts:
- I see that you are injecting
SilentBlocksGatewayintoSilentBlocksService. That is not the standard pattern. Gateways are like Controllers. You don't inject controllers into a service, you inject service into a controller. Therefore, please remove the event handling logic fromSilentBlocksServiceand move it to inside ofSilentBlocksGateway. - I also think we should use
socket.ioand leverage the concept of rooms. Once a client connects to use, we can subscribe them to aSILENT_BLOCKroom. Then we just need to publish silent block to that room and let socket.io handle it from there. This will eliminate the need offorEachloop inbroadcastSilentBlock
|
Okay, changes noted |
theanmolsharma
requested changes
Oct 16, 2024
There was a problem hiding this comment.
the lock file is not up to date with package.json
diff --git a/package-lock.json b/package-lock.json
index c0b2e37..05d3cd2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -17,6 +17,7 @@
"@nestjs/passport": "^10.0.0",
"@nestjs/platform-express": "^10.3.7",
"@nestjs/platform-socket.io": "^10.3.7",
+ "@nestjs/platform-ws": "^10.4.4",
"@nestjs/schedule": "^3.0.0",
"@nestjs/swagger": "^7.3.1",
"@nestjs/typeorm": "^10.0.2",
@@ -32,7 +33,6 @@
},
"devDependencies": {
"@nestjs/cli": "^10.4.5",
- "@nestjs/platform-ws": "^10.4.4",
"@nestjs/schematics": "^9.0.0",
"@nestjs/testing": "^10.3.7",
"@types/express": "^4.17.13",
@@ -2044,7 +2044,6 @@
"version": "10.4.4",
"resolved": "https://registry.npmjs.org/@nestjs/platform-ws/-/platform-ws-10.4.4.tgz",
"integrity": "sha512-6E476YvfO14uQUT6FzWFpGnwp58fpGq2aeGxHFdRMMptOQ5suKqD+3LsZgPiGF1elgVhQcI5uqM15qL3yH+OqQ==",
- "dev": true,
"dependencies": {
"tslib": "2.7.0",
"ws": "8.18.0"
@@ -2062,14 +2061,12 @@
"node_modules/@nestjs/platform-ws/node_modules/tslib": {
"version": "2.7.0",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
- "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA==",
- "dev": true
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
},
"node_modules/@nestjs/platform-ws/node_modules/ws": {
"version": "8.18.0",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz",
"integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==",
- "dev": true,
"engines": {
"node": ">=10.0.0"
},| @@ -44,6 +46,7 @@ export class BitcoinCoreProvider | |||
| private readonly configService: ConfigService, | |||
| indexerService: IndexerService, | |||
| operationStateService: OperationStateService, | |||
| private eventEmitter: EventEmitter2, | |||
There was a problem hiding this comment.
Suggested change
| private eventEmitter: EventEmitter2, | |
| private readonly eventEmitter: EventEmitter2, |
| @@ -29,6 +30,8 @@ export class EsploraProvider | |||
| private readonly configService: ConfigService, | |||
| indexerService: IndexerService, | |||
| operationStateService: OperationStateService, | |||
| private eventEmitter: EventEmitter2, | |||
There was a problem hiding this comment.
Suggested change
| private eventEmitter: EventEmitter2, | |
| private readonly eventEmitter: EventEmitter2, |
There was a problem hiding this comment.
We need to emit INDEXED_BLOCK_EVENT event in this provider as well
| @OnEvent(INDEXED_BLOCK_EVENT) | ||
| async handleBlockIndexedEvent(blockHeight: number) { | ||
| this.logger.debug(`New block indexed: ${blockHeight}`); | ||
| await delay(1000); |
There was a problem hiding this comment.
Why are we adding a delay here?
Comment on lines
+31
to
+35
| this.server.clients.forEach((client: WebSocket) => { | ||
| if (client.readyState === WebSocket.OPEN) { | ||
| client.send(silentBlock.toString('hex')); // Send silent block as hex string | ||
| } | ||
| }); |
There was a problem hiding this comment.
- because everything inside
forEachis a synchronous operation, we should use a simplefor..ofloop.forEachis very slow. - I see that you are sending the block as a hex string. This breaks the pattern we use for REST endpoints. We send the block as
Bufferin REST endpoints. I think we should stick to usingBufferhere as well for consistency.
|
Please Rebase From main |
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(s):
Implement a WebSocket connection to stream silent blocks to the client whenever a new block is found and indexed. This will eliminate the need for the client to keep polling for new blocks.
Changes:
wslibrary.base-block-data-provider.abstract.tsthat emits an event whenever a new block is indexed.SilentBlocksServiceand trigger the silent block broadcasting logic when the event is fired.Scope of Change:
This change is semi-critical. While it doesn't directly affect core functionality, it significantly enhances the user experience and system efficiency by providing real-time updates.
solves #45