Merge pull request #462 from api3dao/main

Initiate release

Author: bbenligiray

.github/workflows/validate-verify.yml

@@ -31,14 +31,12 @@ jobs:
 
       - name: Build
         run: pnpm build
-
-      - name: Check local metadata
-        run: pnpm check
+        id: build
 
       - name: Validate deployments
         run: pnpm validate-deployments
-        if: always()
+        if: steps.build.outcome == 'success'
 
       - name: Verify deployments
         run: pnpm verify-deployments
-        if: always()
+        if: steps.build.outcome == 'success'

data/dapps/dtrinity.json

@@ -1,6 +1,6 @@
 {
   "aliases": {
-    "dtrinity": { "chains": ["fraxtal"], "title": "dTRINITY" }
+    "dtrinity": { "chains": ["fraxtal", "sonic"], "title": "dTRINITY" }
   },
   "homepageUrl": "https://dtrinity.org/"
 }

data/dapps/nerite.json

@@ -0,0 +1,6 @@
+{
+  "aliases": {
+    "nerite": { "chains": ["arbitrum"], "title": "Nerite" }
+  },
+  "homepageUrl": "https://www.nerite.org/"
+}

data/dapps/segment-finance.json

@@ -0,0 +1,6 @@
+{
+  "aliases": {
+    "segment-finance": { "chains": ["bob"], "title": "Segment Finance" }
+  },
+  "homepageUrl": "https://www.segment.finance/"
+}

package.json

