refactor(crypto-configuration): replace get with getGenesisCommit & getNetwork (#1277)

sebastijankuzner · web-flow · commit e05d68af4abb · 2026-04-21T19:10:04.000+02:00
* Add getGenesisCommit abd getNetwork

* Update usages

* Fix crypto transaction

* Fix p2p tests

* Fix bootstrapper tests

* Fix database tests

* Fix network-generator tests

* Fix api-evm tests

* Fix crypto-config tests

* style: resolve style guide violations [ci-lint-fix]

* Fix deps
diff --git a/packages/api-evm/source/actions/eth-chain-id.ts b/packages/api-evm/source/actions/eth-chain-id.ts
@@ -17,6 +17,6 @@ export class EthChainIdAction implements Contracts.Api.RPC.Action {
 	};
 
 	public async handle(parameters: []): Promise<string> {
-		return `0x${this.configuration.get<number>("network.chainId").toString(16)}`;
+		return `0x${this.configuration.getNetwork().chainId.toString(16)}`;
 	}
 }
diff --git a/packages/api-evm/source/actions/net-version.test.ts b/packages/api-evm/source/actions/net-version.test.ts
@@ -15,7 +15,11 @@ describe<{
 		context.app = new Application();
 
 		context.app.bind(Identifiers.Cryptography.Configuration).toConstantValue({
-			get: () => "nethash",
+			getNetwork: () => {
+				return {
+					chainId: 123,
+				};
+			},
 		});
 
 		context.action = context.app.resolve(NetVersion);
@@ -41,6 +45,6 @@ describe<{
 	});
 
 	it("should return the web3 client version", async ({ action }) => {
-		assert.equal(await action.handle([]), `nethash`);
+		assert.equal(await action.handle([]), `123`);
 	});
 });
diff --git a/packages/api-evm/source/actions/net-version.ts b/packages/api-evm/source/actions/net-version.ts
@@ -17,6 +17,6 @@ export class NetVersion implements Contracts.Api.RPC.Action {
 	};
 
 	public async handle(parameters: []): Promise<string> {
-		return this.configuration.get<number>("network.chainId").toString();
+		return this.configuration.getNetwork().chainId.toString();
 	}
 }
diff --git a/packages/blockchain-utils/source/format.ts b/packages/blockchain-utils/source/format.ts
@@ -9,7 +9,7 @@ export const formatCurrency = (configuration: Contracts.Crypto.Configuration, am
 		minimumFractionDigits: 0,
 	});
 
-	return `${localeString} ${configuration.get("network.client.symbol")}`;
+	return `${localeString} ${configuration.getNetwork().client.symbol}`;
 };
 
 export const formatNumber = (value: number): string => value.toLocaleString("en");
