@cardano-sdk/golden-test-generator 0.1.4 → 0.1.8

package/dist/index.js

@@ -0,0 +1,114 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const commander_1 = require("commander");
+const object_hash_1 = __importDefault(require("object-hash"));
+const node_path_1 = __importDefault(require("node:path"));
+const cli_progress_1 = require("cli-progress");
+const fs_extra_1 = require("fs-extra");
+const json_bigint_1 = __importDefault(require("json-bigint"));
+const AddressBalance_1 = require("./AddressBalance");
+const Block_1 = require("./Block");
+const Content_1 = require("./Content");
+const clear = require('clear');
+const packageJson = require('../package.json');
+clear();
+console.log(chalk_1.default.blue('Cardano Golden Test Generator'));
+const createProgressBar = (lastblockHeight) => new cli_progress_1.SingleBar({
+    barCompleteChar: '\u2588',
+    barIncompleteChar: '\u2591',
+    format: `Syncing from genesis to block ${lastblockHeight} | ${chalk_1.default.blue('{bar}')} | {percentage}% || {value}/{total} Blocks`,
+    hideCursor: true,
+    renderThrottle: 300
+});
+const program = new commander_1.Command('cardano-golden-test-generator');
+program
+    .option('--ogmios-host [ogmiosHost]', 'Ogmios host. Defaults to localhost')
+    .option('--ogmios-port [ogmiosPort]', 'Ogmios TCP port. Defaults to 1337', (port) => Number.parseInt(port))
+    .option('--ogmios-tls [ogmiosTls]', 'Is Ogmios being served over a secure connection?. Defaults to false', (port) => Number.parseInt(port));
+program
+    .command('address-balance')
+    .description('Balance of addresses, determined by syncing the chain from genesis')
+    .argument('[addresses]', 'Comma-separated list of addresses', (addresses) => addresses.split(',').filter((a) => a !== ''))
+    .requiredOption('--at-blocks [atBlocks]', 'Balance of the addresses at block heights', (heights) => heights
+    .split(',')
+    .filter((b) => b !== '')
+    .map((height) => Number.parseInt(height)))
+    .requiredOption('--out-dir [outDir]', 'File path to write results to')
+    .action(async (addresses, { atBlocks, outDir }) => {
+    try {
+        const { ogmiosHost, ogmiosPort, ogmiosTls } = program.opts();
+        const atBlockHeights = atBlocks.sort((a, b) => a - b);
+        const lastBlockHeight = atBlockHeights[atBlockHeights.length - 1];
+        const progress = createProgressBar(lastBlockHeight);
+        await fs_extra_1.ensureDir(outDir);
+        progress.start(lastBlockHeight, 0);
+        const { balances, metadata } = await AddressBalance_1.getOnChainAddressBalances(addresses, atBlockHeights, {
+            ogmiosConnectionConfig: { host: ogmiosHost, port: ogmiosPort, tls: ogmiosTls },
+            onBlock: (blockHeight) => {
+                progress.update(blockHeight);
+            }
+        });
+        const content = await Content_1.prepareContent(metadata, balances);
+        progress.stop();
+        const fileName = node_path_1.default.join(outDir, `address-balances-${object_hash_1.default(content)}.json`);
+        console.log(`Writing ${fileName}`);
+        await fs_extra_1.writeFile(fileName, json_bigint_1.default.stringify(content, undefined, 2));
+        process.exit(0);
+    }
+    catch (error) {
+        console.error(error);
+        process.exit(1);
+    }
+});
+program
+    .command('get-block')
+    .description('Dump the requested blocks in their raw structure')
+    .argument('[blockHeights]', 'Comma-separated list of blocks by number', (blockHeights) => blockHeights
+    .split(',')
+    .filter((b) => b !== '')
+    .map((blockHeight) => Number.parseInt(blockHeight)))
+    .requiredOption('--out-dir [outDir]', 'File path to write results to')
+    .action(async (blockHeights, { outDir }) => {
+    try {
+        const { ogmiosHost, ogmiosPort, ogmiosTls } = program.opts();
+        const sortedblockHeights = blockHeights.sort((a, b) => a - b);
+        const lastblockHeight = sortedblockHeights[sortedblockHeights.length - 1];
+        const progress = createProgressBar(lastblockHeight);
+        await fs_extra_1.ensureDir(outDir);
+        progress.start(lastblockHeight, 0);
+        const { blocks, metadata } = await Block_1.getBlocks(sortedblockHeights, {
+            logger: console,
+            ogmiosConnectionConfig: { host: ogmiosHost, port: ogmiosPort, tls: ogmiosTls },
+            onBlock: (blockHeight) => {
+                progress.update(blockHeight);
+            }
+        });
+        progress.stop();
+        const content = await Content_1.prepareContent(metadata, blocks);
+        const fileName = node_path_1.default.join(outDir, `blocks-${object_hash_1.default(content)}.json`);
+        console.log(`Writing ${fileName}`);
+        await fs_extra_1.writeFile(fileName, json_bigint_1.default.stringify(content, undefined, 2));
+        process.exit(0);
+    }
+    catch (error) {
+        console.error(error);
+        process.exit(1);
+    }
+});
+program.version(packageJson.version);
+if (process.argv.slice(2).length === 0) {
+    program.outputHelp();
+    process.exit(1);
+}
+else {
+    program.parseAsync(process.argv).catch((error) => {
+        console.error(error);
+        process.exit(0);
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAEA,kDAA0B;AAC1B,yCAAoC;AACpC,8DAA+B;AAC/B,0DAA6B;AAC7B,+CAAkD;AAClD,uCAAgD;AAChD,8DAAkC;AAClC,qDAAsF;AACtF,mCAAuD;AACvD,uCAA2C;AAE3C,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/B,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE/C,KAAK,EAAE,CAAC;AACR,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC,CAAC;AAEzD,MAAM,iBAAiB,GAAG,CAAC,eAAuB,EAAE,EAAE,CACpD,IAAI,wBAAS,CAAC;IACZ,eAAe,EAAE,QAAQ;IACzB,iBAAiB,EAAE,QAAQ;IAC3B,MAAM,EAAE,iCAAiC,eAAe,MAAM,eAAK,CAAC,IAAI,CACtE,OAAO,CACR,4CAA4C;IAC7C,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,GAAG;CACT,CAAC,CAAC;AAEhB,MAAM,OAAO,GAAG,IAAI,mBAAO,CAAC,+BAA+B,CAAC,CAAC;AAE7D,OAAO;KACJ,MAAM,CAAC,4BAA4B,EAAE,oCAAoC,CAAC;KAC1E,MAAM,CAAC,4BAA4B,EAAE,mCAAmC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;KAC1G,MAAM,CAAC,0BAA0B,EAAE,qEAAqE,EAAE,CAAC,IAAI,EAAE,EAAE,CAClH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CACtB,CAAC;AAEJ,OAAO;KACJ,OAAO,CAAC,iBAAiB,CAAC;KAC1B,WAAW,CAAC,oEAAoE,CAAC;KACjF,QAAQ,CAAC,aAAa,EAAE,mCAAmC,EAAE,CAAC,SAAS,EAAE,EAAE,CAC1E,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAC7C;KACA,cAAc,CAAC,wBAAwB,EAAE,2CAA2C,EAAE,CAAC,OAAO,EAAE,EAAE,CACjG,OAAO;KACJ,KAAK,CAAC,GAAG,CAAC;KACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;KACvB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAC5C;KACA,cAAc,CAAC,oBAAoB,EAAE,+BAA+B,CAAC;KACrE,MAAM,CAAC,KAAK,EAAE,SAAmB,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE;IAC1D,IAAI;QACF,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7D,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACpD,MAAM,oBAAS,CAAC,MAAM,CAAC,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QACnC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,0CAAyB,CAAC,SAAS,EAAE,cAAc,EAAE;YACxF,sBAAsB,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE;YAC9E,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE;gBACvB,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,wBAAc,CAAsC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9F,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,qBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7E,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;QACnC,MAAM,oBAAS,CAAC,QAAQ,EAAE,qBAAO,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,WAAW,CAAC;KACpB,WAAW,CAAC,kDAAkD,CAAC;KAC/D,QAAQ,CAAC,gBAAgB,EAAE,0CAA0C,EAAE,CAAC,YAAY,EAAE,EAAE,CACvF,YAAY;KACT,KAAK,CAAC,GAAG,CAAC;KACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;KACvB,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CACtD;KACA,cAAc,CAAC,oBAAoB,EAAE,+BAA+B,CAAC;KACrE,MAAM,CAAC,KAAK,EAAE,YAAsB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;IACnD,IAAI;QACF,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAC7D,MAAM,kBAAkB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9E,MAAM,eAAe,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACpD,MAAM,oBAAS,CAAC,MAAM,CAAC,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QACnC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,iBAAS,CAAC,kBAAkB,EAAE;YAC/D,MAAM,EAAE,OAAO;YACf,sBAAsB,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE;YAC9E,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE;gBACvB,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;QACH,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,MAAM,wBAAc,CAA8B,QAAQ,EAAE,MAAM,CAAC,CAAC;QACpF,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,qBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEnE,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;QACnC,MAAM,oBAAS,CAAC,QAAQ,EAAE,qBAAO,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACrC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;IACtC,OAAO,CAAC,UAAU,EAAE,CAAC;IACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB;KAAM;IACL,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACJ"}

package/dist/util.d.ts

@@ -0,0 +1,9 @@
+import { Schema } from '@cardano-ogmios/client';
+export declare const isByronStandardBlock: (block: Schema.Block) => block is {
+    byron: Schema.StandardBlock;
+};
+export declare const isByronEpochBoundaryBlock: (block: Schema.Block) => block is {
+    byron: Schema.EpochBoundaryBlock;
+};
+export declare const getLastCommitPromise: () => Promise<import("git-last-commit").Commit>;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAMhD,eAAO,MAAM,oBAAoB,UAAW,OAAO,KAAK;WAAqB,OAAO,aAAa;CACpB,CAAC;AAE9E,eAAO,MAAM,yBAAyB,UAAW,OAAO,KAAK;WAAqB,OAAO,kBAAkB;CAG1G,CAAC;AAEF,eAAO,MAAM,oBAAoB,iDAA2B,CAAC"}

package/dist/util.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLastCommitPromise = exports.isByronEpochBoundaryBlock = exports.isByronStandardBlock = void 0;
+const git_last_commit_1 = require("git-last-commit");
+const util_1 = require("util");
+const isByronStandardBlock = (block) => block.byron?.header.slot !== undefined;
+exports.isByronStandardBlock = isByronStandardBlock;
+const isByronEpochBoundaryBlock = (block) => {
+    const castBlock = block;
+    return castBlock.byron?.hash !== undefined && castBlock.byron?.header.epoch !== undefined;
+};
+exports.isByronEpochBoundaryBlock = isByronEpochBoundaryBlock;
+exports.getLastCommitPromise = util_1.promisify(git_last_commit_1.getLastCommit);
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AACA,qDAAgD;AAEhD,+BAAiC;AAG1B,MAAM,oBAAoB,GAAG,CAAC,KAAmB,EAA4C,EAAE,CACnG,KAAyC,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC;AADjE,QAAA,oBAAoB,wBAC6C;AAEvE,MAAM,yBAAyB,GAAG,CAAC,KAAmB,EAAiD,EAAE;IAC9G,MAAM,SAAS,GAAG,KAA6C,CAAC;IAChE,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AAC5F,CAAC,CAAC;AAHW,QAAA,yBAAyB,6BAGpC;AAEW,QAAA,oBAAoB,GAAG,gBAAS,CAAC,+BAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cardano-sdk/golden-test-generator",
-  "version": "0.1.4",
+  "version": "0.1.8",
   "description": "Generate golden test files for a range of Cardano concepts",
   "engines": {
     "node": "^14"
@@ -16,12 +16,15 @@
     "cleanup": "shx rm -rf dist node_modules",
     "dev": "API_PORT=3000 OGMIOS_HOST=localhost OGMIOS_PORT=1337 ts-node-dev ./src/index.ts",
     "lint": "shx echo linting disabled in this package temporarily",
+    "lint:fix": "shx echo linting disabled in this package temporarily",
     "prepkg": "yarn build",
     "pkg": "yarn build && pkg -o build/golden-test-generator .",
     "prestart": "yarn build",
     "start": "API_PORT=3000 OGMIOS_HOST=localhost OGMIOS_PORT=1337 ts-node ./src/index.ts",
+    "prepack": "yarn build",
     "pretest": "yarn build",
     "test": "jest -c ./jest.config.js",
+    "test:e2e": "shx echo 'test:e2e' command not implemented yet",
     "coverage": "shx echo No coverage report for this package"
   },
   "dependencies": {
@@ -49,5 +52,11 @@
       "node14-linux-x64",
       "node14-macos-x64"
     ]
-  }
+  },
+  "files": [
+    "dist/*",
+    "!dist/tsconfig.tsbuildinfo",
+    "LICENSE",
+    "NOTICE"
+  ]
 }

