refactor: Contract validation

Author: evaporei

src/commands/init.js

@@ -16,6 +16,7 @@ const { fixParameters } = require('../command-helpers/gluegun')
 const { chooseNodeUrl } = require('../command-helpers/node')
 const { generateScaffold, writeScaffold } = require('../command-helpers/scaffold')
 const { abiEvents } = require('../scaffold/schema')
+const { validateContract } = require('../validation')
 const Protocol = require('../protocols')
 
 const protocolChoices = Array.from(Protocol.availableProtocols().keys())
@@ -179,14 +180,12 @@ const processInitForm = async (
           return true
         }
 
-        const contract = new ProtocolContract(value)
+        // Validate whether the contract is valid
+        const { valid, error } = validateContract(value, ProtocolContract)
 
-        // Validate whether the address is valid
-        if (!contract.validate()) {
-          return `Contract ${ProtocolContract.identifierName()} is invalid: ${value}\n${ProtocolContract.errorMessage()}`
-        }
-
-        return true
+        return valid
+          ? true
+          : error
       },
       result: async value => {
         if (fromExample !== undefined) {

src/protocols/ethereum/contract.js

@@ -3,19 +3,20 @@ module.exports = class EthereumContract {
     return 'address'
   }
 
-  static pattern() {
-    return /^(0x)?[0-9a-fA-F]{40}$/
-  }
-
-  static errorMessage() {
-    return "Must be 40 hexadecimal characters, with an optional '0x' prefix."
-  }
-
   constructor(address) {
     this.address = address
   }
 
   validate() {
-    return EthereumContract.pattern().test(this.address)
+    const pattern = /^(0x)?[0-9a-fA-F]{40}$/
+
+    const errorMessage = "Must be 40 hexadecimal characters, with an optional '0x' prefix."
+
+    const valid = pattern.test(this.address)
+
+    return {
+      valid,
+      error: valid ? null : errorMessage,
+    }
   }
 }

src/protocols/ethereum/subgraph.js

@@ -1,7 +1,6 @@
 const immutable = require('immutable')
 const ABI = require('./abi')
 const DataSourcesExtractor = require('../../command-helpers/data-sources')
-const { validateContractValues } = require('../../validation')
 
 module.exports = class EthereumSubgraph {
   constructor(options = {}) {

src/protocols/near/contract.js

@@ -1,22 +1,13 @@
 const MINIMUM_ACCOUNT_ID_LENGTH = 2
 const MAXIMUM_ACCOUNT_ID_LENGTH = 64
 
+const RULES_URL = 'https://docs.near.org/docs/concepts/account#account-id-rules'
+
 module.exports = class NearContract {
   static identifierName() {
     return 'account'
   }
 
-  static pattern() {
-    return /^(([a-z\d]+[\-_])*[a-z\d]+\.)*([a-z\d]+[\-_])*[a-z\d]+$/
-  }
-
-  static errorMessage() {
-    return `Must be between '${MINIMUM_ACCOUNT_ID_LENGTH}' and '${MAXIMUM_ACCOUNT_ID_LENGTH}' characters
-An Account ID consists of Account ID parts separated by '.' (dots)
-Each Account ID part consists of lowercase alphanumeric symbols separated by either a '_' (underscore) or '-' (dash)
-For further information look for: https://docs.near.org/docs/concepts/account#account-id-rules`
-  }
-
   constructor(account) {
     this.account = account
   }
@@ -26,9 +17,30 @@ For further information look for: https://docs.near.org/docs/concepts/account#ac
       this.account.length <= MAXIMUM_ACCOUNT_ID_LENGTH
   }
 
+  _validateFormat() {
+    const pattern = /^(([a-z\d]+[\-_])*[a-z\d]+\.)*([a-z\d]+[\-_])*[a-z\d]+$/
+
+    return pattern.test(this.account)
+  }
+
   validate() {
-    // Reference: https://docs.near.org/docs/concepts/account#account-id-rules
-    return this._validateLength(this.account) &&
-      NearContract.pattern().test(this.account)
+    if (!this._validateLength(this.account)) {
+      return {
+        valid: false,
+        error: `Account must be between '${MINIMUM_ACCOUNT_ID_LENGTH}' and '${MAXIMUM_ACCOUNT_ID_LENGTH}' characters, see ${RULES_URL}`,
+      }
+    }
+
+    if (!this._validateFormat()) {
+      return {
+        valid: false,
+        error: `Account must conform to the rules on ${RULES_URL}`,
+      }
+    }
+
+    return {
+      valid: true,
+      error: null,
+    }
   }
 }

src/protocols/near/subgraph.js

@@ -1,5 +1,4 @@
 const immutable = require('immutable')
-const { validateContractValues } = require('../../validation')
 
 module.exports = class NearSubgraph {
   constructor(options = {}) {

src/validation/contract.js

@@ -0,0 +1,56 @@
+const immutable = require('immutable')
+
+const validateContract = (value, ProtocolContract) => {
+  const contract = new ProtocolContract(value)
+
+  const { valid, error } = contract.validate()
+
+  if (!valid) {
+    return {
+      valid,
+      error: `Contract ${ProtocolContract.identifierName()} is invalid: ${value}\n${error}`,
+    }
+  }
+
+  return { valid, error }
+}
+
+const validateContractValues = (manifest, protocol) => {
+  const ProtocolContract = protocol.getContract()
+
+  const fieldName = ProtocolContract.identifierName()
+
+  return manifest
+    .get('dataSources')
+    .filter(dataSource => protocol.isValidKindName(dataSource.get('kind')))
+    .reduce((errors, dataSource, dataSourceIndex) => {
+      let path = ['dataSources', dataSourceIndex, 'source', fieldName]
+
+      // No need to validate if the source has no contract field
+      if (!dataSource.get('source').has(fieldName)) {
+        return errors
+      }
+
+      let contractValue = dataSource.getIn(['source', fieldName])
+
+
+      const { valid, error } = validateContract(contractValue, ProtocolContract)
+
+      // Validate whether the contract is valid for the protocol
+      if (valid) {
+        return errors
+      } else {
+        return errors.push(
+          immutable.fromJS({
+            path,
+            message: error,
+          }),
+        )
+      }
+    }, immutable.List())
+}
+
+module.exports = {
+  validateContract,
+  validateContractValues,
+}

src/validation/index.js

@@ -1,5 +1,6 @@
 module.exports = {
   validateSchema: require('./schema').validateSchema,
   validateManifest: require('./manifest').validateManifest,
-  validateContractValues: require('./manifest').validateContractValues,
+  validateContractValues: require('./contract').validateContractValues,
+  validateContract: require('./contract').validateContract,
 }

src/validation/manifest.js

@@ -282,43 +282,6 @@ const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
   return validateDataSourceNetworks(value, protocol)
 }
 
-const validateContractValues = (manifest, protocol) => {
-  const ProtocolContract = protocol.getContract()
-
-  const fieldName = ProtocolContract.identifierName()
-  const errorMessage = ProtocolContract.errorMessage()
-
-  return manifest
-    .get('dataSources')
-    .filter(dataSource => protocol.isValidKindName(dataSource.get('kind')))
-    .reduce((errors, dataSource, dataSourceIndex) => {
-      let path = ['dataSources', dataSourceIndex, 'source', fieldName]
-
-      // No need to validate if the source has no contract field
-      if (!dataSource.get('source').has(fieldName)) {
-        return errors
-      }
-
-      let contractValue = dataSource.getIn(['source', fieldName])
-
-      let contract = new ProtocolContract(contractValue)
-
-      // Validate whether the contract is valid for the protocol
-      if (contract.validate()) {
-        return errors
-      } else {
-        return errors.push(
-          immutable.fromJS({
-            path,
-            message: `\
-Contract ${fieldName} is invalid: ${contractValue}\n${errorMessage}`,
-          }),
-        )
-      }
-    }, immutable.List())
-}
-
 module.exports = {
   validateManifest,
-  validateContractValues,
 }