bitfinexcom · tarcisiozf · Jul 21, 2025 · Jun 9, 2025 · Jun 12, 2025 · Jun 12, 2025
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,7 +10,8 @@
     "Ezequiel Wernicke <ezequiel.wernicke@bitfinex.com>"
   ],
   "dependencies": {
-    "ajv": "8.6.3",
+    "ajv": "8.17.1",
+    "ajv-formats": "3.0.1",
     "async": "3.2.4",
     "better-npm-run": "0.1.1",
     "bfx-facs-base": "git+https://github.com:bitfinexcom/bfx-facs-base.git",

diff --git a/workers/loc.api/data-validator/helpers/index.js b/workers/loc.api/data-validator/helpers/index.js
@@ -0,0 +1,36 @@
+'use strict'
+
+const path = require('node:path')
+
+const SCHEMA_DOMAIN = require('../schema.domain')
+
+const getSchemaIds = (schemaNames, schemaDomain) => {
+  const domain = schemaDomain ?? SCHEMA_DOMAIN
+  const names = Object.entries(schemaNames ?? {})
+
+  const schemaIds = {}
+
+  for (const [key, name] of names) {
+    schemaIds[key] = `${domain}/${name}`
+  }
+
+  return schemaIds
+}
+
+const requireSchemas = (schemaNames, baseSchemaPath) => {
+  const schemaPath = baseSchemaPath ?? path.join(__dirname, '../schemas')
+  const names = Object.values(schemaNames ?? {})
+
+  const schemas = {}
+
+  for (const name of names) {
+    schemas[name] = require(path.join(schemaPath, name))
+  }
+
+  return schemas
+}
+
+module.exports = {
+  getSchemaIds,
+  requireSchemas
+}
diff --git a/workers/loc.api/data-validator/index.js b/workers/loc.api/data-validator/index.js
@@ -0,0 +1,102 @@
+'use strict'
+
+const Ajv = require('ajv')
+const addFormats = require('ajv-formats')
+const argv = require('yargs').argv
+
+const isDevEnv = (
+  argv.env === 'development' ||
+  process.env.NODE_ENV === 'development'
+)
+
+const {
+  ArgsParamsError,
+  ParamsValidSchemaFindingError
+} = require('../errors')
+
+const SCHEMA_DOMAIN = require('./schema.domain')
+const SCHEMA_NAMES = require('./schema.names')
+const SCHEMA_IDS = require('./schema.ids')
+const schemas = require('./schemas')
+
+const ajv = new Ajv({
+  // Compile schema on initialization
+  schemas: Object.values(schemas),
+
+  // Strict mode
+  strict: true,
+  strictRequired: true,
+  allowMatchingProperties: true,
+  allowUnionTypes: true,
+
+  $data: true,
+  ownProperties: true,
+  allErrors: true,
+  messages: true,
+  formats: { reserved: true },
+  verbose: isDevEnv
+})
+addFormats(ajv)
+
+const addSchemas = (schemas = []) => {
+  const _schemas = Array.isArray(schemas)
+    ? schemas
+    : [schemas]
+
+  if (_schemas.length === 0) {
+    return
+  }
+
+  for (const schema of schemas) {
+    ajv.addSchema(schema)
+  }
+}
+
+const validate = (args, schemaId, opts) => {
+  const {
+    shouldParamsFieldBeChecked
+  } = opts ?? {}
+  const params = args?.params
+
+  if (
+    !shouldParamsFieldBeChecked &&
+    (
+      typeof params === 'undefined' ||
+      params === null
+    )
+  ) {
+    return true
+  }
+
+  const validate = ajv.getSchema(schemaId)
+
+  if (typeof validate !== 'function') {
+    throw new ParamsValidSchemaFindingError()
+  }
+
+  const res = validate(params)
+
+  // It covers a case when schema has `$async: true` keyword
+  if (res instanceof Promise) {
+    return res
+      .then(() => true)
+      .catch((err) => Promise.reject(
+        new ArgsParamsError({ data: err.errors })
+      ))
+  }
+
+  if (res) {
+    return true
+  }
+
+  throw new ArgsParamsError({ data: validate.errors })
+}
+
+module.exports = {
+  SCHEMA_DOMAIN,
+  SCHEMA_NAMES,
+  SCHEMA_IDS,
+
+  addSchemas,
+  validate
+}
diff --git a/workers/loc.api/data-validator/schema.domain.js b/workers/loc.api/data-validator/schema.domain.js
@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = 'report.bitfinex.com'
diff --git a/workers/loc.api/data-validator/schema.ids.js b/workers/loc.api/data-validator/schema.ids.js
@@ -0,0 +1,6 @@
+'use strict'
+
+const SCHEMA_NAMES = require('./schema.names')
+const { getSchemaIds } = require('./helpers')
+
+module.exports = getSchemaIds(SCHEMA_NAMES)
diff --git a/workers/loc.api/data-validator/schema.names.js b/workers/loc.api/data-validator/schema.names.js
@@ -0,0 +1,32 @@
+'use strict'
+
+module.exports = {
+  DEFS: 'defs',
+
+  COMMON_REQ: 'commonReq',
+  GET_WEIGHTED_AVERAGES_REPORT_REQ: 'getWeightedAveragesReportReq',
+  GET_PAY_INVOICE_LIST_REQ: 'getPayInvoiceListReq',
+  GET_STATUS_MESSAGES_REQ: 'getStatusMessagesReq',
+  GET_PUBLIC_TRADES_REQ: 'getPublicTradesReq',
+  GET_POSITIONS_AUDIT_REQ: 'getPositionsAuditReq',
+  GET_ORDER_TRADES_REQ: 'getOrderTradesReq',
+  GET_CANDLES_REQ: 'getCandlesReq',
+  GET_LEDGERS_REQ: 'getLedgersReq',
+  GET_TICKERS_HISTORY_REQ: 'getTickersHistoryReq',
+  GET_MOVEMENT_INFO_REQ: 'getMovementInfoReq',
+  GET_WALLETS_REQ: 'getWalletsReq',
+
+  COMMON_FILE_REQ: 'commonFileReq',
+  GET_MULTIPLE_FILE_REQ: 'getMultipleFileReq',
+  GET_TICKERS_HISTORY_FILE_REQ: 'getTickersHistoryFileReq',
+  GET_MOVEMENTS_FILE_REQ: 'getMovementsFileReq',
+  GET_LEDGERS_FILE_REQ: 'getLedgersFileReq',
+  GET_WALLETS_FILE_REQ: 'getWalletsFileReq',
+  GET_ACTIVE_POSITIONS_FILE_REQ: 'getActivePositionsFileReq',
+  GET_POSITIONS_AUDIT_FILE_REQ: 'getPositionsAuditFileReq',
+  GET_PUBLIC_TRADES_FILE_REQ: 'getPublicTradesFileReq',
+  GET_STATUS_MESSAGES_FILE_REQ: 'getStatusMessagesFileReq',
+  GET_CANDLES_FILE_REQ: 'getCandlesFileReq',
+  GET_ORDER_TRADES_FILE_REQ: 'getOrderTradesFileReq',
+  GET_WEIGHTED_AVERAGES_REPORT_FILE_REQ: 'getWeightedAveragesReportFileReq'
+}
diff --git a/workers/loc.api/data-validator/schemas/commonFileReq.js b/workers/loc.api/data-validator/schemas/commonFileReq.js
@@ -0,0 +1,48 @@
+'use strict'
+
+const SCHEMA_IDS = require('../schema.ids')
+
+module.exports = {
+  $id: SCHEMA_IDS.COMMON_FILE_REQ,
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    start: {
+      $ref: 'defs#/definitions/start'
+    },
+    end: {
+      $ref: 'defs#/definitions/end'
+    },
+    limit: {
+      $ref: 'defs#/definitions/limit'
+    },
+    symbol: {
+      $ref: 'defs#/definitions/symbolWithMinItem'
+    },
+    filter: {
+      $ref: 'defs#/definitions/filter'
+    },
+
+    email: {
+      $ref: 'defs#/definitions/email'
+    },
+    milliseconds: {
+      $ref: 'defs#/definitions/milliseconds'
+    },
+    dateFormat: {
+      $ref: 'defs#/definitions/dateFormat'
+    },
+    language: {
+      $ref: 'defs#/definitions/language'
+    },
+    timezone: {
+      $ref: 'defs#/definitions/timezone'
+    },
+    isPDFRequired: {
+      $ref: 'defs#/definitions/isPDFRequired'
+    },
+    isSignatureRequired: {
+      $ref: 'defs#/definitions/isSignatureRequired'
+    }
+  }
+}
diff --git a/workers/loc.api/data-validator/schemas/commonReq.js b/workers/loc.api/data-validator/schemas/commonReq.js
@@ -0,0 +1,36 @@
+'use strict'
+
+const SCHEMA_IDS = require('../schema.ids')
+
+module.exports = {
+  $id: SCHEMA_IDS.COMMON_REQ,
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    start: {
+      $ref: 'defs#/definitions/start'
+    },
+    end: {
+      $ref: 'defs#/definitions/end'
+    },
+    limit: {
+      $ref: 'defs#/definitions/limit'
+    },
+    symbol: {
+      $ref: 'defs#/definitions/symbolWithMinItem'
+    },
+    filter: {
+      $ref: 'defs#/definitions/filter'
+    },
+
+    notCheckNextPage: {
+      $ref: 'defs#/definitions/notCheckNextPage'
+    },
+    notThrowError: {
+      $ref: 'defs#/definitions/notThrowError'
+    },
+    isSyncRequest: {
+      $ref: 'defs#/definitions/isSyncRequest'
+    }
+  }
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		'use strict'

		module.exports = 'report.bitfinex.com'