package/jest.config.js

@@ -1 +0,0 @@
-module.exports = require('../../test/jest.config');

package/src/.eslintrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-  "extends": ["../../../.eslintrc.js"],
-  "parserOptions": {
-    "project": "./tsconfig.json",
-    "tsconfigRootDir": __dirname
-  }
-}

package/src/AddressBalance/applyValue.ts

@@ -1,31 +0,0 @@
-/* eslint-disable prettier/prettier */
-import { Schema } from '@cardano-ogmios/client';
-import { BigIntMath } from '@cardano-sdk/core';
-
-const throwIfNegative = (value: bigint | number): void => {
-  if (value < 0) {
-    throw new Error('The value provided cannot be applied as it will result in a negative balance');
-  }
-};
-
-// eslint-disable-next-line sonarjs/cognitive-complexity
-export const applyValue = (balance: Schema.Value, value: Schema.Value, spending = false): Schema.Value => {
-  const coins = balance.coins + (spending ? -Math.abs(value.coins) : value.coins);
-  throwIfNegative(coins);
-  const balanceToApply: Schema.Value = { coins };
-  if (balance.assets !== undefined || value.assets !== undefined) {
-    balanceToApply.assets = { ...balance.assets } ?? {};
-  }
-  const assets = Object.entries(value.assets ?? {});
-  if (assets.length > 0) {
-    for (const [assetId, qty] of assets) {
-      balanceToApply.assets![assetId] =
-        balance.assets![assetId] !== undefined
-          ? balance.assets![assetId] + (spending ? -BigIntMath.abs(qty) : qty)
-          : (spending ? -BigIntMath.abs(qty) : qty);
-      throwIfNegative(balanceToApply.assets![assetId]);
-    }
-  }
-
-  return balanceToApply;
-};

