npm - @cardano-sdk/golden-test-generator - Versions diffs - 0.1.3 → 0.1.7 - Mend

@cardano-sdk/golden-test-generator 0.1.3 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

package/LICENSE +201 -0
package/NOTICE +5 -0
package/dist/AddressBalance/getOnChainAddressBalances.js +3 -3
package/dist/AddressBalance/getOnChainAddressBalances.js.map +1 -1
package/dist/Block/getBlocks.js +2 -2
package/dist/Block/getBlocks.js.map +1 -1
package/dist/Content.d.ts.map +1 -1
package/dist/Content.js +5 -5
package/dist/Content.js.map +1 -1
package/dist/index.js +1 -1
package/dist/index.js.map +1 -1
package/package.json +10 -2
package/dist/tsconfig.tsbuildinfo +0 -1
package/jest.config.js +0 -1
package/src/.eslintrc.js +0 -7
package/src/AddressBalance/applyValue.ts +0 -31
package/src/AddressBalance/getOnChainAddressBalances.ts +0 -137
package/src/AddressBalance/index.ts +0 -2
package/src/Block/getBlocks.ts +0 -101
package/src/Block/index.ts +0 -1
package/src/Content.ts +0 -43
package/src/index.ts +0 -127
package/src/tsconfig.json +0 -10
package/src/util.ts +0 -15
package/test/.eslintrc.js +0 -7
package/test/AddressBalance.test.ts +0 -184
package/test/tsconfig.json +0 -10

package/src/Content.ts DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

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

package/src/util.ts DELETED Viewed

@@ -1,15 +0,0 @@
-import { Schema } from '@cardano-ogmios/client';
-import { getLastCommit } from 'git-last-commit';
-// eslint-disable-next-line unicorn/prefer-node-protocol
-import { promisify } from 'util';
-// Todo: Hoist to @cardano-ogmios/client
-export const isByronStandardBlock = (block: Schema.Block): block is { byron: Schema.StandardBlock } =>
-  (block as { byron: Schema.StandardBlock }).byron?.header.slot !== undefined;
-export const isByronEpochBoundaryBlock = (block: Schema.Block): block is { byron: Schema.EpochBoundaryBlock } => {
-  const castBlock = block as { byron: Schema.EpochBoundaryBlock };
-  return castBlock.byron?.hash !== undefined && castBlock.byron?.header.epoch !== undefined;
-};
-export const getLastCommitPromise = promisify(getLastCommit);

package/test/.eslintrc.js DELETED Viewed

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

package/test/AddressBalance.test.ts DELETED Viewed

@@ -1,184 +0,0 @@
-import { AddressBalances, applyValue } from '../src/AddressBalance';
-describe('AddressBalance', () => {
-  describe('applyValueToBalance', () => {
-    let balances: AddressBalances;
-    beforeEach(() => {
-      balances = {
-        ab: {
-          coins: 100
-        },
-        cd: {
-          assets: {
-            12: 10n
-          },
-          coins: 400
-        },
-        ef: {
-          assets: {
-            12: 10n,
-            34: 20n
-          },
-          coins: 500
-        }
-      };
-    });
-    describe('values containing only coins', () => {
-      const address = 'ab';
-      it('adds the coins balance', () => {
-        expect(applyValue(balances[address], { coins: 50 })).toEqual({ coins: 150 });
-      });
-      it('subtracts the coins balance when spending', () => {
-        expect(applyValue(balances[address], { coins: 50 }, true)).toEqual({ coins: 50 });
-      });
-      it('returns the same balance if coins is 0', () => {
-        expect(applyValue(balances[address], { coins: 0 })).toEqual({ coins: 100 });
-      });
-      it('returns the same balance if coins is 0 when spending', () => {
-        expect(applyValue(balances[address], { coins: 0 }, true)).toEqual({ coins: 100 });
-      });
-    });
-    describe('values containing an asset', () => {
-      const address = 'cd';
-      it('adds the coins and asset balance', () => {
-        expect(
-          applyValue(balances[address], {
-            assets: {
-              12: 10n
-            },
-            coins: 50
-          })
-        ).toEqual({ assets: { 12: 20n }, coins: 450 });
-      });
-      it('subtracts the coins and asset balance when spending', () => {
-        expect(applyValue(balances[address], { assets: { 12: 9n }, coins: 50 }, true)).toEqual({
-          assets: { 12: 1n },
-          coins: 350
-        });
-      });
-      it('returns the same balance if coins and asset is 0', () => {
-        expect(applyValue(balances[address], { assets: { 12: 0n }, coins: 0 })).toEqual({
-          assets: { 12: 10n },
-          coins: 400
-        });
-      });
-      it('returns the same balance if coins and asset is 0 when spending', () => {
-        expect(applyValue(balances[address], { assets: { 12: 0n }, coins: 0 }, true)).toEqual({
-          assets: { 12: 10n },
-          coins: 400
-        });
-      });
-    });
-    describe('values containing multiple assets', () => {
-      const address = 'ef';
-      it('adds the coins and assets balance', () => {
-        expect(
-          applyValue(balances[address], {
-            assets: {
-              12: 10n,
-              34: 55n
-            },
-            coins: 50
-          })
-        ).toEqual({
-          assets: {
-            12: 20n,
-            34: 75n
-          },
-          coins: 550
-        });
-      });
-      it('subtracts the coins and asset balances when spending', () => {
-        expect(
-          applyValue(
-            balances[address],
-            {
-              assets: {
-                12: 9n,
-                34: 15n
-              },
-              coins: 50
-            },
-            true
-          )
-        ).toEqual({
-          assets: {
-            12: 1n,
-            34: 5n
-          },
-          coins: 450
-        });
-      });
-      it('adds new assets to the address balance', () => {
-        expect(
-          applyValue(balances[address], {
-            assets: {
-              new: 100n
-            },
-            coins: 1
-          })
-        ).toEqual({
-          assets: {
-            12: 10n,
-            34: 20n,
-            new: 100n
-          },
-          coins: 501
-        });
-      });
-    });
-    describe('balance containing multiple assets, value containing only coins', () => {
-      const address = 'ef';
-      it('adds the coins', () => {
-        expect(
-          applyValue(balances[address], {
-            coins: 50
-          })
-        ).toEqual({
-          assets: {
-            12: 10n,
-            34: 20n
-          },
-          coins: 550
-        });
-      });
-      it('subtracts the coins', () => {
-        expect(applyValue(balances[address], { coins: 50 }, true)).toEqual({
-          assets: {
-            12: 10n,
-            34: 20n
-          },
-          coins: 450
-        });
-      });
-    });
-    describe('guarding against negative balances', () => {
-      const address = 'cd';
-      it('throws if the balance calculated for coins is less than 0', () => {
-        expect(() =>
-          applyValue(
-            balances[address],
-            {
-              coins: 500
-            },
-            true
-          )
-        ).toThrow();
-      });
-      it('throws if the balance calculated for assets is less than 0', () => {
-        expect(() =>
-          applyValue(
-            balances[address],
-            {
-              assets: {
-                12: 20n
-              },
-              coins: 1
-            },
-            true
-          )
-        ).toThrow();
-      });
-    });
-  });
-});

package/test/tsconfig.json DELETED Viewed

@@ -1,10 +0,0 @@
-{
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@src/*": ["../src/*"]
-    }
-  },
-  "references": [{ "path": "../src" }]
-}