add include feature for generate configure (#12)

Author: fewensa

examples/bridges.mainnet.yml

@@ -27,17 +27,7 @@ configure:
     - name: polygon
       rpc: https://polygon-rpc.com
   bridges:
-    - direction: arbitrum->polygon
-      feeLimit: 100
-      reorgThreshold: 10
-      bridgeType: lnv3
-      safeWalletAddress: '0x000000000Bb6a011dB294ce3F3423f00EAc4959e'
-      safeWalletUrl: 'https://safe-transaction-polygon.safe.global/api'
-      safeWalletRole: signer
-      tokens:
-        - symbol: usdt->usdt
-          swapRate: 2300
-          withdrawLiquidityCountThreshold: 10
+    - include: arbitrum-polygon.yml
 
     - direction: polygon->arbitrum
       feeLimit: 150

examples/includes/mainnet/configures/arbitrum-polygon.yml

@@ -0,0 +1,13 @@
+
+- direction: arbitrum->polygon
+  feeLimit: 100
+  reorgThreshold: 10
+  bridgeType: lnv3
+  safeWalletAddress: '0x000000000Bb6a011dB294ce3F3423f00EAc4959e'
+  safeWalletUrl: 'https://safe-transaction-polygon.safe.global/api'
+  safeWalletRole: signer
+  tokens:
+    - symbol: usdt->usdt
+      swapRate: 2300
+      withdrawLiquidityCountThreshold: 10
+

examples/includes/mainnet/arbitrum-polygon.yml examples/includes/mainnet/registers/arbitrum-polygon.yml

@@ -38,6 +38,6 @@ export function datadir() {
 }
 
 export function datapath(file) {
-  return `${datadir()}${file}`
+  return `${datadir()}/${file}`
 }
 

src/ecosys/arg.js

@@ -29,6 +29,7 @@ async function generateWithGroup(options, group) {
   const bridgeConfigRaw = await fs.readFile(arg.datapath(`/bridges.${group}.yml`), 'utf8');
   const bridgeConfig = YAML.parse(bridgeConfigRaw);
   const configure = bridgeConfig.configure;
+  await refactorConfig({configure, group});
 
   const CONFIGURE_PATH = arg.datapath('/configure');
   const storeFile = `${CONFIGURE_PATH}/configure.${group}.json`;
@@ -50,6 +51,53 @@ async function generateWithGroup(options, group) {
   console.log('');
 }
 
+async function refactorConfig(options) {
+  const {configure, group} = options;
+  const nbdgs = [];
+  for (const bridge of configure.bridges) {
+    const include = bridge.include;
+    if (!include) {
+      nbdgs.push(bridge);
+      continue;
+    }
+
+    const keys = Object.keys(bridge);
+    if (keys.length > 1) {
+      throw new Error(`include mode please do not add other fields: [${keys.join(', ')}]`)
+    }
+
+    let includeFileContent;
+    if (fs.existsSync(include)) {
+      includeFileContent = await fs.readFile(include, 'utf8');
+    }
+    // check path from datapath
+    const pathOfIncludeFromDataPath = arg.datapath(include);
+    if (fs.existsSync(pathOfIncludeFromDataPath)) {
+      includeFileContent = await fs.readFile(pathOfIncludeFromDataPath, 'utf8');
+    }
+    // check group file
+    const pathOfGroupInclude = arg.datapath(`/includes/${group}/configures/${include}`);
+    if (fs.existsSync(pathOfGroupInclude)) {
+      includeFileContent = await fs.readFile(pathOfGroupInclude, 'utf8');
+    }
+    if (!includeFileContent) {
+      throw new Error(`include file ${include} not found, please check your path`);
+    }
+    const includeConfigs = YAML.parse(includeFileContent);
+    if (!includeConfigs) {
+      continue;
+    }
+    // check include configs
+    for (const ic of includeConfigs) {
+      const ickey = `${ic.direction}${ic.bridgeType}`.toUpperCase();
+      if (configure.bridges.findIndex(item => `${item.direction}${item.bridgeType}`.toUpperCase() === ickey) > -1) {
+        throw new Error(`duplicated config {direction: ${ic.direction}, bridgeType: ${ic.bridgeType}}`);
+      }
+    }
+    nbdgs.push(...includeConfigs);
+  }
+  configure.bridges = nbdgs;
+}
 
 async function _fillEncryptedPrivateKey(options) {
   const {configure} = options;

src/generator/generate_configure.js

@@ -92,14 +92,20 @@ async function refactorConfig(options) {
     includeFileContent = await fs.readFile(pathOfIncludeFromDataPath, 'utf8');
   }
   // check group file
-  const pathOfGroupInclude = arg.datapath(`/includes/${group}/${include}`);
+  const pathOfGroupInclude = arg.datapath(`/includes/${group}/registers/${include}`);
   if (fs.existsSync(pathOfGroupInclude)) {
     includeFileContent = await fs.readFile(pathOfGroupInclude, 'utf8');
   }
+  if (!includeFileContent) {
+    throw new Error(`include file ${include} not found, please check your path`);
+  }
   const includeConfigs = YAML.parse(includeFileContent);
+  if (!includeConfigs) {
+    return [];
+  }
   for (const ic of includeConfigs) {
-    const ickey = `${ic.bridge}${ic.symbol}${ic.type}`;
-    if (registers.findIndex(item => `${item.bridge}${item.symbol}${item.type}` === ickey) > -1) {
+    const ickey = `${ic.bridge}${ic.symbol}${ic.type}`.toUpperCase();
+    if (registers.findIndex(item => `${item.bridge}${item.symbol}${item.type}`.toUpperCase() === ickey) > -1) {
       throw new Error(`duplicated config {bridge: ${ic.bridge}, symbol: ${ic.symbol}, type: ${ic.type}}`);
     }
   }
@@ -165,7 +171,12 @@ async function hashRegister(register) {
   keys.sort();
   let merged = '';
   for (const key of keys) {
-    merged += register[key];
+    const rv = register[key];
+    if (typeof rv === 'object') {
+      merged += JSON.stringify(rv);
+    } else {
+      merged += rv;
+    }
   }
   const hash = await $`echo "${merged}" | sha256sum | cut -d ' ' -f1`;
   return {