@aztec/aztec-node 0.0.0-test.0

package/dest/bin/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dest/bin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":""}

package/dest/bin/index.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env -S node --no-warnings
+import { createLogger } from '@aztec/foundation/log';
+import http from 'http';
+import { AztecNodeService, createAztecNodeRpcServer, getConfigEnvVars } from '../index.js';
+const { AZTEC_NODE_PORT = 8081, API_PREFIX = '' } = process.env;
+const logger = createLogger('node');
+/**
+ * Creates the node from provided config
+ */ async function createAndDeployAztecNode() {
+    const aztecNodeConfig = {
+        ...getConfigEnvVars()
+    };
+    return await AztecNodeService.createAndSync(aztecNodeConfig);
+}
+/**
+ * Create and start a new Aztec Node HTTP Server
+ */ async function main() {
+    logger.info(`Setting up Aztec Node...`);
+    const aztecNode = await createAndDeployAztecNode();
+    const shutdown = async ()=>{
+        logger.info('Shutting down...');
+        await aztecNode.stop();
+        process.exit(0);
+    };
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    process.once('SIGINT', shutdown);
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    process.once('SIGTERM', shutdown);
+    const rpcServer = createAztecNodeRpcServer(aztecNode);
+    const app = rpcServer.getApp(API_PREFIX);
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    const httpServer = http.createServer(app.callback());
+    httpServer.listen(+AZTEC_NODE_PORT);
+    logger.info(`Aztec Node JSON-RPC Server listening on port ${AZTEC_NODE_PORT}`);
+}
+main().catch((err)=>{
+    logger.error(err);
+    process.exit(1);
+});

package/dest/index.d.ts

@@ -0,0 +1,4 @@
+export * from './aztec-node/config.js';
+export * from './aztec-node/server.js';
+export * from './aztec-node/http_rpc_server.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC"}

package/dest/index.js

@@ -0,0 +1,3 @@
+export * from './aztec-node/config.js';
+export * from './aztec-node/server.js';
+export * from './aztec-node/http_rpc_server.js';

package/package.json