package/src/AddressBalance/getOnChainAddressBalances.ts

@@ -1,137 +0,0 @@
-/* eslint-disable complexity */
-import { dummyLogger, Logger } from 'ts-log';
-import {
-  createChainSyncClient,
-  StateQuery,
-  isAllegraBlock,
-  isAlonzoBlock,
-  isShelleyBlock,
-  isMaryBlock,
-  Schema,
-  ConnectionConfig,
-  createInteractionContext,
-  ChainSync
-} from '@cardano-ogmios/client';
-import { GeneratorMetadata } from '../Content';
-import { isByronStandardBlock } from '../util';
-import { applyValue } from './applyValue';
-
-export type AddressBalances = {
-  [address: string]: Schema.Value;
-};
-
-export type AddressBalancesResponse = GeneratorMetadata & {
-  balances: { [blockHeight: string]: AddressBalances };
-};
-
-export const getOnChainAddressBalances = (
-  addresses: string[],
-  atBlocks: number[],
-  options: {
-    logger?: Logger;
-    ogmiosConnectionConfig: ConnectionConfig;
-    onBlock?: (slot: number) => void;
-  }
-): Promise<AddressBalancesResponse> => {
-  const logger = options?.logger ?? dummyLogger;
-  const trackedAddressBalances: AddressBalances = Object.fromEntries(
-    addresses.map((address) => [address, { coins: 0, assets: {} }])
-  );
-  const trackedTxs: ({ id: Schema.Hash16 } & Schema.Tx)[] = [];
-  // eslint-disable-next-line sonarjs/cognitive-complexity
-  return new Promise(async (resolve, reject) => {
-    let currentBlock: number;
-    // Required to ensure existing messages in the pipe are not processed after the completion
-    // condition is met
-    let draining = false;
-    const response: AddressBalancesResponse = {
-      metadata: {
-        cardano: {
-          compactGenesis: await StateQuery.genesisConfig(
-            await createInteractionContext(reject, logger.info, { connection: options.ogmiosConnectionConfig })
-          ),
-          intersection: undefined as unknown as ChainSync.Intersection
-        }
-      },
-      balances: {}
-    };
-    try {
-      const syncClient = await createChainSyncClient(
-        await createInteractionContext(reject, logger.info, { connection: options.ogmiosConnectionConfig }),
-        {
-          rollBackward: async (_res, requestNext) => {
-            requestNext();
-          },
-          // eslint-disable-next-line max-statements
-          rollForward: async ({ block }, requestNext) => {
-            if (draining) return;
-            let b:
-              | Schema.StandardBlock
-              | Schema.BlockShelley
-              | Schema.BlockAllegra
-              | Schema.BlockMary
-              | Schema.BlockAlonzo;
-            let blockBody:
-              | Schema.StandardBlock['body']['txPayload']
-              | Schema.BlockShelley['body']
-              | Schema.BlockAllegra['body']
-              | Schema.BlockMary['body']
-              | Schema.BlockAlonzo['body'];
-            if (isByronStandardBlock(block)) {
-              b = block.byron as Schema.StandardBlock;
-              blockBody = b.body.txPayload;
-            } else if (isShelleyBlock(block)) {
-              b = block.shelley as Schema.BlockShelley;
-              blockBody = b.body;
-            } else if (isAllegraBlock(block)) {
-              b = block.allegra as Schema.BlockAllegra;
-              blockBody = b.body;
-            } else if (isMaryBlock(block)) {
-              b = block.mary as Schema.BlockMary;
-              blockBody = b.body;
-            } else if (isAlonzoBlock(block)) {
-              b = block.alonzo as Schema.BlockAlonzo;
-            } else {
-              throw new Error('No support for block');
-            }
-            if (b !== undefined) {
-              currentBlock = b.header!.blockHeight;
-              if (options?.onBlock !== undefined) {
-                options.onBlock(currentBlock);
-              }
-              for (const tx of blockBody!) {
-                for (const output of tx.body.outputs) {
-                  if (trackedAddressBalances[output.address] !== undefined) {
-                    const addressBalance = { ...trackedAddressBalances[output.address] };
-                    trackedTxs.push({ id: tx.id, inputs: tx.body.inputs, outputs: tx.body.outputs });
-                    trackedAddressBalances[output.address] = applyValue(addressBalance, output.value);
-                  }
-                }
-                for (const input of tx.body.inputs) {
-                  const trackedInput = trackedTxs.find((t) => t.id === input.txId)?.outputs[input.index];
-                  if (trackedInput !== undefined && trackedAddressBalances[trackedInput?.address] !== undefined) {
-                    const addressBalance = { ...trackedAddressBalances[trackedInput.address] };
-                    trackedAddressBalances[trackedInput.address] = applyValue(addressBalance, trackedInput.value, true);
-                  }
-                }
-              }
-              if (atBlocks.includes(currentBlock)) {
-                response.balances[currentBlock] = { ...trackedAddressBalances };
-                if (atBlocks[atBlocks.length - 1] === currentBlock) {
-                  draining = true;
-                  await syncClient.shutdown();
-                  return resolve(response);
-                }
-              }
-            }
-            requestNext();
-          }
-        }
-      );
-      response.metadata.cardano.intersection = await syncClient.startSync(['origin']);
-    } catch (error) {
-      logger.error(error);
-      return reject(error);
-    }
-  });
-};

