Entropy tester

apps/entropy-tester/.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  rules: {
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
+  },
+};

apps/entropy-tester/.gitignore

@@ -0,0 +1 @@
+lib

apps/entropy-tester/config.sample.yaml

@@ -0,0 +1,6 @@
+- chain-id: berachain_mainnet
+  interval: 3h
+- chain-id: apechain_mainnet
+  interval: 6h
+- chain-id: blast
+  interval: 10m

apps/entropy-tester/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@pythnetwork/entropy-tester",
+  "version": "1.0.0",
+  "description": "Utility to test entropy provider callbacks",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "fix:format": "prettier --write \"src/**/*.ts\"",
+    "fix:lint": "eslint src/ --fix --max-warnings 0",
+    "test:format": "prettier --check \"src/**/*.ts\"",
+    "test:lint": "eslint src/ --max-warnings 0",
+    "start": "node lib/index.js",
+    "dev": "ts-node src/index.ts",
+    "prepublishOnly": "pnpm run build && pnpm run test:lint",
+    "preversion": "pnpm run test:lint",
+    "version": "pnpm run test:format && pnpm run test:lint && git add -A src"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pyth-network/pyth-crosschain.git",
+    "directory": "apps/entropy-tester"
+  },
+  "bin": {
+    "pyth-entropy-tester": "./lib/index.js"
+  },
+  "devDependencies": {
+    "@types/ethereum-protocol": "^1.0.2",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^27.4.1",
+    "@types/yargs": "^17.0.10",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.13.0",
+    "jest": "^29.7.0",
+    "pino-pretty": "^11.2.1",
+    "prettier": "catalog:",
+    "ts-jest": "^29.1.1",
+    "ts-node": "catalog:",
+    "typescript": "catalog:"
+  },
+  "dependencies": {
+    "@pythnetwork/contract-manager": "workspace:*",
+    "joi": "^17.6.0",
+    "pino": "^9.2.0",
+    "prom-client": "^15.1.0",
+    "viem": "^2.19.4",
+    "yaml": "^2.1.1",
+    "yargs": "^17.5.1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0",
+  "packageManager": "[email protected]"
+}

apps/entropy-tester/src/index.ts

@@ -0,0 +1,168 @@
+#!/usr/bin/env node
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import YAML from "yaml";
+import fs from "fs";
+import pino, { Logger } from "pino";
+import { DefaultStore } from "@pythnetwork/contract-manager/node/store";
+import { EvmEntropyContract } from "@pythnetwork/contract-manager/core/contracts/evm";
+import {
+  PrivateKey,
+  toPrivateKey,
+} from "@pythnetwork/contract-manager/core/base";
+
+type DurationSeconds = number;
+type LoadedConfig = {
+  contract: EvmEntropyContract;
+  interval: DurationSeconds;
+};
+
+function timeToSeconds(timeStr: string): number {
+  const match = timeStr.match(/^(\d+)([hms])$/i);
+  if (!match)
+    throw new Error("Invalid format. Use formats like '6h', '15m', or '30s'.");
+
+  const value = parseInt(match[1], 10);
+  const unit = match[2].toLowerCase();
+
+  switch (unit) {
+    case "h":
+      return value * 3600;
+    case "m":
+      return value * 60;
+    case "s":
+      return value;
+    default:
+      throw new Error("Unsupported time unit.");
+  }
+}
+
+function loadConfig(configPath: string): LoadedConfig[] {
+  const configs = YAML.parse(fs.readFileSync(configPath, "utf-8"));
+  const loadedConfigs = [];
+  for (const config of configs) {
+    const interval = timeToSeconds(config["interval"]);
+    const contracts = Object.values(DefaultStore.entropy_contracts).filter(
+      (contract) => contract.chain.getId() == config["chain-id"],
+    );
+    if (contracts.length === 0) {
+      throw new Error(
+        `Can not find the contract for chain ${config["chain-id"]}, check contract manager store.`,
+      );
+    }
+    if (contracts.length > 1) {
+      throw new Error(
+        `Multiple contracts found for chain ${config["chain-id"]}, check contract manager store.`,
+      );
+    }
+    loadedConfigs.push({ contract: contracts[0], interval });
+  }
+  return loadedConfigs;
+}
+
+async function testLatency(
+  contract: EvmEntropyContract,
+  privateKey: PrivateKey,
+  logger: Logger,
+) {
+  const provider = await contract.getDefaultProvider();
+  const userRandomNumber = contract.generateUserRandomNumber();
+  const requestResponse = await contract.requestRandomness(
+    userRandomNumber,
+    provider,
+    privateKey,
+    true, // with callback
+  );
+  // Read the sequence number for the request from the transaction events.
+  const sequenceNumber = parseInt(
+    requestResponse.events.RequestedWithCallback.returnValues.sequenceNumber,
+  );
+  logger.info(
+    { sequenceNumber, txHash: requestResponse.transactionHash },
+    `Request submitted`,
+  );
+
+  const startTime = Date.now();
+
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    await new Promise((resolve) => setTimeout(resolve, 2000));
+    const request = await contract.getRequest(provider, sequenceNumber);
+    logger.debug(request);
+
+    if (parseInt(request.sequenceNumber) === 0) {
+      // 0 means the request is cleared
+      const endTime = Date.now();
+      logger.info(
+        { sequenceNumber, latency: endTime - startTime },
+        `Successful callback`,
+      );
+      break;
+    }
+    if (Date.now() - startTime > 60000) {
+      logger.error(
+        { sequenceNumber },
+        "Timeout: 60s passed without the callback being called",
+      );
+      break;
+    }
+  }
+}
+
+yargs(hideBin(process.argv))
+  .parserConfiguration({
+    "parse-numbers": false,
+  })
+  .command({
+    command: "run",
+    describe: "run the tester until manually stopped",
+    builder: {
+      validate: {
+        description: "Only validate the configs and exit",
+        type: "boolean",
+        default: false,
+        required: false,
+      },
+      config: {
+        description: "Yaml config file",
+        type: "string",
+        required: true,
+      },
+      "private-key": {
+        type: "string",
+        required: true,
+        description:
+          "Path to the private key to sign the transactions with. Should be hex encoded",
+      },
+    },
+    handler: async (argv: any) => {
+      const logger = pino();
+      const configs = loadConfig(argv.config);
+      if (argv.validate) {
+        logger.info("Config validated");
+        return;
+      }
+      const privateKey = toPrivateKey(
+        fs
+          .readFileSync(argv["private-key"], "utf-8")
+          .replace("0x", "")
+          .trimEnd(),
+      );
+      logger.info("Running");
+      const promises = configs.map(async ({ contract, interval }) => {
+        const child = logger.child({ chain: contract.chain.getId() });
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+          try {
+            await testLatency(contract, privateKey, child);
+          } catch (e) {
+            child.error(e, "Error testing latency");
+          }
+          await new Promise((resolve) => setTimeout(resolve, interval * 1000));
+        }
+      });
+      await Promise.all(promises);
+    },
+  })
+  .demandCommand()
+  .help().argv;

apps/entropy-tester/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "nodenext",
+    "declaration": true,
+    "rootDir": "src/",
+    "outDir": "./lib",
+    "strict": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
+}