@@ -0,0 +1,105 @@
+{
+  "name": "@aztec/aztec-node",
+  "version": "0.0.0-test.0",
+  "main": "dest/index.js",
+  "type": "module",
+  "exports": {
+    ".": "./dest/index.js",
+    "./config": "./dest/aztec-node/config.js"
+  },
+  "bin": "./dest/bin/index.js",
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts"
+    ],
+    "name": "Aztec Node",
+    "tsconfig": "./tsconfig.json"
+  },
+  "scripts": {
+    "start": "node --no-warnings ./dest/bin",
+    "start:debug": "node --no-warnings --inspect ./dest/bin",
+    "build": "yarn clean && tsc -b",
+    "build:dev": "tsc -b --watch",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T eslint --fix ./src && run -T prettier -w ./src",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "jest": {
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src",
+    "reporters": [
+      "default"
+    ],
+    "testTimeout": 120000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
+  },
+  "dependencies": {
+    "@aztec/archiver": "0.0.0-test.0",
+    "@aztec/bb-prover": "0.0.0-test.0",
+    "@aztec/blob-sink": "0.0.0-test.0",
+    "@aztec/constants": "0.0.0-test.0",
+    "@aztec/epoch-cache": "0.0.0-test.0",
+    "@aztec/ethereum": "0.0.0-test.0",
+    "@aztec/foundation": "0.0.0-test.0",
+    "@aztec/kv-store": "0.0.0-test.0",
+    "@aztec/merkle-tree": "0.0.0-test.0",
+    "@aztec/p2p": "0.0.0-test.0",
+    "@aztec/protocol-contracts": "0.0.0-test.0",
+    "@aztec/prover-client": "0.0.0-test.0",
+    "@aztec/sequencer-client": "0.0.0-test.0",
+    "@aztec/simulator": "0.0.0-test.0",
+    "@aztec/stdlib": "0.0.0-test.0",
+    "@aztec/telemetry-client": "0.0.0-test.0",
+    "@aztec/validator-client": "0.0.0-test.0",
+    "@aztec/world-state": "0.0.0-test.0",
+    "koa": "^2.14.2",
+    "koa-router": "^12.0.0",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.7.23",
+    "jest": "^29.5.0",
+    "jest-mock-extended": "^3.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "types": "./dest/index.d.ts",
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/aztec-node/config.ts

@@ -0,0 +1,71 @@
+import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
+import { type ConfigMappingsType, booleanConfigHelper, getConfigFromMappings } from '@aztec/foundation/config';
+import { type DataStoreConfig, dataConfigMappings } from '@aztec/kv-store/config';
+import { type P2PConfig, p2pConfigMappings } from '@aztec/p2p/config';
+import { type ProverClientConfig, proverClientConfigMappings } from '@aztec/prover-client/config';
+import { type SequencerClientConfig, sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
+import { type ValidatorClientConfig, validatorClientConfigMappings } from '@aztec/validator-client/config';
+import { type WorldStateConfig, worldStateConfigMappings } from '@aztec/world-state/config';
+
+import { readFileSync } from 'fs';
+import { dirname, resolve } from 'path';
+import { fileURLToPath } from 'url';
+
+export { sequencerClientConfigMappings, type SequencerClientConfig };
+
+/**
+ * The configuration the aztec node.
+ */
+export type AztecNodeConfig = ArchiverConfig &
+  SequencerClientConfig &
+  ValidatorClientConfig &
+  ProverClientConfig &
+  WorldStateConfig &
+  Pick<ProverClientConfig, 'bbBinaryPath' | 'bbWorkingDirectory' | 'realProofs'> &
+  P2PConfig &
+  DataStoreConfig & {
+    /** Whether the validator is disabled for this node */
+    disableValidator: boolean;
+    /** Whether to populate the genesis state with initial fee juice for the test accounts */
+    testAccounts: boolean;
+  };
+
+export const aztecNodeConfigMappings: ConfigMappingsType<AztecNodeConfig> = {
+  ...archiverConfigMappings,
+  ...sequencerClientConfigMappings,
+  ...validatorClientConfigMappings,
+  ...proverClientConfigMappings,
+  ...worldStateConfigMappings,
+  ...p2pConfigMappings,
+  ...dataConfigMappings,
+  disableValidator: {
+    env: 'VALIDATOR_DISABLED',
+    description: 'Whether the validator is disabled for this node.',
+    ...booleanConfigHelper(),
+  },
+  testAccounts: {
+    env: 'TEST_ACCOUNTS',
+    description: 'Whether to populate the genesis state with initial fee juice for the test accounts.',
+    ...booleanConfigHelper(),
+  },
+};
+
+/**
+ * Returns the config of the aztec node from environment variables with reasonable defaults.
+ * @returns A valid aztec node config.
+ */
+export function getConfigEnvVars(): AztecNodeConfig {
+  return getConfigFromMappings<AztecNodeConfig>(aztecNodeConfigMappings);
+}
+
+/**
+ * Returns package version.
+ */
+export function getPackageVersion() {
+  const releasePleaseManifestPath = resolve(
+    dirname(fileURLToPath(import.meta.url)),
+    '../../../../.release-please-manifest.json',
+  );
+  const version = JSON.parse(readFileSync(releasePleaseManifestPath).toString());
+  return version['.'];
+}

package/src/aztec-node/http_rpc_server.ts

@@ -0,0 +1,11 @@
+import { type AztecNode, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
+import { createTracedJsonRpcServer } from '@aztec/telemetry-client';
+
+/**
+ * Wrap an AztecNode instance with a JSON RPC HTTP server.
+ * @param node - The AztecNode
+ * @returns An JSON-RPC HTTP server
+ */
+export function createAztecNodeRpcServer(node: AztecNode) {
+  return createTracedJsonRpcServer(node, AztecNodeApiSchema);
+}

package/src/aztec-node/node_metrics.ts

@@ -0,0 +1,32 @@
+import {
+  Attributes,
+  type Histogram,
+  Metrics,
+  type TelemetryClient,
+  type UpDownCounter,
+  ValueType,
+} from '@aztec/telemetry-client';
+
+export class NodeMetrics {
+  private receiveTxCount: UpDownCounter;
+  private receiveTxDuration: Histogram;
+
+  constructor(client: TelemetryClient, name = 'AztecNode') {
+    const meter = client.getMeter(name);
+    this.receiveTxCount = meter.createUpDownCounter(Metrics.NODE_RECEIVE_TX_COUNT, {});
+    this.receiveTxDuration = meter.createHistogram(Metrics.NODE_RECEIVE_TX_DURATION, {
+      description: 'The duration of the receiveTx method',
+      unit: 'ms',
+      valueType: ValueType.INT,
+    });
+  }
+
+  receivedTx(durationMs: number, isAccepted: boolean) {
+    this.receiveTxDuration.record(Math.ceil(durationMs), {
+      [Attributes.OK]: isAccepted,
+    });
+    this.receiveTxCount.add(1, {
+      [Attributes.OK]: isAccepted,
+    });
+  }
+}