package/src/Block/getBlocks.ts

@@ -1,101 +0,0 @@
-/* eslint-disable sonarjs/cognitive-complexity */
-import { Logger, dummyLogger } from 'ts-log';
-import {
-  ConnectionConfig,
-  createChainSyncClient,
-  createInteractionContext,
-  StateQuery,
-  isAllegraBlock,
-  isAlonzoBlock,
-  isShelleyBlock,
-  isMaryBlock,
-  Schema,
-  ChainSync
-} from '@cardano-ogmios/client';
-import { GeneratorMetadata } from '../Content';
-
-import { isByronStandardBlock } from '../util';
-
-export type GetBlocksResponse = GeneratorMetadata & {
-  blocks: { [blockHeight: string]: Schema.Block };
-};
-
-export const getBlocks = async (
-  blockHeights: number[],
-  options: {
-    logger?: Logger;
-    ogmiosConnectionConfig: ConnectionConfig;
-    onBlock?: (slot: number) => void;
-  }
-): Promise<GetBlocksResponse> => {
-  const logger = options?.logger ?? dummyLogger;
-  const requestedBlocks: { [blockHeight: string]: Schema.Block } = {};
-  return new Promise(async (resolve, reject) => {
-    let currentBlock: number;
-    // Required to ensure existing messages in the pipe are not processed after the completion condition is met
-    let draining = false;
-    const response: GetBlocksResponse = {
-      metadata: {
-        cardano: {
-          compactGenesis: await StateQuery.genesisConfig(
-            await createInteractionContext(reject, logger.info, { connection: options.ogmiosConnectionConfig })
-          ),
-          intersection: undefined as unknown as ChainSync.Intersection
-        }
-      },
-      blocks: {}
-    };
-    try {
-      const syncClient = await createChainSyncClient(
-        await createInteractionContext(reject, logger.info, { connection: options.ogmiosConnectionConfig }),
-        {
-          rollBackward: async (_res, requestNext) => {
-            requestNext();
-          },
-          rollForward: async ({ block }, requestNext) => {
-            if (draining) return;
-            let b:
-              | Schema.StandardBlock
-              | Schema.BlockShelley
-              | Schema.BlockAllegra
-              | Schema.BlockMary
-              | Schema.BlockAlonzo;
-            if (isByronStandardBlock(block)) {
-              b = block.byron as Schema.StandardBlock;
-            } else if (isShelleyBlock(block)) {
-              b = block.shelley as Schema.BlockShelley;
-            } else if (isAllegraBlock(block)) {
-              b = block.allegra as Schema.BlockAllegra;
-            } else if (isMaryBlock(block)) {
-              b = block.mary as Schema.BlockMary;
-            } else if (isAlonzoBlock(block)) {
-              b = block.alonzo as Schema.BlockAlonzo;
-            } else {
-              throw new Error('No support for block');
-            }
-            if (b !== undefined) {
-              currentBlock = b.header!.blockHeight;
-              if (options?.onBlock !== undefined) {
-                options.onBlock(currentBlock);
-              }
-              if (blockHeights.includes(currentBlock)) {
-                requestedBlocks[currentBlock] = block;
-                if (blockHeights[blockHeights.length - 1] === currentBlock) {
-                  draining = true;
-                  response.blocks = requestedBlocks;
-                  await syncClient.shutdown();
-                  return resolve(response);
-                }
-              }
-            }
-            requestNext();
-          }
-        }
-      );
-      response.metadata.cardano.intersection = await syncClient.startSync(['origin']);
-    } catch (error) {
-      logger.error(error);
-      return reject(error);
-    }
-  });
-};

