feat: store block and hash info (#764)

add BlockInfoDAO to store the highest block

references: #764 , #707

Author: krobi64

src/BlockchainWriter/BlockInfoDAO.test.ts

@@ -0,0 +1,49 @@
+/* tslint:disable:no-relative-imports */
+import { describe } from 'riteway'
+import { runtimeId, setUpDb } from '../../tests/helpers/utils'
+import { BlockInfoDAO } from './BlockInfoDAO'
+
+const prefix = runtimeId()
+
+describe('BlockInfoDAO.insertBlockInfo', async assert => {
+  const db = await setUpDb(prefix)
+  const { result, mongoClient } = await db.collection('blockchainInfo')
+  const blockchainInfoCollection = result
+  const blockInfoDAO = new BlockInfoDAO(blockchainInfoCollection)
+  await blockInfoDAO.start()
+  const expected = { height: 12345, hash: 'this-is-a-hash', previousHash: 'this-is-a-parent-hash' }
+  await blockInfoDAO.insertBlockInfo(expected)
+  const actual = await blockchainInfoCollection.find().limit(1).next()
+
+  assert({
+    given: 'a lightBlock',
+    should: 'store the block in mongodb',
+    actual,
+    expected,
+  })
+
+  await mongoClient.close()
+  await db.teardown()
+})
+
+describe('BlockInfoDAO.getHighestBlock', async assert => {
+  const db = await setUpDb(prefix)
+  const { result, mongoClient } = await db.collection('blockchainInfo')
+  const blockchainInfoCollection = result
+  const blockInfoDAO = new BlockInfoDAO(blockchainInfoCollection)
+  await blockInfoDAO.start()
+  await blockInfoDAO.insertBlockInfo({ height: 1234, hash: 'wrong-hash', previousHash: 'wrong-hash-parent' })
+  const expected = { height: 54321, hash: 'good-hash', previousHash: 'parentHash '}
+  await blockInfoDAO.insertBlockInfo(expected)
+  const actual = await blockInfoDAO.getHighestBlock()
+
+  assert({
+    given: 'multiple blocks in mongo',
+    should: 'retrieve the block with the greatest height',
+    actual,
+    expected,
+  })
+
+  await mongoClient.close()
+  await db.teardown()
+})

src/BlockchainWriter/BlockInfoDAO.ts

@@ -0,0 +1,26 @@
+import { LightBlock } from 'Messaging/Messages'
+import { inject, injectable } from 'inversify'
+import { Collection } from 'mongodb'
+
+@injectable()
+export class BlockInfoDAO {
+  private readonly blockchainInfo: Collection
+
+  constructor(
+    @inject('BlockchainInfoCollection') blockchainInfo: Collection,
+  ) {
+    this.blockchainInfo = blockchainInfo
+  }
+
+  readonly start = async () => {
+    await this.blockchainInfo.createIndex({ height: 1, hash: 1 }, { unique: true })
+  }
+
+  readonly insertBlockInfo = (lightBlock: LightBlock) =>
+    this.blockchainInfo.insertOne(lightBlock)
+
+  readonly getHighestBlock = async (): Promise<LightBlock> => {
+    const cursor = this.blockchainInfo.find().sort({height: -1}).limit(1)
+    return await cursor.next()
+  }
+}

src/BlockchainWriter/BlockchainWriter.ts

@@ -45,8 +45,14 @@ export class BlockchainWriter {
     const db = await this.mongoClient.db()
 
     const blockchainWriterCollection = db.collection('blockchainWriter')
+    const blockchainInfoCollection = db.collection('blockchainInfo')
 
-    const container = createContainer(this.configuration, this.logger, blockchainWriterCollection)
+    const container = createContainer(
+      this.configuration,
+      this.logger,
+      blockchainWriterCollection,
+      blockchainInfoCollection,
+    )
 
     this.messaging = container.get('Messaging') as Messaging
     await this.messaging.start()
@@ -77,6 +83,7 @@ const createContainer = (
   configuration: BlockchainWriterConfiguration,
   logger: Pino.Logger,
   blockchainWriterCollection: Collection,
+  blockchainInfo: Collection,
 ) => {
   const container = new Container()
 
@@ -86,7 +93,12 @@ const createContainer = (
   container.bind<DAO>('DAO').to(DAO)
 
   container.bind<Pino.Logger>('Logger').toConstantValue(logger)
-  container.bind<Collection>('BlockchainWriterCollection').toConstantValue(blockchainWriterCollection)
+  container
+    .bind<Collection>('BlockchainWriterCollection')
+    .toConstantValue(blockchainWriterCollection)
+  container
+    .bind<Collection>('BlockchainInfoCollection')
+    .toConstantValue(blockchainInfo)
 
   const exchangesMessaging = pick(['poetAnchorDownloaded', 'claimsDownloaded'], configuration.exchanges)
   container.bind<Messaging>('Messaging').toConstantValue(new Messaging(configuration.rabbitmqUrl, exchangesMessaging))

tests/helpers/database.ts

@@ -35,7 +35,35 @@ export const dbHelper = () => {
     await mongoClient.close()
   }
 
+  const dbExecuteWithClient = async (...fns: any) => {
+    const mongodbUrl = loadConfigurationWithDefaults({
+      MONGODB_USER: 'root',
+      MONGODB_PASSWORD: 'rootPass',
+      MONGODB_DATABASE: tempDbName,
+    }).mongodbUrl
+
+    console.log(`Connecting to temporary DB (${mongodbUrl})...`)
+    const mongoClient = await MongoClient.connect(
+      mongodbUrl,
+      { authSource: 'admin' },
+    )
+    let result
+
+    try {
+      const db = await mongoClient.db()
+      result = await pipeP(...fns)(db)
+    } catch (err) {
+      console.log(err)
+    }
+    return { result, mongoClient }
+  }
+
   return {
+    collection: async (collection: string = 'poet') => {
+      if (setupCalled) return await dbExecuteWithClient(async (db: any) => db.collection(collection))
+      else console.log('ERROR: setup() must be called before collection()')
+      return
+    },
     setup: async (dbNamePrefix: string = null, dbUser: string = null, dbPassword: string = null) => {
       tempDbName = dbNamePrefix || id
       const tempDbUser = dbUser || `test-${id}`
@@ -57,7 +85,7 @@ export const dbHelper = () => {
       if (setupCalled) {
         console.log(`Deleting temporary DB (${tempDbName})...`)
         await dbExecute(async (db: any) => db.dropDatabase())
-      } else console.log('ERROR: setup() must be called vefore teardown()')
+      } else console.log('ERROR: setup() must be called before teardown()')
     },
   }
 }

tests/helpers/utils.ts

@@ -13,6 +13,7 @@ export const createDatabase = async (prefix: string) => {
   return {
     teardown: db.teardown,
     settings: await db.setup(prefix),
+    collection: db.collection,
   }
 }
 
@@ -24,6 +25,10 @@ const defaultBlockchainSettings = {
   UPLOAD_CLAIM_INTERVAL_IN_SECONDS: 5,
 }
 
+export const setUpDb = async (prefix: string) => {
+  return await createDatabase(prefix)
+}
+
 export const setUpServerAndDb = async ({
   PREFIX,
   NODE_PORT,

tests/unit/index.ts

@@ -5,6 +5,7 @@ import '../../src/API/Middlewares/RequestValidationMiddleware.test'
 import '../../src/API/Middlewares/RequestValidationMiddleware.test.ts'
 import '../../src/BlockchainReader/Bitcoin.test'
 import '../../src/BlockchainWriter/Bitcoin.test'
+import '../../src/BlockchainWriter/BlockInfoDAO.test'
 import '../../src/BlockchainWriter/Exceptions.test'
 import '../../src/Configuration.test'
 import '../../src/Extensions/Array.test.ts'