Class FeeModule

The BaseModule represents Lisk modules by providing a generic interface, from which each module extends from.

Hierarchy

BaseInteroperableModule
- FeeModule

Constructors

constructor

new FeeModule(): FeeModule
Returns FeeModule
Overrides BaseInteroperableModule.constructor
- Defined in framework/src/modules/fee/module.ts:52

Properties

`Private` `Optional` _feePoolAddress

_feePoolAddress?: Buffer

`Private` _maxBlockHeightZeroFeePerByte

_maxBlockHeightZeroFeePerByte: number

`Private` _minFeePerByte

_minFeePerByte: number

`Private` _tokenID

_tokenID: Buffer

`Private` _tokenMethod

_tokenMethod: TokenMethod

commands

commands: BaseCommand<unknown>[] = []

configSchema

configSchema: {
    $id: string;
    properties: {
        feePoolAddress: {
            format: string;
            type: string;
        };
        feeTokenID: {
            format: string;
            type: string;
        };
        maxBlockHeightZeroFeePerByte: {
            format: string;
            type: string;
        };
        minFeePerByte: {
            format: string;
            type: string;
        };
    };
    required: string[];
    type: string;
} = configSchema

Type declaration

$id: string
properties: {
    feePoolAddress: {
        format: string;
        type: string;
    };
    feeTokenID: {
        format: string;
        type: string;
    };
    maxBlockHeightZeroFeePerByte: {
        format: string;
        type: string;
    };
    minFeePerByte: {
        format: string;
        type: string;
    };
}
- feePoolAddress: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- feeTokenID: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- maxBlockHeightZeroFeePerByte: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- minFeePerByte: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
required: string[]
type: string

crossChainCommand

crossChainCommand: BaseCCCommand<unknown>[] = []

crossChainMethod

crossChainMethod: FeeInteroperableMethod = ...

endpoint

endpoint: FeeEndpoint = ...

events

events: NamedRegistry = ...

method

method: FeeMethod = ...

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

Accessors

name

get name(): string
Returns string
Inherited from BaseInteroperableModule.name
- Defined in framework/src/modules/base_module.ts:73

Methods

_getMinFee

_getMinFee(blockHeight: number, transactionByteLength: number): bigint
Parameters
- blockHeight: number
- transactionByteLength: number
Returns bigint
- Defined in framework/src/modules/fee/module.ts:221

addDependencies

addDependencies(tokenMethod: TokenMethod, interopMethod: InteroperabilityMethod): void
Parameters
- tokenMethod: TokenMethod
- interopMethod: InteroperabilityMethod
Returns void
- Defined in framework/src/modules/fee/module.ts:59

afterCommandExecute

afterCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Overrides BaseInteroperableModule.afterCommandExecute
- Defined in framework/src/modules/fee/module.ts:152

`Optional` afterTransactionsExecute

