NODE REAL #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

ghost wants to merge 2,141 commits into node-real:main from DefiLlama:main

.github/scripts/validate-chain-files.js

-Original file line number
+Diff line change
@@ -0,0 +1,278 @@
+    import path from 'path';
+    import { fetchWithCache } from '../../utils/fetch.js';
+    import fs from 'fs';
+    const isExtracRpcsFileChanged = (process.env.EXTRA_RPC_CHANGED || '').trim().length > 0;
+    const addedOrModified = process.env.FILES_CHANGED.split(' ');
+    // Function to write to step summary
+    function writeToStepSummary(content) {
+      if (process.env.GITHUB_STEP_SUMMARY) {
+        try {
+          fs.appendFileSync(process.env.GITHUB_STEP_SUMMARY, content + '\n');
+        } catch (error) {
+          console.error('Failed to write to step summary:', error.message);
+        }
+      }
+    }
+    // Function to write errors to a file that persists between steps
+    function writeErrorsToFile(errors) {
+      try {
+        const errorContent = errors.join('\n');
+        fs.writeFileSync('/tmp/validation-errors.txt', errorContent);
+        console.log('Errors written to /tmp/validation-errors.txt');
+      } catch (error) {
+        console.error('Failed to write errors to file:', error.message);
+      }
+    }
+    // Main async function to run validation
+    async function runValidation() {
+      // Collect all errors
+      const errors = [];
+      if (isExtracRpcsFileChanged) {
+        try {
+          await validateExtracRpcs();
+        } catch (error) {
+          errors.push(error.message);
+          writeToStepSummary(`❌ ${error.message}`);
+        }
+      }
+      // Process chain files sequentially to avoid overwhelming the system
+      for (const filePath of addedOrModified) {
+        if (filePath.trim()) {
+          try {
+            await validateChainFile(filePath);
+          } catch (error) {
+            errors.push(error.message);
+            writeToStepSummary(`❌ ${error.message}`);
+          }
+        }
+      }
+      // If there are errors, throw them all at once
+      if (errors.length > 0) {
+        const errorSummary = errors.join('\n');
+        writeToStepSummary(`\n## Validation Summary\n\n${errors.length} validation error(s) found:\n\n${errorSummary}`);
+        writeErrorsToFile(errors);
+        throw new Error(`Validation failed with ${errors.length} error(s):\n${errorSummary}`);
+      }
+      // Write success message to step summary
+      writeToStepSummary('✅ All chain files validated successfully!');
+    }
+    // Run the validation
+    runValidation().catch(error => {
+      console.error('Validation failed:', error.message);
+      process.exit(1);
+    });
+    const rpcTrackingSet = new Set(['none', 'limited', 'yes', 'unspecified']);
+    // Validate chainid-*.js files
+    async function validateChainFile(filePath) {
+      filePath = filePath.trim();
+      const filename = path.basename(filePath);
+      try {
+        if (!filename.startsWith('chainid-') || !filename.endsWith('.js')) {
+          throw new Error(`${filePath}  does not match chainid-*.js pattern`);
+        }
+        const { data } = await import(path.join('..', '..', filePath))
+        const { features, faucets, nativeCurrency, explorers, parent, } = data;
+        if (typeof data !== 'object' || !data)
+          throw new Error('Data should be an object: ')
+        numberCheck(data, 'chainId', true);
+        numberCheck(data, 'networkId', true);
+        stringCheck(data, 'name', true);
+        stringCheck(data, 'shortName', true);
+        stringCheck(data, 'chain', true);
+        stringCheck(data, 'icon');
+        stringCheck(data, 'infoURL')
+        stringCheck(data, 'title')
+        stringCheck(nativeCurrency, 'name', true);
+        stringCheck(nativeCurrency, 'symbol', true);
+        numberCheck(nativeCurrency, 'decimals', true);
+        if (typeof explorers === 'object') {
+          if (!Array.isArray(explorers)) {
+            throw new Error('Explorers should be an array');
+          }
+          explorers.forEach((explorer) => {
+            stringCheck(explorer, 'name', true);
+            stringCheck(explorer, 'url', true);
+            stringCheck(explorer, 'standard');
+          });
+        }
+        if (typeof features === 'object') {
+          if (!Array.isArray(features)) {
+            throw new Error('Features should be an array');
+          }
+          features.forEach((feature) => {
+            stringCheck(feature, 'name', true);
+          });
+        }
+        if (Array.isArray(faucets)) {
+          faucets.forEach((faucet) => {
+            if (typeof faucet !== 'string') {
+              throw new Error('Faucets should be an array of strings');
+            }
+          });
+        }
+        if (!Array.isArray(data.rpc) || data.rpc.length === 0) {
+          throw new Error('RPCs should be a non-empty array');
+        }
+        data.rpc.map(validateRPC)
+        const { chainIdConfigMap, } = await getChainlistConfig();
+        if (chainIdConfigMap[data.chainId]) {
+          console.warn(`Chain ID ${data.chainId} already exists in chainlist.org/rpcs.json`);
+          if (chainIdConfigMap[data.chainId].shortName !== data.shortName)
+            throw new Error(`Chain ID ${data.chainId} already exists with a different shortName: ${chainIdConfigMap[data.chainId].shortName}`);
+          if (chainIdConfigMap[data.chainId].name !== data.name)
+            throw new Error(`Chain ID ${data.chainId} already exists with a different name: ${chainIdConfigMap[data.chainId].name}`);
+        }
+        if (parent) {
+          stringCheck(parent, 'type', true);
+          stringCheck(parent, 'chain', true);
+          if (Array.isArray(parent.bridges)) {
+            parent.bridges.forEach((bridge) => {
+              stringCheck(bridge, 'url', true);
+            });
+          }
+          if (!parent.chain.startsWith('eip155-')) {
+            throw new Error(`Parent chain should start with eip155-: ${parent.chain}`);
+          }
+          const parentChainId = parent.chain.split('-')[1]
+          if (!chainIdConfigMap[parentChainId]) {
+            throw new Error(`Parent chain ${parentChainId} does not exist in chainlist.org/rpcs.json`);
+          }
+        }
+      } catch (e) {
+        throw new Error(`Validation failed for ${filename}: ${e.message}`);
+      }
+    }
+    async function validateExtracRpcs() {
+      try {
+        const { default: extraRpcs } = await import(path.join('..', '..', 'constants/extraRpcs.js'));
+        Object.entries(extraRpcs).forEach(([chainId, config]) => {
+          validateRPCConfig(config, chainId);
+        })
+      } catch (e) {
+        throw new Error(`extracRpcs.js import failed: ${e.message}`);
+      }
+    }
+    function validateRPCConfig(config, configId) {
+      if (typeof config !== 'object') throw new Error('RPC config should be an object');
+      if (!Array.isArray(config.rpcs)) throw new Error('RPC config rpc should be an array');
+      config.rpcs.map(validateRPC)
+      if (config.hasOwnProperty('rpcWorking') && typeof config.rpcWorking !== 'boolean') {
+        throw new Error('RPC rpcWorking should be a boolean ' + configId);
+      }
+      if (config.hasOwnProperty('websiteDead') && typeof config.websiteDead !== 'boolean' && typeof config.websiteDead !== 'string') {
+        throw new Error('RPC websiteDead should be a boolean ' + configId);
+      }
+    }
+    function validateRPC(rpc) {
+      if (typeof rpc === 'string' && rpc.length) return;
+      if (typeof rpc !== 'object') throw new Error('RPC should be an object')
+      if (typeof rpc.url !== 'string') throw new Error('RPC url should be a string' + JSON.stringify(rpc));
+      if (rpc.hasOwnProperty('tracking')) {
+        if (typeof rpc.tracking !== 'string') {
+          throw new Error('RPC tracking should be a string ' + rpc.url);
+        }
+        if (!rpcTrackingSet.has(rpc.tracking)) {
+          throw new Error('Unknown rpc tracking status ' + rpc.url);
+        }
+      }
+      if (rpc.hasOwnProperty('trackingDetails') && typeof rpc.trackingDetails !== 'string') {
+        throw new Error('RPC trackingDetails should be a string ' + rpc.url);
+      }
+      if (rpc.hasOwnProperty('name') && typeof rpc.name !== 'string') {
+        throw new Error('RPC name should be a string ' + rpc.url);
+      }
+    }
+    let chainlistConfig
+    function getChainlistConfig() {
+      if (!chainlistConfig) chainlistConfig = _getChainlistConfig()
+      return chainlistConfig
+      async function _getChainlistConfig() {
+        const rpcInfo = await fetchWithCache('https://chainlist.org/rpcs.json')
+        console.log('Fetched RPC info from chainlist.org/rpcs.json')
+        const chainIdConfigMap = {}
+        const shortNameChainIdMap = {}
+        const nameChainIdMap = {}
+        rpcInfo.forEach((chain) => {
+          if (chain.chainId === undefined || chain.name === undefined || chain.shortName === undefined) {
+            return
+          }
+          chainIdConfigMap[chain.chainId] = {
+            name: chain.name,
+            shortName: chain.shortName,
+            rpc: chain.rpc,
+            website: chain.website,
+            icon: chain.icon,
+            tracking: chain.tracking,
+            trackingDetails: chain.trackingDetails,
+          }
+          shortNameChainIdMap[chain.shortName] = chain.chainId
+          nameChainIdMap[chain.name] = chain.chainId
+        })
+        return {
+          chainIdConfigMap,
+          shortNameChainIdMap,
+          nameChainIdMap,
+        }
+      }
+    }
+    function stringCheck(obj, field, isMandatory = false) {
+      if (typeof obj !== 'object' || !obj) throw new Error(`Chain ${field} should be an object`);
+      if (isMandatory && !obj.hasOwnProperty(field)) {
+        throw new Error(`Chain ${field} is mandatory`);
+      }
+      if (obj.hasOwnProperty(field) && typeof obj[field] !== 'string') {
+        throw new Error(`Chain ${field} is not a string`);
+      }
+    }
+    function numberCheck(obj, field, isMandatory = false) {
+      if (typeof obj !== 'object' || !obj) throw new Error(`Chain ${field} should be an object`);
+      if (isMandatory && !obj.hasOwnProperty(field)) {
+        throw new Error(`Chain ${field} is mandatory`);
+      }
+      if (obj.hasOwnProperty(field) && typeof obj[field] !== 'number') {
+        throw new Error(`Chain ${field} is  not a number`);
+      }
+    }

