feat: specify chain scan interval in seconds instead of minutes (#99)

Change `BLOCKCHAIN_SCAN_INTERVAL_MINUTES` to
`BLOCKCHAIN_SCAN_INTERVAL_SECONDS`

Author: JoeCap08055

.env.docker.dev

@@ -24,9 +24,9 @@ STARTING_BLOCK=1
 # Redis URL
 REDIS_URL=redis://redis:6379
 
-# How many minutes to delay between successive scans of the chain
-# for new accounts (after end of chain is reached)
-BLOCKCHAIN_SCAN_INTERVAL_MINUTES=1
+# How many seconds to delay between successive scans of the chain
+# for new content (after end of chain is reached)
+BLOCKCHAIN_SCAN_INTERVAL_SECONDS=12
 
 # Max number of jobs allowed on the queue before
 # blockchain scan will be paused to allow queue to drain

ENVIRONMENT.md

@@ -5,7 +5,7 @@ This application recognizes the following environment variables:
 | Name                               | Description                                                                                                        |       Range/Type       | Required? | Default |
 | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ | :--------------------: | :-------: | :-----: |
 | `API_PORT`                         | HTTP port that the application listens on                                                                          |      1025 - 65535      |           |  3000   |
-| `BLOCKCHAIN_SCAN_INTERVAL_MINUTES` | How many minutes to delay between successive scans of the chain for new accounts (after end of chain is reached)   |          > 0           |           |   180   |
+| `BLOCKCHAIN_SCAN_INTERVAL_SECONDS` | How many seconds to delay between successive scans of the chain for new content (after end of chain is reached)    |          > 0           |           |    12   |
 | `FREQUENCY_URL`                    | Blockchain node address                                                                                            | http(s): or ws(s): URL |     Y     |         |
 | `IPFS_BASIC_AUTH_SECRET`           | If required for read requests, put Infura auth token here, or leave blank for default Kubo RPC                                                  |         string         |     N     |  blank  |
 | `IPFS_BASIC_AUTH_USER`             | If required for read requests, put Infura Project ID here, or leave blank for default Kubo RPC                                                  |         string         |     N     |  blank  |

INSTALLING.md

@@ -61,5 +61,5 @@ The following is a list of environment variables that may be set to control the
 |`FREQUENCY_URL`|**yes**|Blockchain URL|_none_|
 |`STARTING_BLOCK`|**maybe**|Starting block for scanner to scan from|_none_|
 |`REDIS_URL`|**yes**|URL used to connect to Redis instance|_none_<br/>\*preset to the internal Redis URL in the standalone container|
-|`BLOCKCHAIN_SCAN_INTERVAL_MINUTES`|no|# of minutes to wait in between scans of the blockchain|180|
+|`BLOCKCHAIN_SCAN_INTERVAL_SECONDS`|no|# of seconds to wait in between scans of the blockchain|12|
 |`QUEUE_HIGH_WATER`|no|# of pending queue entries to allow before pausing blockchain scanning until the next scan cycle|1000|

docker-compose.yaml

@@ -3,14 +3,14 @@ x-content-watcher-environment: &content-watcher-environment
   FREQUENCY_URL: 'ws://frequency:9944'
   STARTING_BLOCK: 1
   REDIS_URL: 'redis://redis:6379'
-  BLOCKCHAIN_SCAN_INTERVAL_MINUTES: 1
+  BLOCKCHAIN_SCAN_INTERVAL_SECONDS: 12
   QUEUE_HIGH_WATER: 1000
   WEBHOOK_FAILURE_THRESHOLD: 4
   WEBHOOK_RETRY_INTERVAL_SECONDS: 10
   API_PORT: 3000
   CAPACITY_LIMIT: '{"type":"percentage", "value":80}'
   IPFS_ENDPOINT: 'http://ipfs:5001'
-  
+
 services:
   redis:
     image: redis:latest
@@ -28,9 +28,9 @@ services:
     platform: linux/amd64
     # Uncomment SEALING_MODE and SEALING_INTERVAL if you want to use interval sealing.
     # Other options you may want to add depending on your test scenario.
-    # environment:
-    #   - SEALING_MODE=interval
-    #   - SEALING_INTERVAL=3
+    environment:
+      - SEALING_MODE=interval
+      - SEALING_INTERVAL=1
     #   - CREATE_EMPTY_BLOCKS=true
     # Uncomment below if you want to let the chain run and keep all of the historical blocks
     # command: --state-pruning=archive

env.template

@@ -23,9 +23,9 @@ STARTING_BLOCK=1
 # Redis URL
 REDIS_URL=redis://0.0.0.0:6379
 
-# How many minutes to delay between successive scans of the chain
-# for new accounts (after end of chain is reached)
-BLOCKCHAIN_SCAN_INTERVAL_MINUTES=1
+# How many seconds to delay between successive scans of the chain
+# for new content (after end of chain is reached)
+BLOCKCHAIN_SCAN_INTERVAL_SECONDS=12
 
 # Max number of jobs allowed on the queue before
 # blockchain scan will be paused to allow queue to drain

libs/common/src/config/config.service.spec.ts

@@ -40,7 +40,7 @@ describe('ContentWatcherConfigService', () => {
     IPFS_GATEWAY_URL: undefined,
     IPFS_BASIC_AUTH_USER: undefined,
     IPFS_BASIC_AUTH_SECRET: undefined,
-    BLOCKCHAIN_SCAN_INTERVAL_MINUTES: undefined,
+    BLOCKCHAIN_SCAN_INTERVAL_SECONDS: undefined,
     QUEUE_HIGH_WATER: undefined,
     WEBHOOK_FAILURE_THRESHOLD: undefined,
     WEBHOOK_RETRY_INTERVAL_SECONDS: undefined,
@@ -75,10 +75,10 @@ describe('ContentWatcherConfigService', () => {
     });
 
     it('invalid scan interval should fail', async () => {
-      const { BLOCKCHAIN_SCAN_INTERVAL_MINUTES: dummy, ...env } = ALL_ENV;
-      await expect(setupConfigService({ BLOCKCHAIN_SCAN_INTERVAL_MINUTES: -1, ...env })).rejects.toBeDefined();
-      await expect(setupConfigService({ BLOCKCHAIN_SCAN_INTERVAL_MINUTES: 0, ...env })).rejects.toBeDefined();
-      await expect(setupConfigService({ BLOCKCHAIN_SCAN_INTERVAL_MINUTES: 'foo', ...env })).rejects.toBeDefined();
+      const { BLOCKCHAIN_SCAN_INTERVAL_SECONDS: dummy, ...env } = ALL_ENV;
+      await expect(setupConfigService({ BLOCKCHAIN_SCAN_INTERVAL_SECONDS: -1, ...env })).rejects.toBeDefined();
+      await expect(setupConfigService({ BLOCKCHAIN_SCAN_INTERVAL_SECONDS: 0, ...env })).rejects.toBeDefined();
+      await expect(setupConfigService({ BLOCKCHAIN_SCAN_INTERVAL_SECONDS: 'foo', ...env })).rejects.toBeDefined();
     });
 
     it('invalid queue high water should fail', async () => {
@@ -113,7 +113,7 @@ describe('ContentWatcherConfigService', () => {
     });
 
     it('should get scan interval', () => {
-      expect(contentWatcherConfigService.blockchainScanIntervalMinutes).toStrictEqual(parseInt(ALL_ENV.BLOCKCHAIN_SCAN_INTERVAL_MINUTES as string, 10));
+      expect(contentWatcherConfigService.blockchainScanIntervalSeconds).toStrictEqual(parseInt(ALL_ENV.BLOCKCHAIN_SCAN_INTERVAL_SECONDS as string));
     });
 
     it('should get queue high water mark', () => {

libs/common/src/config/config.service.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 /*
 https://docs.nestjs.com/providers#services
 */
@@ -13,7 +14,7 @@ export interface ConfigEnvironmentVariables {
   REDIS_URL: URL;
   FREQUENCY_URL: URL;
   STARTING_BLOCK: string;
-  BLOCKCHAIN_SCAN_INTERVAL_MINUTES: number;
+  BLOCKCHAIN_SCAN_INTERVAL_SECONDS: number;
   QUEUE_HIGH_WATER: number;
   WEBHOOK_FAILURE_THRESHOLD: number;
   WEBHOOK_RETRY_INTERVAL_SECONDS: number;
@@ -41,8 +42,8 @@ export class ConfigService {
     return this.nestConfigService.get<number>('STARTING_BLOCK')!;
   }
 
-  public get blockchainScanIntervalMinutes(): number {
-    return this.nestConfigService.get<number>('BLOCKCHAIN_SCAN_INTERVAL_MINUTES') ?? 1;
+  public get blockchainScanIntervalSeconds(): number {
+    return this.nestConfigService.get<number>('BLOCKCHAIN_SCAN_INTERVAL_SECONDS') ?? 12;
   }
 
   public get queueHighWater(): number {

libs/common/src/config/env.config.ts

@@ -11,9 +11,9 @@ export const configModuleOptions: ConfigModuleOptions = {
     REDIS_URL: Joi.string().uri().required(),
     FREQUENCY_URL: Joi.string().uri().required(),
     STARTING_BLOCK: Joi.number().min(1),
-    BLOCKCHAIN_SCAN_INTERVAL_MINUTES: Joi.number()
+    BLOCKCHAIN_SCAN_INTERVAL_SECONDS: Joi.number()
       .min(1)
-      .default(3 * 60),
+      .default(12),
     QUEUE_HIGH_WATER: Joi.number().min(100).default(1000),
     WEBHOOK_FAILURE_THRESHOLD: Joi.number().min(0).default(3),
     WEBHOOK_RETRY_INTERVAL_SECONDS: Joi.number().min(1).default(10),

libs/common/src/scanner/scanner.ts

@@ -46,7 +46,7 @@ export class ScannerService implements OnApplicationBootstrap, OnApplicationShut
     }
     setImmediate(() => this.scan());
 
-    const scanInterval = this.configService.blockchainScanIntervalMinutes * SECONDS_PER_MINUTE * MILLISECONDS_PER_SECOND;
+    const scanInterval = this.configService.blockchainScanIntervalSeconds * MILLISECONDS_PER_SECOND;
     this.schedulerRegistry.addInterval(
       INTERVAL_SCAN_NAME,
       setInterval(() => this.scan(), scanInterval),