Merge pull request #191 from api3dao/validate-dapi-name

Validate provided dAPI names to the scripts

scripts/deploy-communal-api3readerproxyv1.js

@@ -1,11 +1,13 @@
 const hre = require('hardhat');
 const api3Contracts = require('@api3/contracts');
+const { validateDapiName } = require('./utils');
 
 async function main() {
   const dapiName = process.env.DAPI_NAME;
   if (!dapiName) {
     throw new Error('Environment variable DAPI_NAME is not defined');
   }
+  validateDapiName(dapiName);
   const chainId = hre.network.config.chainId;
   const api3ReaderProxyV1Address = api3Contracts.computeCommunalApi3ReaderProxyV1Address(chainId, dapiName);
   if ((await hre.ethers.provider.getCode(api3ReaderProxyV1Address)) === '0x') {

scripts/deploy-dapp-specific-api3readerproxyv1-unsafe.js

@@ -3,6 +3,7 @@
 // proxies with arbirary dApp aliases to be deployed.
 const hre = require('hardhat');
 const api3Contracts = require('@api3/contracts');
+const { validateDapiName } = require('./utils');
 
 // Unlike the `@api3/contracts` version, the below does not throw due to
 // `dappAlias` not being recognized
@@ -20,6 +21,7 @@ async function main() {
   if (!dapiName) {
     throw new Error('Environment variable DAPI_NAME is not defined');
   }
+  validateDapiName(dapiName);
   const dappAlias = process.env.DAPP_ALIAS;
   if (!dappAlias) {
     throw new Error('Environment variable DAPP_ALIAS is not defined');

scripts/deploy-dapp-specific-api3readerproxyv1.js

@@ -1,11 +1,13 @@
 const hre = require('hardhat');
 const api3Contracts = require('@api3/contracts');
+const { validateDapiName } = require('./utils');
 
 async function main() {
   const dapiName = process.env.DAPI_NAME;
   if (!dapiName) {
     throw new Error('Environment variable DAPI_NAME is not defined');
   }
+  validateDapiName(dapiName);
   const dappAlias = process.env.DAPP_ALIAS;
   if (!dappAlias) {
     throw new Error('Environment variable DAPP_ALIAS is not defined');

scripts/print-communal-api3readerproxyv1-address.js

@@ -1,11 +1,13 @@
 const hre = require('hardhat');
 const api3Contracts = require('@api3/contracts');
+const { validateDapiName } = require('./utils');
 
 async function main() {
   const dapiName = process.env.DAPI_NAME;
   if (!dapiName) {
     throw new Error('Environment variable DAPI_NAME is not defined');
   }
+  validateDapiName(dapiName);
   const chainId = hre.network.config.chainId;
   const api3ReaderProxyV1Address = api3Contracts.computeCommunalApi3ReaderProxyV1Address(chainId, dapiName);
   console.log(`The address of the communal Api3ReaderProxyV1 for ${dapiName} is ${api3ReaderProxyV1Address}`);

scripts/print-dapp-specific-api3readerproxyv1-address.js

@@ -1,11 +1,13 @@
 const hre = require('hardhat');
 const api3Contracts = require('@api3/contracts');
+const { validateDapiName } = require('./utils');
 
 async function main() {
   const dapiName = process.env.DAPI_NAME;
   if (!dapiName) {
     throw new Error('Environment variable DAPI_NAME is not defined');
   }
+  validateDapiName(dapiName);
   const dappAlias = process.env.DAPP_ALIAS;
   if (!dappAlias) {
     throw new Error('Environment variable DAPP_ALIAS is not defined');

scripts/utils.js

@@ -0,0 +1,15 @@
+const api3DapiManagement = require('@api3/dapi-management');
+
+module.exports = {
+  validateDapiName: (dapiName) => {
+    const dapi = api3DapiManagement.dapis.find((dapi) => dapi.name === dapiName);
+    if (!dapi) {
+      throw new Error(`dAPI with name ${dapiName} does not exist`);
+    }
+    if (dapi.stage === 'deprecated') {
+      console.warn(`dAPI with name ${dapiName} is deprecated`);
+    } else if (dapi.stage !== 'active') {
+      throw new Error(`dAPI with name ${dapiName} is not active, its current state is ${dapi.stage}`);
+    }
+  },
+};