@@ -32,10 +32,11 @@
     "api3-contracts": "./dist/bin/cli.js"
   },
   "scripts": {
-    "build": "pnpm build:hardhat && pnpm generate && pnpm check && tsc -p tsconfig.build.json",
+    "build": "pnpm check && pnpm build:hardhat && pnpm generate && tsc -p tsconfig.build.json",
     "build:hardhat": "hardhat --config hardhat.build.config.ts compile",
-    "check": "pnpm check:chains && pnpm check:deployment-addresses && pnpm check:deployment-config && pnpm check:chain-support-order",
+    "check": "pnpm check:chains && pnpm check:dapps && pnpm check:deployment-addresses && pnpm check:deployment-config && pnpm check:chain-support-order",
     "check:chains": "ts-node scripts/check-chains.ts",
+    "check:dapps": "ts-node scripts/check-dapps.ts",
     "check:deployment-addresses": "ts-node scripts/check-deployment-addresses.ts",
     "check:deployment-config": "ts-node scripts/check-deployment-config.ts",
     "check:chain-support-order": "ts-node scripts/check-chain-support-order.ts",

scripts/check-chains.ts

@@ -1,7 +1,8 @@
 import fs from 'node:fs';
 import path from 'node:path';
 
-import { CHAINS, chainSchema } from '../src';
+import { CHAINS } from '../src/generated/chains';
+import { chainSchema } from '../src/types';
 import { deepEqual } from '../src/utils/deep-equal';
 
 const INPUT_DIR = path.join('data', 'chains');

scripts/check-dapps.ts

@@ -0,0 +1,67 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { DAPPS } from '../src/generated/dapps';
+import { dappSchema, type Dapp } from '../src/types';
+import { deepEqual } from '../src/utils/deep-equal';
+import { toLowerKebabCase } from '../src/utils/strings';
+
+const INPUT_DIR = path.join('data', 'dapps');
+
+const fileNames = fs.readdirSync(INPUT_DIR);
+const jsonFiles = fileNames.filter((fileName) => fileName.endsWith('.json'));
+
+const jsonDapps: Dapp[] = jsonFiles.map((filePath: string) => {
+  const fullPath = path.join(INPUT_DIR, filePath);
+  const fileContentRaw = fs.readFileSync(fullPath, 'utf8');
+  return JSON.parse(fileContentRaw);
+});
+
+const logs: string[] = [];
+
+// Validation: Ensure that each JSON file is represented in the DAPPS array
+if (DAPPS.length !== jsonDapps.length) {
+  logs.push(
+    'Generated dapps differs in length to the number of JSON files',
+    `Generated DAPPS length = ${DAPPS.length}. Expected ${jsonDapps.length} dApps\n`
+  );
+}
+
+// Validation: Ensure that each JSON file is named as a prefix of one of the dApp's titles
+jsonFiles.forEach((filePath: string, index: number) => {
+  const dapp: Dapp = jsonDapps[index]!;
+  const uniqueDappTitles = [
+    ...new Set(Object.values(dapp.aliases).map((dappAliasValue) => toLowerKebabCase(dappAliasValue.title))),
+  ];
+  if (!uniqueDappTitles.some((uniqueDappTitle) => uniqueDappTitle.startsWith(filePath.replace('.json', '')))) {
+    logs.push(
+      'JSON file name must be the prefix of a dApp title',
+      `Current value: ${filePath}. Expected to be prefix of: ${uniqueDappTitles.join('/')}\n`
+    );
+  }
+});
+
+jsonDapps.forEach((dapp: Dapp, index: number) => {
+  const res = dappSchema.safeParse(dapp);
+  // Validation: Ensure each JSON file content conforms to the required schema
+  if (!res.success) {
+    const errors = res.error.issues.map((issue) => {
+      return `  path: '${issue.path.join('.')}' => '${issue.message}' `;
+    });
+    logs.push(`dApp '${Object.keys(dapp.aliases)}' contains the following errors:\n${errors.join('\n')}\n`);
+  }
+
+  // Validation: Ensure that the latest JSON content is represented in each Dapp object
+  const existingDapp = DAPPS[index];
+  if (!deepEqual(dapp, existingDapp)) {
+    logs.push(`dApp '${Object.keys(dapp.aliases)}' differs to the currently generated Dapp object in DAPPS\n`);
+  }
+});
+
+if (logs.length > 0) {
+  // eslint-disable-next-line no-console
+  logs.forEach((log) => console.error(log));
+  process.exit(1);
+}
+
+process.exit(0);

scripts/check-deployment-config.ts

@@ -4,7 +4,7 @@ import {
   chainsSupportedByMarket,
   chainsSupportedByOevAuctions,
 } from '../data/chain-support.json';
-import { CHAINS } from '../src/index';
+import { CHAINS } from '../src/generated/chains';
 
 function main() {
   const chainAliases = new Set(CHAINS.map((chain) => chain.alias));

scripts/src/deployment-addresses.ts

@@ -2,14 +2,14 @@ import * as fs from 'node:fs';
 import { join } from 'node:path';
 
 import type { AddressLike } from 'ethers';
-import { config } from 'hardhat';
 
 import {
   chainsSupportedByManagerMultisig,
   chainsSupportedByDapis,
   chainsSupportedByMarket,
   chainsSupportedByOevAuctions,
 } from '../../data/chain-support.json';
+import { CHAINS } from '../../src/generated/chains';
 
 function getDeploymentAddresses() {
   const references: Record<string, Record<string, AddressLike>> = {
@@ -31,7 +31,7 @@ function getDeploymentAddresses() {
   ]);
 
   for (const network of networks) {
-    const chainId = config.networks[network]!.chainId!;
+    const chainId = CHAINS.find((chain) => chain.alias === network)?.id;
     const contractNames = [
       ...(chainsSupportedByManagerMultisig.includes(network) ? ['GnosisSafeWithoutProxy', 'OwnableCallForwarder'] : []),
       ...(chainsSupportedByDapis.includes(network)
@@ -42,7 +42,7 @@ function getDeploymentAddresses() {
     ];
     for (const contractName of contractNames) {
       const deployment = JSON.parse(fs.readFileSync(join('deployments', network, `${contractName}.json`), 'utf8'));
-      references[contractName] = { ...references[contractName], [chainId]: deployment.address };
+      references[contractName] = { ...references[contractName], [chainId!]: deployment.address };
     }
   }
   return `${JSON.stringify(references, null, 2)}\n`;

src/generated/dapps.ts

@@ -20,7 +20,7 @@ export const DAPPS: Dapp[] = [
     },
     homepageUrl: 'https://compound.finance/',
   },
-  { aliases: { dtrinity: { chains: ['fraxtal'], title: 'dTRINITY' } }, homepageUrl: 'https://dtrinity.org/' },
+  { aliases: { dtrinity: { chains: ['fraxtal', 'sonic'], title: 'dTRINITY' } }, homepageUrl: 'https://dtrinity.org/' },
   { aliases: { elara: { chains: ['zircuit'], title: 'Elara' } }, homepageUrl: 'https://app.elara.finance/' },
   { aliases: { enclabs: { chains: ['sonic'], title: 'Enclabs' } }, homepageUrl: 'https://www.enclabs.finance/' },
   { aliases: { hana: { chains: ['taiko'], title: 'Hana Finance' } }, homepageUrl: 'https://www.hana.finance/' },
@@ -32,8 +32,13 @@ export const DAPPS: Dapp[] = [
   { aliases: { lendle: { chains: ['mantle'], title: 'Lendle' } }, homepageUrl: 'https://www.lendle.xyz/' },
   { aliases: { 'mach-finance': { chains: ['sonic'], title: 'MachFi' } }, homepageUrl: 'https://www.machfi.xyz/' },
   { aliases: { moonwell: { chains: ['moonbeam'], title: 'Moonwell' } }, homepageUrl: 'https://moonwell.fi/' },
+  { aliases: { nerite: { chains: ['arbitrum'], title: 'Nerite' } }, homepageUrl: 'https://www.nerite.org/' },
   { aliases: { omega: { chains: ['mantle'], title: 'Omega' } }, homepageUrl: 'https://www.omega.xyz/' },
   { aliases: { orbit: { chains: ['blast'], title: 'Orbit Protocol' } }, homepageUrl: 'https://orbitlending.io/' },
+  {
+    aliases: { 'segment-finance': { chains: ['bob'], title: 'Segment Finance' } },
+    homepageUrl: 'https://www.segment.finance/',
+  },
   {
     aliases: {
       'silo-finance-v1-rdnt': {

src/utils/strings.ts

@@ -7,3 +7,13 @@ export function toUpperSnakeCase(input: string): string {
     .join('_')
     .toUpperCase();
 }
+
+export function toLowerKebabCase(input: string): string {
+  return input
+    .replaceAll(/[^\d\sA-Za-z]+/g, ' ') // replace each non-alphanumeric character with a space
+    .replaceAll(/\s+/g, ' ') // replace consecutive spaces with a single space
+    .trim()
+    .split(' ')
+    .join('-')
+    .toLowerCase();
+}