package/src/Block/index.ts

@@ -1 +0,0 @@
-export * from './getBlocks';

package/src/Content.ts

@@ -1,43 +0,0 @@
-import { ChainSync, Schema as Cardano } from '@cardano-ogmios/client';
-import { Commit } from 'git-last-commit';
-import { getLastCommitPromise } from './util';
-const packageJson = require('../package.json');
-
-export type Metadata = {
-  cardano: {
-    compactGenesis: Cardano.CompactGenesis;
-    intersection: ChainSync.Intersection;
-  };
-  software:  {
-    name: string;
-    version: string;
-    commit: Pick<Commit, 'hash' | 'tags'>;
-  };
-};
-
-export type GeneratorMetadata = { metadata: { cardano: Metadata['cardano'] } };
-
-export const prepareContent = async <Body>(
-  metadata: Omit<Metadata, 'software'>,
-  body: Body
-): Promise<{
-  metadata: Metadata;
-  body: Body;
-}> => {
-  const lastCommit = await getLastCommitPromise();
-  return {
-    metadata: {
-      ...metadata,
-
-      software: {
-        name: packageJson.name,
-        version: packageJson.version,
-        commit: {
-          hash: lastCommit.hash,
-          tags: lastCommit.tags
-        }
-      }
-    },
-    body
-  };
-};

