Class PoAModule

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

Hierarchy

BaseModule
- PoAModule

Constructors

constructor

new PoAModule(): PoAModule
Returns PoAModule
Overrides BaseModule.constructor
- Defined in framework/src/modules/poa/module.ts:78

Properties

`Private` _feeMethod

_feeMethod: FeeMethod

`Private` _moduleConfig

_moduleConfig: ModuleConfig

`Private` _randomMethod

_randomMethod: RandomMethod

`Private` `Readonly` _registerAuthorityCommand

_registerAuthorityCommand: RegisterAuthorityCommand = ...

`Private` `Readonly` _updateAuthorityCommand

_updateAuthorityCommand: UpdateAuthorityCommand = ...

`Private` `Readonly` _updateGeneratorKeyCommand

_updateGeneratorKeyCommand: UpdateGeneratorKeyCommand = ...

`Private` _validatorsMethod

_validatorsMethod: ValidatorsMethod

commands

commands: (RegisterAuthorityCommand | UpdateAuthorityCommand | UpdateGeneratorKeyCommand)[] = ...

endpoint

endpoint: PoAEndpoint = ...

events

events: NamedRegistry = ...

method

method: PoAMethod = ...

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

Accessors

name

get name(): string
Returns string
Overrides BaseModule.name
- Defined in framework/src/modules/poa/module.ts:87

Methods

addDependencies

addDependencies(validatorsMethod: ValidatorsMethod, feeMethod: FeeMethod, randomMethod: RandomMethod): void
Parameters
- validatorsMethod: ValidatorsMethod
- feeMethod: FeeMethod
- randomMethod: RandomMethod
Returns void
- Defined in framework/src/modules/poa/module.ts:91

`Optional` afterCommandExecute

afterCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Inherited from BaseModule.afterCommandExecute
- Defined in framework/src/modules/base_module.ts:86

afterTransactionsExecute

afterTransactionsExecute(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
Overrides BaseModule.afterTransactionsExecute
- Defined in framework/src/modules/poa/module.ts:142

`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 BaseModule.baseMetadata
- Defined in framework/src/modules/base_module.ts:94

`Optional` beforeCommandExecute

beforeCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Inherited from BaseModule.beforeCommandExecute
- Defined in framework/src/modules/base_module.ts:85

`Optional` beforeTransactionsExecute

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

finalizeGenesisState

finalizeGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
Overrides BaseModule.finalizeGenesisState
- Defined in framework/src/modules/poa/module.ts:300

init

init(args: ModuleInitArgs): Promise<void>
Parameters
- args: ModuleInitArgs
Returns Promise<void>
Overrides BaseModule.init
- Defined in framework/src/modules/poa/module.ts:129

initGenesisState

initGenesisState(context: GenesisBlockExecuteContext): Promise<void>
Parameters
- context: GenesisBlockExecuteContext
Returns Promise<void>
Overrides BaseModule.initGenesisState
- Defined in framework/src/modules/poa/module.ts:187

`Optional` insertAssets

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

metadata

metadata(): ModuleMetadata
Returns ModuleMetadata
Overrides BaseModule.metadata
- Defined in framework/src/modules/poa/module.ts:106

`Optional` verifyAssets

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

`Optional` verifyTransaction

verifyTransaction(context: TransactionVerifyContext): Promise<VerificationResult>
Parameters
- context: TransactionVerifyContext
Returns Promise<VerificationResult>
Inherited from BaseModule.verifyTransaction
- Defined in framework/src/modules/base_module.ts:84

Class PoAModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PoAModule

Properties

Private _feeMethod

Private _moduleConfig

Private _randomMethod

Private Readonly _registerAuthorityCommand

Private Readonly _updateAuthorityCommand

Private Readonly _updateGeneratorKeyCommand

Private _validatorsMethod

commands

endpoint

events

method

offchainStores

stores

Accessors

name

Returns string

Methods

addDependencies

Parameters

validatorsMethod: ValidatorsMethod

feeMethod: FeeMethod

randomMethod: RandomMethod

Returns void

Optional afterCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

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; }[]

Optional beforeCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

Optional beforeTransactionsExecute

Parameters

context: BlockExecuteContext

Returns Promise<void>

finalizeGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

init

Parameters

args: ModuleInitArgs

Returns Promise<void>

initGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

Optional insertAssets

Parameters

context: InsertAssetContext

Returns Promise<void>

metadata

Returns ModuleMetadata

Optional verifyAssets

Parameters

context: BlockVerifyContext

Returns Promise<void>

Optional verifyTransaction

`Private` _feeMethod

`Private` _moduleConfig

`Private` _randomMethod

`Private` `Readonly` _registerAuthorityCommand

`Private` `Readonly` _updateAuthorityCommand

`Private` `Readonly` _updateGeneratorKeyCommand

`Private` _validatorsMethod

`Optional` afterCommandExecute

`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` beforeCommandExecute

`Optional` beforeTransactionsExecute

`Optional` insertAssets

`Optional` verifyAssets

`Optional` verifyTransaction