Create fee module class - Closes #6692

framework/src/modules/fee/api.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+import { BaseAPI } from '../base_api';
+
+export class FeeAPI extends BaseAPI {}

framework/src/modules/fee/constants.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+export const MODULE_ID_FEE = 1;

framework/src/modules/fee/endpoint.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+import { BaseEndpoint } from '../base_endpoint';
+
+export class FeeEndpoint extends BaseEndpoint {}

framework/src/modules/fee/index.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+export { FeeModule } from './module';

framework/src/modules/fee/module.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+import { BaseModule, ModuleInitArgs } from '../base_module';
+import { BaseFee, TokenAPI, ModuleConfig } from './types';
+import {
+	TransactionExecuteContext,
+	TransactionVerifyContext,
+	VerificationResult,
+} from '../../node/state_machine';
+import { FeeAPI } from './api';
+import { FeeEndpoint } from './endpoint';
+import { configSchema } from './schemas';
+
+export class FeeModule extends BaseModule {
+	public id = 11;
+	public name = 'fee';
+	public api = new FeeAPI(this.id);
+	public configSchema = configSchema;
+	public endpoint = new FeeEndpoint(this.id);
+	private _tokenAPI!: TokenAPI;
+	private _minFeePerBytes!: number;
+	private _baseFees!: Array<BaseFee>;
+	private _moduleConfig!: ModuleConfig;
+
+	public addDependencies(tokenAPI: TokenAPI) {
+		this._tokenAPI = tokenAPI;
+	}
+
+	// eslint-disable-next-line @typescript-eslint/require-await
+	public async init(args: ModuleInitArgs): Promise<void> {
+		const { genesisConfig, moduleConfig } = args;
+		this._moduleConfig = (moduleConfig as unknown) as ModuleConfig;
+		this._minFeePerBytes = genesisConfig.minFeePerByte;
+		this._baseFees = genesisConfig.baseFees.map(fee => ({ ...fee, baseFee: BigInt(fee.baseFee) }));
+	}
+
+	// eslint-disable-next-line @typescript-eslint/require-await
+	public async verifyTransaction(_context: TransactionVerifyContext): Promise<VerificationResult> {
+		return { status: 1 };
+	}
+
+	// eslint-disable-next-line @typescript-eslint/require-await
+	public async beforeTransactionExecute(_context: TransactionExecuteContext): Promise<void> {
+		// eslint-disable-next-line no-console
+		console.log(this._tokenAPI, this._minFeePerBytes, this._baseFees, this._moduleConfig);
+	}
+}

framework/src/modules/fee/schemas.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+export const configSchema = {
+	$id: '/fee/config',
+	type: 'object',
+	properties: {
+		feeTokenID: {
+			type: 'object',
+			properties: {
+				chainID: {
+					dataType: 'uint32',
+				},
+				localID: {
+					dataType: 'uint32',
+				},
+			},
+		},
+	},
+	required: ['feeTokenID'],
+};

framework/src/modules/fee/types.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright © 2021 Lisk Foundation
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
+ * no part of this software, including this file, may be copied, modified,
+ * propagated, or distributed except according to the terms contained in the
+ * LICENSE file.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+import { APIContext } from '../../node/state_machine';
+
+export interface BaseFee {
+	moduleID: number;
+	commandID: number;
+	baseFee: bigint;
+}
+
+export interface ModuleConfig {
+	feeTokenID: {
+		chainID: number;
+		localID: number;
+	};
+}
+
+export interface TokenAPI {
+	transfer: (
+		apiContext: APIContext,
+		senderAddress: Buffer,
+		generatorAddress: Buffer,
+		id: { chainID: number; localID: number },
+		amount: bigint,
+	) => Promise<void>;
+	burn: (
+		apiContext: APIContext,
+		senderAddress: Buffer,
+		id: { chainID: number; localID: number },
+		amount: bigint,
+	) => Promise<void>;
+}

framework/src/types.ts

@@ -77,7 +77,6 @@ export interface NetworkConfig {
 }
 
 export interface GenesisConfig {
-	[key: string]: unknown;
 	bftThreshold: number;
 	communityIdentifier: string;
 	blockTime: number;