package/src/index.ts

@@ -1,127 +0,0 @@
-#!/usr/bin/env node
-
-import chalk from 'chalk';
-import { Command } from 'commander';
-import hash from 'object-hash';
-import path from 'node:path';
-import { SingleBar, Options } from 'cli-progress';
-import { ensureDir, writeFile } from 'fs-extra';
-import JSONBig from 'json-bigint';
-import { AddressBalancesResponse, getOnChainAddressBalances } from './AddressBalance';
-import { getBlocks, GetBlocksResponse } from './Block';
-import { prepareContent } from './Content';
-
-const clear = require('clear');
-const packageJson = require('../package.json');
-
-clear();
-console.log(chalk.blue('Cardano Golden Test Generator'));
-
-const createProgressBar = (lastblockHeight: number) =>
-  new SingleBar({
-    format: `Syncing from genesis to block ${lastblockHeight} | ${chalk.blue(
-      '{bar}'
-    )} | {percentage}% || {value}/{total} Blocks`,
-    barCompleteChar: '\u2588',
-    barIncompleteChar: '\u2591',
-    hideCursor: true,
-    renderThrottle: 300
-  } as Options);
-
-const program = new Command('cardano-golden-test-generator');
-
-program
-  .option('--ogmios-host [ogmiosHost]', 'Ogmios host. Defaults to localhost')
-  .option('--ogmios-port [ogmiosPort]', 'Ogmios TCP port. Defaults to 1337', (port) => Number.parseInt(port))
-  .option('--ogmios-tls [ogmiosTls]', 'Is Ogmios being served over a secure connection?. Defaults to false', (port) =>
-    Number.parseInt(port)
-  );
-
-program
-  .command('address-balance')
-  .description('Balance of addresses, determined by syncing the chain from genesis')
-  .argument('[addresses]', 'Comma-separated list of addresses', (addresses) =>
-    addresses.split(',').filter((a) => a !== '')
-  )
-  .requiredOption('--at-blocks [atBlocks]', 'Balance of the addresses at block heights', (heights) =>
-    heights
-      .split(',')
-      .filter((b) => b !== '')
-      .map((height) => Number.parseInt(height))
-  )
-  .requiredOption('--out-dir [outDir]', 'File path to write results to')
-  .action(async (addresses: string[], { atBlocks, outDir }) => {
-    try {
-      const { ogmiosHost, ogmiosPort, ogmiosTls } = program.opts();
-      const atBlockHeights = atBlocks.sort((a: number, b: number) => a - b);
-      const lastBlockHeight = atBlockHeights[atBlockHeights.length - 1];
-      const progress = createProgressBar(lastBlockHeight);
-      await ensureDir(outDir);
-      progress.start(lastBlockHeight, 0);
-      const { balances, metadata } = await getOnChainAddressBalances(addresses, atBlockHeights, {
-        ogmiosConnectionConfig: { host: ogmiosHost, port: ogmiosPort, tls: ogmiosTls },
-        onBlock: (blockHeight) => {
-          progress.update(blockHeight);
-        }
-      });
-      const content = await prepareContent<AddressBalancesResponse['balances']>(metadata, balances);
-      progress.stop();
-      const fileName = path.join(outDir, `address-balances-${hash(content)}.json`);
-
-      console.log(`Writing ${fileName}`);
-      await writeFile(fileName, JSONBig.stringify(content, undefined, 2));
-      process.exit(0);
-    } catch (error) {
-      console.error(error);
-      process.exit(1);
-    }
-  });
-
-program
-  .command('get-block')
-  .description('Dump the requested blocks in their raw structure')
-  .argument('[blockHeights]', 'Comma-separated list of blocks by number', (blockHeights) =>
-    blockHeights
-      .split(',')
-      .filter((b) => b !== '')
-      .map((blockHeight) => Number.parseInt(blockHeight))
-  )
-  .requiredOption('--out-dir [outDir]', 'File path to write results to')
-  .action(async (blockHeights: number[], { outDir }) => {
-    try {
-      const { ogmiosHost, ogmiosPort, ogmiosTls } = program.opts();
-      const sortedblockHeights = blockHeights.sort((a: number, b: number) => a - b);
-      const lastblockHeight = sortedblockHeights[sortedblockHeights.length - 1];
-      const progress = createProgressBar(lastblockHeight);
-      await ensureDir(outDir);
-      progress.start(lastblockHeight, 0);
-      const { blocks, metadata } = await getBlocks(sortedblockHeights, {
-        logger: console,
-        ogmiosConnectionConfig: { host: ogmiosHost, port: ogmiosPort, tls: ogmiosTls },
-        onBlock: (blockHeight) => {
-          progress.update(blockHeight);
-        }
-      });
-      progress.stop();
-      const content = await prepareContent<GetBlocksResponse['blocks']>(metadata, blocks);
-      const fileName = path.join(outDir, `blocks-${hash(content)}.json`);
-
-      console.log(`Writing ${fileName}`);
-      await writeFile(fileName, JSONBig.stringify(content, undefined, 2));
-      process.exit(0);
-    } catch (error) {
-      console.error(error);
-      process.exit(1);
-    }
-  });
-
-program.version(packageJson.version);
-if (process.argv.slice(2).length === 0) {
-  program.outputHelp();
-  process.exit(1);
-} else {
-  program.parseAsync(process.argv).catch((error) => {
-    console.error(error);
-    process.exit(0);
-  });
-}

package/src/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../dist/",
-    "rootDir": "."
-  },
-  "references": [
-    { "path": "../../core/src"}
-  ]
-}