afterTransactionsExecute(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.afterTransactionsExecute
- Defined in framework/src/modules/base_module.ts:90

`Protected` baseMetadata

baseMetadata(): {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
Returns {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
- assets: never[]
- commands: {
  name: string;
  params: Schema;
  }[]
- endpoints: never[]
- events: {
  data: Schema;
  name: string;
  }[]
- stores: {
  data: Schema;
  key: string;
  }[]
Inherited from BaseInteroperableModule.baseMetadata
- Defined in framework/src/modules/base_module.ts:94

beforeCommandExecute

beforeCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Overrides BaseInteroperableModule.beforeCommandExecute
- Defined in framework/src/modules/fee/module.ts:127

`Optional` beforeTransactionsExecute

beforeTransactionsExecute(context: BlockExecuteContext): Promise<void>
Parameters
- context: BlockExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.beforeTransactionsExecute
- Defined in framework/src/modules/base_module.ts:89

`Optional` finalizeGenesisState

finalizeGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.finalizeGenesisState
- Defined in framework/src/modules/base_module.ts:88

init

init(args: ModuleInitArgs): Promise<void>
Parameters
- args: ModuleInitArgs
Returns Promise<void>
Overrides BaseInteroperableModule.init
- Defined in framework/src/modules/fee/module.ts:81

`Optional` initGenesisState

initGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.initGenesisState
- Defined in framework/src/modules/base_module.ts:87

`Optional` insertAssets

insertAssets(context: InsertAssetContext): Promise<void>
Parameters
- context: InsertAssetContext
Returns Promise<void>
Inherited from BaseInteroperableModule.insertAssets
- Defined in framework/src/modules/base_module.ts:82

metadata

metadata(): ModuleMetadata
Returns ModuleMetadata
Overrides BaseInteroperableModule.metadata
- Defined in framework/src/modules/fee/module.ts:64

`Optional` verifyAssets

verifyAssets(context: BlockVerifyContext): Promise<void>
Parameters
- context: BlockVerifyContext
Returns Promise<void>
Inherited from BaseInteroperableModule.verifyAssets
- Defined in framework/src/modules/base_module.ts:83

verifyTransaction

verifyTransaction(context: TransactionVerifyContext): Promise<VerificationResult>
Parameters
- context: TransactionVerifyContext
Returns Promise<VerificationResult>
Overrides BaseInteroperableModule.verifyTransaction
- Defined in framework/src/modules/fee/module.ts:107

Class FeeModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FeeModule

Properties

Private Optional _feePoolAddress

Private _maxBlockHeightZeroFeePerByte

Private _minFeePerByte

Private _tokenID

Private _tokenMethod

commands

configSchema

Type declaration

$id: string

properties: { feePoolAddress: { format: string; type: string; }; feeTokenID: { format: string; type: string; }; maxBlockHeightZeroFeePerByte: { format: string; type: string; }; minFeePerByte: { format: string; type: string; }; }

feePoolAddress: { format: string; type: string; }

format: string

type: string

feeTokenID: { format: string; type: string; }

format: string

type: string

maxBlockHeightZeroFeePerByte: { format: string; type: string; }

format: string

type: string

minFeePerByte: { format: string; type: string; }

format: string

type: string

required: string[]

type: string

crossChainCommand

crossChainMethod

endpoint

events

method

offchainStores

stores

Accessors

name

Returns string

Methods

_getMinFee

Parameters

blockHeight: number

transactionByteLength: number

Returns bigint

addDependencies

Parameters

tokenMethod: TokenMethod

interopMethod: InteroperabilityMethod

Returns void

afterCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

Optional afterTransactionsExecute

Parameters

context: BlockAfterExecuteContext

Returns Promise<void>

Protected baseMetadata

Returns { assets: never[]; commands: { name: string; params: Schema; }[]; endpoints: never[]; events: { data: Schema; name: string; }[]; stores: { data: Schema; key: string; }[]; }

assets: never[]

commands: { name: string; params: Schema; }[]

endpoints: never[]

events: { data: Schema; name: string; }[]

stores: { data: Schema; key: string; }[]

beforeCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

Optional beforeTransactionsExecute

Parameters

context: BlockExecuteContext

Returns Promise<void>

Optional finalizeGenesisState

`Private` `Optional` _feePoolAddress

`Private` _maxBlockHeightZeroFeePerByte

`Private` _minFeePerByte

`Private` _tokenID

`Private` _tokenMethod

properties: {
feePoolAddress: {
format: string;
type: string;
};
feeTokenID: {
format: string;
type: string;
};
maxBlockHeightZeroFeePerByte: {
format: string;
type: string;
};
minFeePerByte: {
format: string;
type: string;
};
}

feePoolAddress: {
format: string;
type: string;
}

feeTokenID: {
format: string;
type: string;
}

maxBlockHeightZeroFeePerByte: {
format: string;
type: string;
}

minFeePerByte: {
format: string;
type: string;
}

`Optional` afterTransactionsExecute

`Protected` baseMetadata

Returns {
assets: never[];
commands: {
name: string;
params: Schema;
}[];
endpoints: never[];
events: {
data: Schema;
name: string;
}[];
stores: {
data: Schema;
key: string;
}[];
}

commands: {
name: string;
params: Schema;
}[]

events: {
data: Schema;
name: string;
}[]

stores: {
data: Schema;
key: string;
}[]

`Optional` beforeTransactionsExecute

`Optional` finalizeGenesisState

`Optional` initGenesisState

`Optional` insertAssets

`Optional` verifyAssets