Add TypeDocs for the NFT module

commander/src/bootstrapping/commands/base_ipc_client.ts

@@ -15,7 +15,7 @@
 
 import * as apiClient from '@liskhq/lisk-api-client';
 import { Command } from '@oclif/core';
-import { RegisteredSchema, ModuleMetadataJSON } from 'lisk-framework';
+import { RegisteredSchema, Modules } from 'lisk-framework';
 import { PromiseResolvedType } from '../../types';
 import { isApplicationRunning } from '../../utils/application';
 import { flagsWithParser } from '../../utils/flags';
@@ -35,7 +35,7 @@ export abstract class BaseIPCClientCommand extends Command {
 	protected baseIPCClientFlags!: BaseIPCClientFlags;
 	protected _client!: PromiseResolvedType<ReturnType<typeof apiClient.createIPCClient>> | undefined;
 	protected _schema!: RegisteredSchema;
-	protected _metadata!: ModuleMetadataJSON[];
+	protected _metadata!: Modules.ModuleMetadataJSON[];
 	protected _dataPath!: string;
 
 	async finally(): Promise<void> {

commander/src/bootstrapping/commands/transaction/create.ts

@@ -27,7 +27,7 @@ import {
 	blockHeaderSchema,
 	blockSchema,
 	transactionSchema,
-	ModuleMetadataJSON,
+	Modules,
 } from 'lisk-framework';
 import { PromiseResolvedType } from '../../../types';
 import { deriveKeypair } from '../../../utils/commons';
@@ -74,7 +74,11 @@ interface Transaction {
 	signatures: never[];
 }
 
-const getParamsObject = async (metadata: ModuleMetadataJSON[], flags: CreateFlags, args: Args) => {
+const getParamsObject = async (
+	metadata: Modules.ModuleMetadataJSON[],
+	flags: CreateFlags,
+	args: Args,
+) => {
 	let params: Record<string, unknown>;
 
 	const paramsSchema = getParamsSchema(metadata, args.module, args.command);
@@ -113,7 +117,7 @@ const getKeysFromFlags = async (flags: CreateFlags) => {
 const validateAndSignTransaction = (
 	transaction: Transaction,
 	schema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	chainID: string,
 	privateKey: Buffer,
 	noSignature: boolean,
@@ -146,7 +150,7 @@ const createTransactionOffline = async (
 	args: Args,
 	flags: CreateFlags,
 	registeredSchema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transaction: Transaction,
 ) => {
 	const params = await getParamsObject(metadata, flags, args);
@@ -170,7 +174,7 @@ const createTransactionOnline = async (
 	flags: CreateFlags,
 	client: apiClient.APIClient,
 	registeredSchema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transaction: Transaction,
 ) => {
 	const nodeInfo = await client.node.getNodeInfo();
@@ -276,7 +280,7 @@ export abstract class CreateCommand extends Command {
 
 	protected _client!: PromiseResolvedType<ReturnType<typeof apiClient.createIPCClient>> | undefined;
 	protected _schema!: RegisteredSchema;
-	protected _metadata!: ModuleMetadataJSON[];
+	protected _metadata!: Modules.ModuleMetadataJSON[];
 	protected _dataPath!: string;
 
 	async run(): Promise<void> {

commander/src/bootstrapping/commands/transaction/sign.ts

@@ -18,7 +18,7 @@ import {
 	Application,
 	blockHeaderSchema,
 	blockSchema,
-	ModuleMetadataJSON,
+	Modules,
 	PartialApplicationConfig,
 	RegisteredSchema,
 	transactionSchema,
@@ -58,7 +58,7 @@ interface SignFlags {
 const signTransaction = async (
 	flags: SignFlags,
 	registeredSchema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transactionHexStr: string,
 	chainID: string | undefined,
 	keys: Keys,
@@ -106,7 +106,7 @@ const signTransaction = async (
 const signTransactionOffline = async (
 	flags: SignFlags,
 	registeredSchema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transactionHexStr: string,
 ): Promise<Record<string, unknown>> => {
 	const mandatoryKeys = flags['mandatory-keys'];
@@ -133,7 +133,7 @@ const signTransactionOnline = async (
 	flags: SignFlags,
 	client: apiClient.APIClient,
 	registeredSchema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transactionHexStr: string,
 ) => {
 	const transactionObject = decodeTransaction(registeredSchema, metadata, transactionHexStr);
@@ -191,7 +191,7 @@ export abstract class SignCommand extends Command {
 
 	protected _client: PromiseResolvedType<ReturnType<typeof apiClient.createIPCClient>> | undefined;
 	protected _schema!: RegisteredSchema;
-	protected _metadata!: ModuleMetadataJSON[];
+	protected _metadata!: Modules.ModuleMetadataJSON[];
 	protected _dataPath!: string;
 
 	async run(): Promise<void> {

commander/src/utils/genesis_creation.ts

@@ -15,14 +15,7 @@
  */
 import { Schema } from '@liskhq/lisk-codec';
 import { address } from '@liskhq/lisk-cryptography';
-import {
-	genesisInteroperabilitySchema,
-	MODULE_NAME_INTEROPERABILITY,
-	posGenesisStoreSchema,
-	PoSModule,
-	tokenGenesisStoreSchema,
-	TokenModule,
-} from 'lisk-framework';
+import { Modules } from 'lisk-framework';
 
 export const genesisAssetsSchema = {
 	$id: '/genesis/asset/0',
@@ -91,7 +84,7 @@ export const generateGenesisBlockDefaultPoSAssets = (input: GenesisBlockDefaultA
 	);
 	const genesisAssets = [
 		{
-			module: new TokenModule().name,
+			module: new Modules.Token.TokenModule().name,
 			data: {
 				userSubstore: input.keysList.map(a => ({
 					address: a.address,
@@ -108,10 +101,10 @@ export const generateGenesisBlockDefaultPoSAssets = (input: GenesisBlockDefaultA
 				escrowSubstore: [],
 				supportedTokensSubstore: [],
 			} as Record<string, unknown>,
-			schema: tokenGenesisStoreSchema,
+			schema: Modules.Token.genesisTokenStoreSchema,
 		},
 		{
-			module: new PoSModule().name,
+			module: new Modules.PoS.PoSModule().name,
 			data: {
 				validators: input.keysList.map((v, i) => ({
 					address: v.address,
@@ -133,18 +126,18 @@ export const generateGenesisBlockDefaultPoSAssets = (input: GenesisBlockDefaultA
 					initValidators: input.keysList.slice(0, input.numberOfValidators).map(v => v.address),
 				},
 			} as Record<string, unknown>,
-			schema: posGenesisStoreSchema,
+			schema: Modules.PoS.genesisStoreSchema,
 		},
 		{
-			module: MODULE_NAME_INTEROPERABILITY,
+			module: Modules.Interoperability.MODULE_NAME_INTEROPERABILITY,
 			data: {
 				ownChainName: '',
 				ownChainNonce: 0,
 				chainInfos: [],
 				terminatedStateAccounts: [],
 				terminatedOutboxAccounts: [],
 			},
-			schema: genesisInteroperabilitySchema,
+			schema: Modules.Interoperability.genesisInteroperabilitySchema,
 		},
 	];
 

commander/src/utils/transaction.ts

@@ -16,14 +16,14 @@ import * as liskApiClient from '@liskhq/lisk-api-client';
 import * as cryptography from '@liskhq/lisk-cryptography';
 import { codec } from '@liskhq/lisk-codec';
 import { TransactionJSON } from '@liskhq/lisk-chain';
-import { ModuleMetadataJSON, RegisteredSchema } from 'lisk-framework';
+import { Modules, RegisteredSchema } from 'lisk-framework';
 
 import { Schema } from '../types';
 import { getDefaultPath } from './path';
 import { isApplicationRunning } from './application';
 
 export const getParamsSchema = (
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	module: string,
 	command: string,
 ): Schema => {
@@ -40,7 +40,7 @@ export const getParamsSchema = (
 
 export const decodeTransaction = (
 	schema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transactionHexStr: string,
 ) => {
 	const transactionBytes = Buffer.from(transactionHexStr, 'hex');
@@ -60,7 +60,7 @@ export const decodeTransaction = (
 
 export const encodeTransaction = (
 	schema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transaction: Record<string, unknown>,
 	apiClient?: liskApiClient.APIClient,
 ): Buffer => {
@@ -79,7 +79,7 @@ export const encodeTransaction = (
 
 export const encodeTransactionJSON = (
 	schema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transaction: Record<string, unknown>,
 	apiClient?: liskApiClient.APIClient,
 ): Buffer => {
@@ -101,7 +101,7 @@ export const encodeTransactionJSON = (
 
 export const transactionToJSON = (
 	schema: RegisteredSchema,
-	metadata: ModuleMetadataJSON[],
+	metadata: Modules.ModuleMetadataJSON[],
 	transaction: Record<string, unknown>,
 	apiClient?: liskApiClient.APIClient,
 ): Record<string, unknown> => {

examples/interop/pos-mainchain-fast/src/app/app.ts

@@ -1,12 +1,12 @@
-import { Application, PartialApplicationConfig, NFTModule } from 'lisk-sdk';
+import { Application, PartialApplicationConfig, Modules } from 'lisk-sdk';
 import { TestNftModule } from './modules/testNft/module';
 import { registerModules } from './modules';
 import { registerPlugins } from './plugins';
 
 export const getApplication = (config: PartialApplicationConfig): Application => {
 	const { app, method } = Application.defaultApplication(config, true);
 
-	const nftModule = new NFTModule();
+	const nftModule = new Modules.NFT.NFTModule();
 	const testNftModule = new TestNftModule();
 	const interoperabilityModule = app['_registeredModules'].find(
 		mod => mod.name === 'interoperability',

examples/interop/pos-mainchain-fast/src/app/modules/testNft/commands/destroy_nft.ts

@@ -12,23 +12,23 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-import { BaseCommand, CommandExecuteContext, NFTMethod } from 'lisk-sdk';
+import { StateMachine, Modules } from 'lisk-sdk';
 import { destroyNftParamsSchema } from '../schema';
 
 interface Params {
 	address: Buffer;
 	nftID: Buffer;
 }
 
-export class DestroyNftCommand extends BaseCommand {
-	private _nftMethod!: NFTMethod;
+export class DestroyNftCommand extends Modules.BaseCommand {
+	private _nftMethod!: Modules.NFT.NFTMethod;
 	public schema = destroyNftParamsSchema;
 
-	public init(args: { nftMethod: NFTMethod }): void {
+	public init(args: { nftMethod: Modules.NFT.NFTMethod }): void {
 		this._nftMethod = args.nftMethod;
 	}
 
-	public async execute(context: CommandExecuteContext<Params>): Promise<void> {
+	public async execute(context: StateMachine.CommandExecuteContext<Params>): Promise<void> {
 		const { params } = context;
 
 		await this._nftMethod.destroy(context.getMethodContext(), params.address, params.nftID);

examples/interop/pos-mainchain-fast/src/app/modules/testNft/commands/mint_nft.ts

@@ -12,7 +12,7 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-import { BaseCommand, CommandExecuteContext, NFTMethod } from 'lisk-sdk';
+import { StateMachine, Modules } from 'lisk-sdk';
 import { NFTAttributes } from '../types';
 import { mintNftParamsSchema } from '../schema';
 
@@ -22,15 +22,15 @@ interface Params {
 	attributesArray: NFTAttributes[];
 }
 
-export class MintNftCommand extends BaseCommand {
-	private _nftMethod!: NFTMethod;
+export class MintNftCommand extends Modules.BaseCommand {
+	private _nftMethod!: Modules.NFT.NFTMethod;
 	public schema = mintNftParamsSchema;
 
-	public init(args: { nftMethod: NFTMethod }): void {
+	public init(args: { nftMethod: Modules.NFT.NFTMethod }): void {
 		this._nftMethod = args.nftMethod;
 	}
 
-	public async execute(context: CommandExecuteContext<Params>): Promise<void> {
+	public async execute(context: StateMachine.CommandExecuteContext<Params>): Promise<void> {
 		const { params } = context;
 
 		await this._nftMethod.create(

examples/interop/pos-mainchain-fast/src/app/modules/testNft/endpoint.ts

@@ -12,6 +12,6 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-import { BaseEndpoint } from 'lisk-sdk';
+import { Modules } from 'lisk-sdk';
 
-export class TestNftEndpoint extends BaseEndpoint {}
+export class TestNftEndpoint extends Modules.BaseEndpoint {}

examples/interop/pos-mainchain-fast/src/app/modules/testNft/method.ts

@@ -12,6 +12,6 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-import { BaseMethod } from 'lisk-sdk';
+import { Modules } from 'lisk-sdk';
 
-export class TestNftMethod extends BaseMethod {}
+export class TestNftMethod extends Modules.BaseMethod {}

examples/interop/pos-mainchain-fast/src/app/modules/testNft/module.ts

@@ -12,26 +12,26 @@
  * Removal or modification of this copyright notice is prohibited.
  */
 
-import { BaseModule, ModuleInitArgs, ModuleMetadata, NFTMethod } from 'lisk-sdk';
+import { Modules } from 'lisk-sdk';
 import { TestNftEndpoint } from './endpoint';
 import { TestNftMethod } from './method';
 import { MintNftCommand } from './commands/mint_nft';
 import { DestroyNftCommand } from './commands/destroy_nft';
 
-export class TestNftModule extends BaseModule {
+export class TestNftModule extends Modules.BaseModule {
 	public endpoint = new TestNftEndpoint(this.stores, this.offchainStores);
 	public method = new TestNftMethod(this.stores, this.events);
 	public mintNftCommand = new MintNftCommand(this.stores, this.events);
 	public destroyNftCommand = new DestroyNftCommand(this.stores, this.events);
 	public commands = [this.mintNftCommand, this.destroyNftCommand];
 
-	private _nftMethod!: NFTMethod;
+	private _nftMethod!: Modules.NFT.NFTMethod;
 
-	public addDependencies(nftMethod: NFTMethod) {
+	public addDependencies(nftMethod: Modules.NFT.NFTMethod) {
 		this._nftMethod = nftMethod;
 	}
 
-	public metadata(): ModuleMetadata {
+	public metadata(): Modules.ModuleMetadata {
 		return {
 			...this.baseMetadata(),
 			endpoints: [],
@@ -45,7 +45,7 @@ export class TestNftModule extends BaseModule {
 	}
 
 	// eslint-disable-next-line @typescript-eslint/require-await
-	public async init(_args: ModuleInitArgs) {
+	public async init(_args: Modules.ModuleInitArgs) {
 		this.mintNftCommand.init({
 			nftMethod: this._nftMethod,
 		});

examples/interop/pos-sidechain-example-one/src/app/app.ts

@@ -1,4 +1,4 @@
-import { Application, PartialApplicationConfig, NFTModule } from 'lisk-sdk';
+import { Application, PartialApplicationConfig, Modules } from 'lisk-sdk';
 import { TestNftModule } from './modules/testNft/module';
 import { registerModules } from './modules';
 import { registerPlugins } from './plugins';
@@ -7,7 +7,7 @@ import { HelloModule } from './modules/hello/module';
 export const getApplication = (config: PartialApplicationConfig): Application => {
 	const { app, method } = Application.defaultApplication(config, false);
 
-	const nftModule = new NFTModule();
+	const nftModule = new Modules.NFT.NFTModule();
 	const testNftModule = new TestNftModule();
 	const interoperabilityModule = app['_registeredModules'].find(
 		mod => mod.name === 'interoperability',