reflect feedback: adjust for naming convention

api/listener/controller.go

@@ -34,7 +34,7 @@ type ListenerInsertModel struct {
 	Chain     string `db:"chain_name" json:"chain" validate:"required"`
 }
 
-type ListenerObservedBlockModel struct {
+type ObservedBlockModel struct {
 	BlockKey	string 	`db:"block_key" json:"blockKey" validate:"required"`
 	BlockNumber	int64 	`db:"block_number" json:"blockNumber" validate:"blockNumberValidator"`
 }
@@ -158,7 +158,7 @@ func deleteById(c *fiber.Ctx) error {
 }
 
 func upsertObservedBlock(c *fiber.Ctx) error {
-	payload := new(ListenerObservedBlockModel)
+	payload := new(ObservedBlockModel)
 	if err := c.BodyParser(payload); err != nil {
 		return err
 	}
@@ -171,16 +171,16 @@ func upsertObservedBlock(c *fiber.Ctx) error {
 		return err
 	}
 
-	result, err := utils.QueryRow[ListenerObservedBlockModel](c, UpsertObservedBlock, map[string]any{"block_key": payload.BlockKey, "block_number": payload.BlockNumber})
+	result, err := utils.QueryRow[ObservedBlockModel](c, UpsertObservedBlock, map[string]any{"block_key": payload.BlockKey, "block_number": payload.BlockNumber})
 	if err != nil {
 		return err
 	}
 	return c.JSON(result)
 }
 
 func getObservedBlock(c *fiber.Ctx) error {
-	block_key := c.Query("blockKey")
-	result, err := utils.QueryRow[ListenerObservedBlockModel](c, GetObservedBlock, map[string]any{"block_key": block_key})
+	blockKey := c.Query("blockKey")
+	result, err := utils.QueryRow[ObservedBlockModel](c, GetObservedBlock, map[string]any{"block_key": blockKey})
 	if err != nil {
 		return err
 	}

api/listener/queries.go

@@ -44,13 +44,13 @@ const (
 		`
 
 	GetObservedBlock = `
-		SELECT * FROM observed_block
+		SELECT * FROM observed_blocks
 		WHERE block_key = @block_key
 		LIMIT 1;
 	`
 
 	UpsertObservedBlock = `
-		INSERT INTO observed_block (block_key, block_number)
+		INSERT INTO observed_blocks (block_key, block_number)
 		VALUES (@block_key, @block_number)
 		ON CONFLICT (block_key) 
 		DO UPDATE SET block_number = @block_number

api/migrations/000002_add_observed_block.down.sql

@@ -1 +1 @@
-DROP TABLE IF EXISTS "observed_block";
+DROP TABLE IF EXISTS "observed_blocks";

api/migrations/000002_add_observed_block.up.sql

@@ -1,5 +1,5 @@
-CREATE TABLE IF NOT EXISTS "observed_block" (
+CREATE TABLE IF NOT EXISTS "observed_blocks" (
     block_key TEXT NOT NULL,
     block_number BIGINT NOT NULL,
-    CONSTRAINT "observed_block_key" UNIQUE ("block_key")
+    CONSTRAINT "observed_blocks_key" UNIQUE ("block_key")
 )

core/src/errors.ts

@@ -74,6 +74,6 @@ export enum OraklErrorCode {
   AxiosNotSupported,
   AxiosInvalidUrl,
   FailedToConnectAPI,
-  UpsertListenerObservedBlockFailed,
-  GetListenerObservedBlockFailed
+  UpsertObservedBlockFailed,
+  GetObservedBlockFailed
 }

core/src/listener/api.ts

@@ -60,7 +60,15 @@ export async function getListener({
   }
 }
 
-export async function getListenerObservedBlock({
+/**
+ * Get observed block number from the Orakl Network API for a given contract address
+ *
+ * @param {string} blockKey
+ * @param {pino.Logger} logger
+ * @return {Promise<IObservedBlock>}
+ * @exception {OraklErrorCode.GetObservedBlockFailed}
+ */
+export async function getObservedBlock({
   blockKey,
   logger
 }: {
@@ -71,8 +79,8 @@ export async function getListenerObservedBlock({
     const endpoint = buildUrl(ORAKL_NETWORK_API_URL, `listener/observed-block?blockKey=${blockKey}`)
     return (await axios.get(endpoint))?.data
   } catch (e) {
-    logger?.error({ name: 'getListenerObservedBlock', file: FILE_NAME, ...e }, 'error')
-    throw new OraklError(OraklErrorCode.GetListenerObservedBlockFailed)
+    logger?.error({ name: 'getObservedBlock', file: FILE_NAME, ...e }, 'error')
+    throw new OraklError(OraklErrorCode.GetObservedBlockFailed)
   }
 }
 
@@ -82,10 +90,10 @@ export async function getListenerObservedBlock({
  * @param {string} blockKey
  * @param {number} blockNumber
  * @param {pino.Logger} logger
- * @return {Promise<IListenerObservedBlock>}
- * @exception {UpsertListenerObservedBlockFailed}
+ * @return {Promise<IObservedBlock>}
+ * @exception {OraklErrorCode.UpsertObservedBlockFailed}
  */
-export async function upsertListenerObservedBlock({
+export async function upsertObservedBlock({
   blockKey,
   blockNumber,
   logger
@@ -98,7 +106,7 @@ export async function upsertListenerObservedBlock({
     const endpoint = buildUrl(ORAKL_NETWORK_API_URL, 'listener/observed-block')
     return (await axios.post(endpoint, { blockKey, blockNumber }))?.data
   } catch (e) {
-    logger?.error({ name: 'upsertListenerObservedBlock', file: FILE_NAME, ...e }, 'error')
-    throw new OraklError(OraklErrorCode.UpsertListenerObservedBlockFailed)
+    logger?.error({ name: 'upsertObservedBlock', file: FILE_NAME, ...e }, 'error')
+    throw new OraklError(OraklErrorCode.UpsertObservedBlockFailed)
   }
 }

core/src/listener/listener.ts

@@ -4,7 +4,7 @@ import { Logger } from 'pino'
 import type { RedisClientType } from 'redis'
 import { BULLMQ_CONNECTION, getObservedBlockRedisKey, LISTENER_JOB_SETTINGS } from '../settings'
 import { IListenerConfig } from '../types'
-import { upsertListenerObservedBlock } from './api'
+import { upsertObservedBlock } from './api'
 import { State } from './state'
 import { IHistoryListenerJob, ILatestListenerJob, ProcessEventOutputType } from './types'
 import { watchman } from './watchman'
@@ -155,8 +155,8 @@ function latestJob({
 }: {
   state: State
   historyListenerQueue: Queue
-  redisClient: RedisClientType
   workerQueue: Queue
+  redisClient: RedisClientType
   processFn: (log: ethers.Event) => Promise<ProcessEventOutputType | undefined>
   logger: Logger
 }) {
@@ -219,7 +219,7 @@ function latestJob({
               logger.debug(`Listener submitted job [${jobId}] for [${jobName}]`)
             }
           }
-          await upsertListenerObservedBlock({
+          await upsertObservedBlock({
             blockKey: observedBlockRedisKey,
             blockNumber,
             logger: this.logger
@@ -308,7 +308,7 @@ function historyJob({
       }
 
       if (blockNumber > observedBlock) {
-        await upsertListenerObservedBlock({
+        await upsertObservedBlock({
           blockKey: observedBlockRedisKey,
           blockNumber,
           logger

core/src/listener/state.ts

@@ -10,7 +10,7 @@ import {
   PROVIDER_URL
 } from '../settings'
 import { IListenerConfig, IListenerRawConfig } from '../types'
-import { getListenerObservedBlock, getListeners, upsertListenerObservedBlock } from './api'
+import { getListeners, getObservedBlock, upsertObservedBlock } from './api'
 import { IContracts, ILatestListenerJob } from './types'
 import { postprocessListeners } from './utils'
 
@@ -175,7 +175,7 @@ export class State {
     const contractAddress = toAddListener.address
     const observedBlockRedisKey = getObservedBlockRedisKey(contractAddress)
     const latestBlock = await this.latestBlockNumber()
-    const { blockKey: observedBlockKey } = await getListenerObservedBlock({
+    const { blockKey: observedBlockKey } = await getObservedBlock({
       blockKey: observedBlockRedisKey,
       logger: this.logger
     })
@@ -188,7 +188,7 @@ export class State {
       * it does not exist -> upsert latestBlock
      */
     if (observedBlockKey === '') {
-      await upsertListenerObservedBlock({
+      await upsertObservedBlock({
         blockKey: observedBlockRedisKey,
         blockNumber: Math.max(latestBlock - 1, 0),
         logger: this.logger