chore(refactor): Replace 'timestamp' with 'anchor' in BlockchainWriter (

#601)

README.md

@@ -130,7 +130,7 @@ This is what the default configuration looks like:
   bitcoinAddressPrivateKey: '',
 
   enableTimestamping: false,
-  timestampIntervalInSeconds: 30,
+  anchorIntervalInSeconds: 30,
   batchCreationIntervalInSeconds: 600
   readNextDirectoryIntervalInSeconds: 30
 }

src/BlockchainWriter/BlockchainWriter.ts

@@ -94,7 +94,7 @@ const createContainer = (
     .bind<BitcoinCore>('BitcoinCore')
     .toConstantValue(new BitcoinCore(bitcoinRPCConfigurationToBitcoinCoreArguments(configuration)))
   container.bind<ServiceConfiguration>('ServiceConfiguration').toConstantValue({
-    timestampIntervalInSeconds: configuration.timestampIntervalInSeconds,
+    anchorIntervalInSeconds: configuration.anchorIntervalInSeconds,
   })
   container.bind<ControllerConfiguration>('ClaimControllerConfiguration').toConstantValue(configuration)
   container.bind<ExchangeConfiguration>('ExchangeConfiguration').toConstantValue(configuration.exchanges)

src/BlockchainWriter/Controller.ts

@@ -41,9 +41,9 @@ export class Controller {
     this.exchange = exchange
   }
 
-  async requestTimestamp(ipfsDirectoryHash: string): Promise<void> {
+  async requestAnchor(ipfsDirectoryHash: string): Promise<void> {
     this.logger.debug({
-      method: 'timestampWithRetry',
+      method: 'requestAnchor',
       ipfsDirectoryHash,
     })
     await this.dao.insertIpfsDirectoryHash(ipfsDirectoryHash)

src/BlockchainWriter/Router.ts

@@ -27,14 +27,11 @@ export class Router {
   }
 
   async start() {
-    await this.messaging.consume(
-      this.exchange.batchWriterCreateNextBatchSuccess,
-      this.onBlockchainWriterRequestTimestampRequest
-    )
+    await this.messaging.consume(this.exchange.batchWriterCreateNextBatchSuccess, this.onCreateBatchSuccess)
   }
 
-  onBlockchainWriterRequestTimestampRequest = async (message: any): Promise<void> => {
-    const logger = this.logger.child({ method: 'onBlockchainWriterRequestTimestampRequest' })
+  onCreateBatchSuccess = async (message: any): Promise<void> => {
+    const logger = this.logger.child({ method: 'onCreateBatchSuccess' })
 
     const messageContent = message.content.toString()
     const { ipfsDirectoryHash } = JSON.parse(messageContent)
@@ -43,19 +40,19 @@ export class Router {
       {
         ipfsDirectoryHash,
       },
-      'creating timestamp request'
+      'Creating anchor request'
     )
 
     try {
-      await this.claimController.requestTimestamp(ipfsDirectoryHash)
-      logger.trace({ ipfsDirectoryHash }, 'Timestamp request created')
+      await this.claimController.requestAnchor(ipfsDirectoryHash)
+      logger.trace({ ipfsDirectoryHash }, 'Anchor request created')
     } catch (error) {
       logger.error(
         {
           error,
           ipfsDirectoryHash,
         },
-        'Timestamp request failure'
+        'Anchor request failure'
       )
     }
   }

src/BlockchainWriter/Service.ts

@@ -7,7 +7,7 @@ import { childWithFileName } from 'Helpers/Logging'
 import { Controller } from './Controller'
 
 export interface ServiceConfiguration {
-  readonly timestampIntervalInSeconds: number
+  readonly anchorIntervalInSeconds: number
 }
 
 @injectable()
@@ -23,7 +23,7 @@ export class Service {
   ) {
     this.logger = childWithFileName(logger, __filename)
     this.claimController = claimController
-    this.interval = new Interval(this.timestampNextHash, 1000 * configuration.timestampIntervalInSeconds)
+    this.interval = new Interval(this.anchorNextHash, 1000 * configuration.anchorIntervalInSeconds)
   }
 
   async start() {
@@ -34,10 +34,10 @@ export class Service {
     this.interval.stop()
   }
 
-  private timestampNextHash = async () => {
-    const logger = this.logger.child({ method: 'timestampNextHash' })
+  private anchorNextHash = async () => {
+    const logger = this.logger.child({ method: 'anchorNextHash' })
 
-    logger.trace('Requesting Timestamping of Next Hash')
+    logger.trace('Requesting anchoring of next hash')
 
     try {
       await this.claimController.anchorNextIPFSDirectoryHash()
@@ -46,7 +46,7 @@ export class Service {
         {
           error,
         },
-        'Uncaught exception while timestamping next hash'
+        'Uncaught exception while anchoring next hash'
       )
     }
   }

src/Configuration.ts

@@ -31,7 +31,7 @@ export interface Configuration extends LoggingConfiguration, BitcoinRPCConfigura
   readonly forceBlockHeight?: number
 
   readonly enableTimestamping: boolean
-  readonly timestampIntervalInSeconds: number
+  readonly anchorIntervalInSeconds: number
 
   readonly healthIntervalInSeconds: number
 
@@ -98,7 +98,7 @@ const defaultConfiguration: Configuration = {
   blockchainReaderIntervalInSeconds: 5,
 
   enableTimestamping: false,
-  timestampIntervalInSeconds: 30,
+  anchorIntervalInSeconds: 30,
 
   healthIntervalInSeconds: 30,
 

src/app.ts

@@ -175,7 +175,7 @@ export async function app(localVars: any = {}) {
         rabbitmqUrl: configuration.rabbitmqUrl,
         poetNetwork: configuration.poetNetwork,
         poetVersion: configuration.poetVersion,
-        timestampIntervalInSeconds: configuration.timestampIntervalInSeconds,
+        anchorIntervalInSeconds: configuration.anchorIntervalInSeconds,
         bitcoinUrl: configuration.bitcoinUrl,
         bitcoinPort: configuration.bitcoinPort,
         bitcoinNetwork: configuration.bitcoinNetwork,

tests/functional/claim_with_data.ts

@@ -20,7 +20,7 @@ const getWorkFromNodeB = getWork(NODE_B_PORT)
 const blockchainSettings = {
   MINIMUM_BLOCK_HEIGHT: 100,
   ENABLE_TIMESTAMPING: true,
-  TIMESTAMP_INTERVAL_IN_SECONDS: 10,
+  ANCHOR_INTERVAL_IN_SECONDS: 10,
   BATCH_CREATION_INTERVAL_IN_SECONDS: 5,
   READ_DIRECTORY_INTERVAL_IN_SECONDS: 5,
   UPLOAD_CLAIM_INTERVAL_IN_SECONDS: 5,
@@ -93,7 +93,7 @@ describe('A user can successfully submit a claim into the po.et network', async
   }
 
   // Wait for a claim batch to be submitted to the blockchain.
-  await delay(parseInt(process.env.TIMESTAMP_INTERVAL_IN_SECONDS || '10', 10) * 1000 * 2)
+  await delay(parseInt(process.env.ANCHOR_INTERVAL_IN_SECONDS || '10', 10) * 1000 * 2)
 
   // mine N confirmation blocks on bitcoindA.
   await bitcoindClientA.generate(parseInt(process.env.CONFIRMATION_BLOCKS || '1', 10))

tests/helpers/utils.ts

@@ -18,7 +18,7 @@ export const createDatabase = async (prefix: string) => {
 
 const defaultBlockchainSettings = {
   MINIMUM_BLOCK_HEIGHT: 100,
-  TIMESTAMP_INTERVAL_IN_SECONDS: 10,
+  ANCHOR_INTERVAL_IN_SECONDS: 10,
   BATCH_CREATION_INTERVAL_IN_SECONDS: 5,
   READ_DIRECTORY_INTERVAL_IN_SECONDS: 5,
   UPLOAD_CLAIM_INTERVAL_IN_SECONDS: 5,