.github/workflows/check-duplicate-keys.yml

-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    name: Check Duplicate Keys
+    on:
+      pull_request:
+        paths:
+          - 'constants/extraRpcs.js'
+          - 'constants/chainIds.js'
+      push:
+        branches:
+          - main
+        paths:
+          - 'constants/extraRpcs.js'
+          - 'constants/chainIds.js'
+    jobs:
+      check-duplicates:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v3
+          - name: Setup Node.js
+            uses: actions/setup-node@v3
+            with:
+              node-version: '18'
+          - name: Check for duplicate keys
+            run: node tests/check-duplicate-keys.js

.github/workflows/validate-chain-files.yml

-Original file line number
+Diff line change
@@ -0,0 +1,61 @@
+    name: Validate Chain Files
+    on:
+      pull_request_target:
+        paths:
+          - 'constants/additionalChainRegistry/*'
+          - 'constants/extraRpcs.js'
+    jobs:
+      validate:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v3
+            with:
+              fetch-depth: 100
+          - name: Set changed files
+            id: files
+            run: |
+              echo "FILES_CHANGED=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep 'constants/additionalChainRegistry/' | tr '\n' ' ' | sed 's/ $//' || true)" >> $GITHUB_ENV
+              echo "EXTRA_RPC_CHANGED=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep 'constants/extraRpcs.js' | tr '\n' ' ' | sed 's/ $//' || true)" >> $GITHUB_ENV
+          - name: Validate chain and extracRpcs files
+            run: |
+              node -v
+              echo "Files changed: $FILES_CHANGED"
+              echo "Extra RPC files changed: $EXTRA_RPC_CHANGED"
+              if [ -z "$FILES_CHANGED" ] && [ -z "$EXTRA_RPC_CHANGED" ]; then
+                echo "No relevant files changed."
+                exit 0
+              fi
+              yarn
+              ONLY_LIST_FILE=true npm run build
+              node .github/scripts/validate-chain-files.js
+            env:
+              FILES_CHANGED: ${{ env.FILES_CHANGED }}
+              EXTRA_RPC_CHANGED: ${{ env.EXTRA_RPC_CHANGED }}
+          - name: Comment on PR if validation fails
+            if: failure()
+            uses: actions/github-script@v7
+            with:
+              script: |
+                const fs = require('fs');
+                let errorContent = 'See workflow logs for details.';
+                try {
+                  if (fs.existsSync('/tmp/validation-errors.txt')) {
+                    errorContent = fs.readFileSync('/tmp/validation-errors.txt', 'utf8');
+                  }
+                } catch (error) {
+                  console.log('Could not read validation errors file:', error.message);
+                }
+                github.rest.issues.createComment({
+                  issue_number: context.issue.number,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  body: "Validation failed for chain files. Please check the workflow logs for details.\n\nError message:\n```\n" + errorContent + "\n```"
+                })

.gitignore

-Original file line number
+Diff line change
@@ -1,5 +1,8 @@
     # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+    # generated files
+    constants/additionalChainRegistry/list.js
     # dependencies
     /node_modules
     /.pnp
@@ Expand Down Expand Up / @@ -29,6 +32,10 @@ yarn-error.log* @@
     .env.development.local
     .env.test.local
     .env.production.local
+    .env
     # vercel
     .vercel
+    # others
+    build.log

.prettierignore

-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    sitemap.xml.js
+    .next
+    out
+    public

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NODE REAL #30

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

NODE REAL #30

Are you sure you want to change the base?

Uh oh!

NODE REAL #30

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!