diff --git a/packages/blockchain-utils/source/round-calculator.ts b/packages/blockchain-utils/source/round-calculator.ts
@@ -17,7 +17,7 @@ export class RoundCalculator implements Contracts.BlockchainUtils.RoundCalculato
 	private readonly configuration!: Contracts.Crypto.Configuration;
 
 	public isNewRound(height: number): boolean {
-		const milestones = this.configuration.get<Contracts.Crypto.Milestone[]>("milestones");
+		const milestones = this.configuration.getMilestones();
 		const genesisHeight = this.configuration.getGenesisHeight();
 
 		// Since milestones are merged, find the first milestone to introduce the validator count.
diff --git a/packages/bootstrap/source/bootstrapper.test.ts b/packages/bootstrap/source/bootstrapper.test.ts
@@ -35,7 +35,7 @@ describe<{
 
 	beforeEach((context) => {
 		context.configuration = {
-			get: () => genesisCommitJson,
+			getGenesisCommit: () => genesisCommitJson,
 			getGenesisHeight: () => 1,
 			getMilestone: () => {},
 		};
diff --git a/packages/bootstrap/source/bootstrapper.ts b/packages/bootstrap/source/bootstrapper.ts
@@ -84,10 +84,9 @@ export class Bootstrapper {
 	}
 
 	async #setGenesisCommit(): Promise<void> {
-		const genesisBlockJson = this.configuration.get<Contracts.Crypto.CommitJson>("genesisBlock");
-		const genesisBlock = await this.commitFactory.fromJson(genesisBlockJson);
-
-		this.stateStore.setGenesisCommit(genesisBlock);
+		const genesisCommitJson = this.configuration.getGenesisCommit();
+		const genesisCommit = await this.commitFactory.fromJson(genesisCommitJson);
+		this.stateStore.setGenesisCommit(genesisCommit);
 	}
 
 	async #checkStoredGenesisCommit(): Promise<void> {
diff --git a/packages/configuration-generator/source/generators/genesis-block.test.ts b/packages/configuration-generator/source/generators/genesis-block.test.ts
@@ -24,7 +24,6 @@ describe<{
 
 		context.app = app;
 
-		// @ts-ignore
 		app.get<Contracts.Crypto.Configuration>(AppIdentifiers.Cryptography.Configuration).setConfig(
 			{
 				genesisBlock: {
@@ -51,6 +50,9 @@ describe<{
 						validatorRegistrationFee: "250",
 					},
 				],
+				network: {
+					chainId: 123,
+				},
 			},
 			false,
 		);
diff --git a/packages/contracts/source/contracts/crypto/commit.ts b/packages/contracts/source/contracts/crypto/commit.ts
@@ -1,12 +1,18 @@
 import type { CommitStorageData } from "../evm/storage.js";
-import type { Block, BlockData, BlockJson } from "./block.js";
+import type { Block, BlockData, BlockJson, BlockJsonCrypto } from "./block.js";
 
 export interface CommitJson {
 	readonly block: BlockJson;
 	readonly proof: CommitProof;
 	readonly serialized: string;
 }
 
+export interface CommitJsonCrypto {
+	readonly block: BlockJsonCrypto;
+	readonly proof: CommitProof;
+	readonly serialized: string;
+}
+
 export type CommitSerializable = {
 	readonly block: Block;
 	readonly proof: CommitProof;
diff --git a/packages/contracts/source/contracts/crypto/config.ts b/packages/contracts/source/contracts/crypto/config.ts
@@ -1,20 +1,24 @@
+import type { CommitJsonCrypto } from "./commit.js";
 import type {
 	Milestone,
 	MilestoneDiff,
 	MilestoneKey,
 	MilestoneSearchResult,
+	Network,
 	NetworkConfig,
 	NetworkConfigPartial,
 } from "./networks.js";
 
 export interface Configuration {
 	setConfig(config: NetworkConfigPartial, verify?: boolean): void;
 
-	all(): NetworkConfig | undefined;
+	all(): NetworkConfig;
 
 	set<T = unknown>(key: string, value: T): void;
 
-	get<T = unknown>(key: string): T;
+	getGenesisCommit(): CommitJsonCrypto;
+
+	getNetwork(): Network;
 
 	setHeight(value: number): void;
 
diff --git a/packages/contracts/source/contracts/crypto/networks.ts b/packages/contracts/source/contracts/crypto/networks.ts
@@ -1,14 +1,14 @@
 import type { SpecId } from "../evm/evm.js";
-import type { CommitJson } from "./commit.js";
+import type { CommitJsonCrypto } from "./commit.js";
 
 export type NetworkConfig = {
-	genesisBlock: CommitJson;
+	genesisBlock: CommitJsonCrypto;
 	milestones: Milestone[];
 	network: Network;
 };
 
 export type NetworkConfigPartial = {
-	genesisBlock: CommitJson;
+	genesisBlock: CommitJsonCrypto;
 	milestones: MilestonePartial[];
 	network: Network;
 };
diff --git a/packages/crypto-address-base58/source/address.factory.ts b/packages/crypto-address-base58/source/address.factory.ts
@@ -29,7 +29,7 @@ export class AddressFactory implements Contracts.Crypto.AddressFactory {
 		const buffer: Buffer = this.hashFactory.ripemd160(Buffer.from(publicKey, "hex"));
 		const payload: Buffer = Buffer.alloc(21);
 
-		payload.writeUInt8(this.configuration.get("network.pubKeyHash"), 0);
+		payload.writeUInt8(this.configuration.getNetwork().pubKeyHash, 0);
 		buffer.copy(payload, 1);
 
 		return this.#encodeCheck(payload);
@@ -50,7 +50,7 @@ export class AddressFactory implements Contracts.Crypto.AddressFactory {
 	public async toBuffer(address: string): Promise<Buffer> {
 		const result: Buffer = this.#decodeCheck(address);
 
-		const pubKeyHash = this.configuration.get("network.pubKeyHash");
+		const pubKeyHash = this.configuration.getNetwork().pubKeyHash;
 
 		if (result[0] !== pubKeyHash) {
 			throw new Error(`Expected address network byte ${pubKeyHash}, but got ${result[0]}.`);
@@ -61,7 +61,7 @@ export class AddressFactory implements Contracts.Crypto.AddressFactory {
 
 	public async validate(address: string): Promise<boolean> {
 		try {
-			return this.#decodeCheck(address)[0] === this.configuration.get("network.pubKeyHash");
+			return this.#decodeCheck(address)[0] === this.configuration.getNetwork().pubKeyHash;
 		} catch {
 			return false;
 		}
diff --git a/packages/crypto-config/package.json b/packages/crypto-config/package.json
@@ -29,15 +29,13 @@
 		"ajv": "8.18.0",
 		"deepmerge": "4.3.1",
 		"lodash.clone": "4.5.0",
-		"lodash.get": "4.4.2",
 		"lodash.set": "4.3.2"
 	},
 	"devDependencies": {
 		"@mainsail/contracts": "workspace:*",
 		"@mainsail/test-runner": "workspace:*",
 		"@mainsail/validation": "workspace:*",
 		"@types/lodash.clone": "4.5.9",
-		"@types/lodash.get": "4.4.9",
 		"@types/lodash.set": "4.3.9",
 		"uvu": "0.5.6"
 	},
diff --git a/packages/crypto-config/source/configuration.test.ts b/packages/crypto-config/source/configuration.test.ts
@@ -7,6 +7,7 @@ import type { Contracts } from "@mainsail/contracts";
 import { Identifiers } from "@mainsail/constants";
 
 import { schemas } from "./schemas.js";
+import clone from "lodash.clone";
 
 describe<{
 	app: Application;
@@ -36,26 +37,18 @@ describe<{
 		assert.containKeys(configManager.all(), ["network", "milestones", "genesisBlock"]);
 	});
 
+	it("should throw if invalid config is provided", ({ configManager }) => {
+		assert.throws(() =>
+			configManager.setConfig({ ...cryptoJson, network: { ...cryptoJson.network, nethash: "dummy" } }),
+		);
+	});
+
 	it("should throw on set before config is initialized", () => {
 		const fresh = new Configuration();
 
 		assert.throws(() => fresh.set("network.nethash", "dummy"));
 	});
 
-	it('key should be "set" if it is on config object property', ({ configManager }) => {
-		configManager.set("network.key", "value");
-		assert.equal(configManager.get("network.key"), "value");
-	});
-
-	it('key should not be "set" if it is not on config property', ({ configManager }) => {
-		configManager.set("key", "value");
-		assert.undefined(configManager.get("key"));
-	});
-
-	it('key should be "get"', ({ configManager }) => {
-		assert.equal(configManager.get("network.nethash"), cryptoJson.network.nethash);
-	});
-
 	it("should build milestones", ({ configManager }) => {
 		assert.equal(configManager.getMilestones(), [
 			{
diff --git a/packages/crypto-config/source/configuration.ts b/packages/crypto-config/source/configuration.ts
@@ -10,7 +10,6 @@ import {
 import { assert } from "@mainsail/utils";
 import deepmerge from "deepmerge";
 import clone from "lodash.clone";
-import get from "lodash.get";
 import set from "lodash.set";
 
 type Config = {
@@ -36,7 +35,8 @@ export class Configuration implements Contracts.Crypto.Configuration {
 		this.#buildConstants(config);
 	}
 
-	public all(): Contracts.Crypto.NetworkConfig | undefined {
+	public all(): Contracts.Crypto.NetworkConfig {
+		assert.defined(this.#configuration);
 		return this.#configuration?.config;
 	}
 
@@ -47,8 +47,14 @@ export class Configuration implements Contracts.Crypto.Configuration {
 		this.#buildConstants(this.#configuration.config);
 	}
 
-	public get<T = unknown>(key: string): T {
-		return get(this.#configuration?.config, key);
+	public getGenesisCommit(): Contracts.Crypto.CommitJsonCrypto {
+		assert.defined(this.#configuration);
+		return this.#configuration.config.genesisBlock;
+	}
+
+	public getNetwork(): Contracts.Crypto.Network {
+		assert.defined(this.#configuration);
+		return this.#configuration.config.network;
 	}
 
 	public setHeight(value: number): void {
diff --git a/packages/crypto-config/source/service-provider.test.ts b/packages/crypto-config/source/service-provider.test.ts
@@ -33,8 +33,8 @@ describe<Context>("ServiceProvider", ({ assert, it, beforeEach }) => {
 
 		const configManager = app.get<Contracts.Crypto.Configuration>(Identifiers.Cryptography.Configuration);
 		assert.containKeys(configManager.all()!, ["genesisBlock", "milestones", "network"]);
-		assert.equal(configManager.get("network"), cryptoJson.network);
-		assert.equal(configManager.get("genesisBlock.block"), cryptoJson.genesisBlock.block);
-		assert.equal(configManager.get<any[]>("milestones").length, cryptoJson.milestones.length);
+		assert.equal(configManager.getNetwork(), cryptoJson.network);
+		assert.equal(configManager.getGenesisCommit(), cryptoJson.genesisBlock);
+		assert.equal(configManager.getMilestones().length, cryptoJson.milestones.length);
 	});
 });
diff --git a/packages/crypto-config/source/service-provider.ts b/packages/crypto-config/source/service-provider.ts
@@ -23,7 +23,7 @@ export class ServiceProvider extends Providers.ServiceProvider {
 		const configRepository = this.app.get<Contracts.Kernel.Repository>(Identifiers.Config.Repository);
 
 		return {
-			genesisBlock: configRepository.get<Contracts.Crypto.CommitJson>("crypto.genesisBlock"),
+			genesisBlock: configRepository.get<Contracts.Crypto.CommitJsonCrypto>("crypto.genesisBlock"),
 			milestones: configRepository.get<Contracts.Crypto.MilestonePartial[]>("crypto.milestones"),
 			network: configRepository.get<Contracts.Crypto.Network>("crypto.network"),
 		};
diff --git a/packages/crypto-key-pair-ecdsa/source/pair.ts b/packages/crypto-key-pair-ecdsa/source/pair.ts
@@ -24,7 +24,7 @@ export class KeyPairFactory implements Contracts.Crypto.KeyPairFactory {
 	}
 
 	public async fromWIF(wif: string): Promise<Contracts.Crypto.KeyPair> {
-		const networkVersion = this.configuration.get<number>("network.wif");
+		const networkVersion = this.configuration.getNetwork().wif;
 		const decoded = decode(wif);
 
 		if (decoded.version !== networkVersion) {
diff --git a/packages/crypto-transaction/source/builder.ts b/packages/crypto-transaction/source/builder.ts
@@ -44,7 +44,7 @@ export class TransactionBuilder {
 			gasLimit: 1_000_000,
 			gasPrice: 5 * 1e9,
 			hash: "",
-			network: this.configuration.get<number>("network.chainId"),
+			network: this.configuration.getNetwork().chainId,
 			nonce: BigNumber.ZERO,
 			r: "",
 			s: "",
diff --git a/packages/crypto-transaction/source/factory.ts b/packages/crypto-transaction/source/factory.ts
@@ -66,7 +66,7 @@ export class TransactionFactory implements Contracts.Crypto.TransactionFactory {
 			gasLimit: Number(transaction.gasLimit),
 			gasPrice: Number(transaction.gasPrice),
 			hash: transaction.txHash,
-			network: this.configuration.get<number>("network.chainId"),
+			network: this.configuration.getNetwork().chainId,
 			nonce: BigNumber.make(transaction.nonce),
 			senderLegacyAddress:
 				transaction.legacyAddress ||
diff --git a/packages/crypto-transaction/source/validation/keywords.ts b/packages/crypto-transaction/source/validation/keywords.ts
@@ -14,10 +14,7 @@ export const makeKeywords = (
 	const network: FuncKeywordDefinition = {
 		compile() {
 			return (data) => {
-				const chainId = configuration.get<number | undefined>("network.chainId");
-				if (!chainId) {
-					return true;
-				}
+				const chainId = configuration.getNetwork().chainId;
 				return data === chainId;
 			};
 		},
@@ -54,8 +51,7 @@ export const makeKeywords = (
 						// Otherwise lookup by transaction hash
 						if (!valid && parentSchema && parentSchema.parentData && parentSchema.parentData.hash) {
 							if (genesisTransactionsLookup.size === 0) {
-								const genesisBlock =
-									configuration.get<Contracts.Crypto.BlockJsonCrypto>("genesisBlock.block");
+								const genesisBlock = configuration.getGenesisCommit().block;
 								for (const transaction of genesisBlock?.transactions || []) {
 									genesisTransactionsLookup.add(transaction.hash);
 								}
diff --git a/packages/crypto-transaction/source/validation/schemas.test.ts b/packages/crypto-transaction/source/validation/schemas.test.ts
@@ -226,10 +226,10 @@ describe<{
 	});
 
 	it("transactionBaseSchema - gasPrice should accept 0 for genesis block", ({ app, validator }) => {
-		const configuration = app.get<Configuration>(Identifiers.Cryptography.Configuration);
+		const configuration = app.get<Contracts.Crypto.Configuration>(Identifiers.Cryptography.Configuration);
 		configuration.setHeight(1);
 
-		const genesisBlock: Contracts.Crypto.BlockData = configuration.get("genesisBlock.block");
+		const genesisBlock: Contracts.Crypto.BlockData = configuration.getGenesisCommit().block;
 
 		const transaction = {
 			...transactionOriginal,
diff --git a/packages/crypto-wif/source/wif.factory.ts b/packages/crypto-wif/source/wif.factory.ts
@@ -19,15 +19,15 @@ export class WIFFactory implements Contracts.Crypto.WIFFactory {
 		return encode({
 			compressed,
 			privateKey: Buffer.from(privateKey, "hex"),
-			version: this.configuration.get("network.wif"),
+			version: this.configuration.getNetwork().wif,
 		});
 	}
 
 	public async fromKeys(keys: Contracts.Crypto.KeyPair): Promise<string> {
 		return encode({
 			compressed: keys.compressed,
 			privateKey: Buffer.from(keys.privateKey, "hex"),
-			version: this.configuration.get("network.wif"),
+			version: this.configuration.getNetwork().wif,
 		});
 	}
 }
diff --git a/packages/database/source/database-service.test.ts b/packages/database/source/database-service.test.ts
@@ -160,9 +160,10 @@ describe<{
 		const commitStateFactory = app.get<Contracts.Consensus.CommitStateFactory>(
 			Identifiers.Consensus.CommitState.Factory,
 		);
+
 		const evm = app.getTagged<Contracts.Evm.Instance>(Identifiers.Evm.Instance, "instance", "evm");
 
-		const genesisCommitJson = configuration.get<Contracts.Crypto.CommitJson>("genesisBlock");
+		const genesisCommitJson = configuration.getGenesisCommit();
 		const genesisCommit = await commitFactory.fromJson(genesisCommitJson);
 
 		const commitState = commitStateFactory(genesisCommit);
diff --git a/packages/p2p/source/peer-verifier.ts b/packages/p2p/source/peer-verifier.ts
diff --git a/packages/p2p/source/socket-server/utils/get-peer-config.test.ts b/packages/p2p/source/socket-server/utils/get-peer-config.test.ts
diff --git a/packages/p2p/source/socket-server/utils/get-peer-config.ts b/packages/p2p/source/socket-server/utils/get-peer-config.ts
diff --git a/packages/p2p/source/utils/is-valid-version.test.ts b/packages/p2p/source/utils/is-valid-version.test.ts
diff --git a/packages/p2p/source/utils/is-valid-version.ts b/packages/p2p/source/utils/is-valid-version.ts
diff --git a/packages/test-factories/source/factories/factories/block.ts b/packages/test-factories/source/factories/factories/block.ts
diff --git a/packages/transaction-pool-service/source/sender-state.ts b/packages/transaction-pool-service/source/sender-state.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/functional/consensus/source/setup.ts b/tests/functional/consensus/source/setup.ts
diff --git a/tests/functional/resync/source/setup.ts b/tests/functional/resync/source/setup.ts
diff --git a/tests/functional/transaction-pool-api/source/setup.ts b/tests/functional/transaction-pool-api/source/setup.ts

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,6 @@ export class EthChainIdAction implements Contracts.Api.RPC.Action {`
`17`	`17`	`};`
`18`	`18`
`19`	`19`	`public async handle(parameters: []): Promise<string> {`
`20`		- return `0x${this.configuration.get<number>("network.chainId").toString(16)}`;
	`20`	+ return `0x${this.configuration.getNetwork().chainId.toString(16)}`;
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,6 @@ export class NetVersion implements Contracts.Api.RPC.Action {`
`17`	`17`	`};`
`18`	`18`
`19`	`19`	`public async handle(parameters: []): Promise<string> {`
`20`		`- return this.configuration.get<number>("network.chainId").toString();`
	`20`	`+ return this.configuration.getNetwork().chainId.toString();`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,10 +84,9 @@ export class Bootstrapper {`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`async #setGenesisCommit(): Promise<void> {`
`87`		`- const genesisBlockJson = this.configuration.get<Contracts.Crypto.CommitJson>("genesisBlock");`
`88`		`- const genesisBlock = await this.commitFactory.fromJson(genesisBlockJson);`
`89`		`-`
`90`		`- this.stateStore.setGenesisCommit(genesisBlock);`
	`87`	`+ const genesisCommitJson = this.configuration.getGenesisCommit();`
	`88`	`+ const genesisCommit = await this.commitFactory.fromJson(genesisCommitJson);`
	`89`	`+ this.stateStore.setGenesisCommit(genesisCommit);`
`91`	`90`	`}`
`92`	`91`
`93`	`92`	`async #checkStoredGenesisCommit(): Promise<void> {`