Class ForgerPlugin

Hierarchy

BasePlugin
- ForgerPlugin

Constructors

constructor

new ForgerPlugin(): ForgerPlugin
Returns ForgerPlugin

Inherited from BasePlugin.constructor

Properties

`Private` _forgerPluginDB

_forgerPluginDB: Database

`Private` _forgersList

_forgersList: BufferMap<boolean>

`Optional` `Readonly` configSchema

configSchema?: SchemaWithDefault

endpoint

endpoint: Endpoint = ...

`Protected` logger

logger: Logger

Accessors

apiClient

get apiClient(): APIClient
Returns APIClient
Inherited from BasePlugin.apiClient
- Defined in framework/dist-node/plugins/base_plugin.d.ts:24

appConfig

get appConfig(): ApplicationConfigForPlugin
Returns ApplicationConfigForPlugin
Inherited from BasePlugin.appConfig
- Defined in framework/dist-node/plugins/base_plugin.d.ts:21

config

get config(): T
Returns T
Inherited from BasePlugin.config
- Defined in framework/dist-node/plugins/base_plugin.d.ts:20

dataPath

get dataPath(): string
Returns string
Inherited from BasePlugin.dataPath
- Defined in framework/dist-node/plugins/base_plugin.d.ts:22

events

get events(): string[]
Returns string[]
Overrides BasePlugin.events
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:91

name

get name(): string
Returns string
Inherited from BasePlugin.name
- Defined in framework/dist-node/plugins/base_plugin.d.ts:19

nodeModulePath

get nodeModulePath(): string
Returns string
Overrides BasePlugin.nodeModulePath
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:87

Methods

`Private` _addForgerInfo

_addForgerInfo(header: {
    aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; };
    assetRoot?: string;
    eventRoot?: string;
    generatorAddress: string;
    height: number;
    id?: string;
    impliesMaxPrevotes: boolean;
    maxHeightGenerated: number;
    maxHeightPrevoted: number;
    previousBlockID: string;
    signature?: string;
    stateRoot?: string;
    timestamp: number;
    transactionRoot?: string;
    validatorsHash?: string;
    version: number;
}, forgerTransactionsInfo: ForgerTransactionsInfo): Promise<void>
Parameters
- header: {
      aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; };
      assetRoot?: string;
      eventRoot?: string;
      generatorAddress: string;
      height: number;
      id?: string;
      impliesMaxPrevotes: boolean;
      maxHeightGenerated: number;
      maxHeightPrevoted: number;
      previousBlockID: string;
      signature?: string;
      stateRoot?: string;
      timestamp: number;
      transactionRoot?: string;
      validatorsHash?: string;
      version: number;
  }
  - Readonly aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }
  - Optional Readonly assetRoot?: string
  - Optional Readonly eventRoot?: string
  - Readonly generatorAddress: string
  - Readonly height: number
  - Optional id?: string
  - Readonly impliesMaxPrevotes: boolean
  - Readonly maxHeightGenerated: number
  - Readonly maxHeightPrevoted: number
  - Readonly previousBlockID: string
  - Optional signature?: string
  - Optional Readonly stateRoot?: string
  - Readonly timestamp: number
  - Optional Readonly transactionRoot?: string
  - Optional Readonly validatorsHash?: string
  - Readonly version: number
- forgerTransactionsInfo: ForgerTransactionsInfo
Returns Promise<void>
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:243

`Private` _addStakesReceived

_addStakesReceived(transactions: readonly TransactionJSON[]): Promise<void>
Parameters
- transactions: readonly TransactionJSON[]
Returns Promise<void>
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:316

`Private` _getFee

_getFee(transactions: readonly TransactionJSON[]): bigint
Parameters
- transactions: readonly TransactionJSON[]
Returns bigint
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:364

`Private` _getForgerHeaderAndTransactionsInfo

_getForgerHeaderAndTransactionsInfo(header: {
    aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; };
    assetRoot?: string;
    eventRoot?: string;
    generatorAddress: string;
    height: number;
    id?: string;
    impliesMaxPrevotes: boolean;
    maxHeightGenerated: number;
    maxHeightPrevoted: number;
    previousBlockID: string;
    signature?: string;
    stateRoot?: string;
    timestamp: number;
    transactionRoot?: string;
    validatorsHash?: string;
    version: number;
}, transactions: TransactionJSON[]): ForgerTransactionsInfo
Parameters
- header: {
      aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; };
      assetRoot?: string;
      eventRoot?: string;
      generatorAddress: string;
      height: number;
      id?: string;
      impliesMaxPrevotes: boolean;
      maxHeightGenerated: number;
      maxHeightPrevoted: number;
      previousBlockID: string;
      signature?: string;
      stateRoot?: string;
      timestamp: number;
      transactionRoot?: string;
      validatorsHash?: string;
      version: number;
  }
  - Readonly aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }
  - Optional Readonly assetRoot?: string
  - Optional Readonly eventRoot?: string
  - Readonly generatorAddress: string
  - Readonly height: number
  - Optional id?: string
  - Readonly impliesMaxPrevotes: boolean
  - Readonly maxHeightGenerated: number
  - Readonly maxHeightPrevoted: number
  - Readonly previousBlockID: string
  - Optional signature?: string
  - Optional Readonly stateRoot?: string
  - Readonly timestamp: number
  - Optional Readonly transactionRoot?: string
  - Optional Readonly validatorsHash?: string
  - Readonly version: number
- transactions: TransactionJSON[]
Returns ForgerTransactionsInfo
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:128

`Private` _getForgerReceivedStakes

_getForgerReceivedStakes(transactions: readonly TransactionJSON[]): ForgerReceivedStakes
Parameters
- transactions: readonly TransactionJSON[]
Returns ForgerReceivedStakes
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:274

`Private` _revertForgerInfo

_revertForgerInfo(forgerTransactionsInfo: ForgerTransactionsInfo): Promise<void>
Parameters
- forgerTransactionsInfo: ForgerTransactionsInfo
Returns Promise<void>
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:261

`Private` _revertStakesReceived

_revertStakesReceived(transactions: readonly TransactionJSON[]): Promise<void>
Parameters
- transactions: readonly TransactionJSON[]
Returns Promise<void>
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:341

`Private` _updateMissedBlock

_updateMissedBlock(header: {
    aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; };
    assetRoot?: string;
    eventRoot?: string;
    generatorAddress: string;
    height: number;
    id?: string;
    impliesMaxPrevotes: boolean;
    maxHeightGenerated: number;
    maxHeightPrevoted: number;
    previousBlockID: string;
    signature?: string;
    stateRoot?: string;
    timestamp: number;
    transactionRoot?: string;
    validatorsHash?: string;
    version: number;
}, transactions: TransactionJSON[]): Promise<void>
Parameters
- header: {
      aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; };
      assetRoot?: string;
      eventRoot?: string;
      generatorAddress: string;
      height: number;
      id?: string;
      impliesMaxPrevotes: boolean;
      maxHeightGenerated: number;
      maxHeightPrevoted: number;
      previousBlockID: string;
      signature?: string;
      stateRoot?: string;
      timestamp: number;
      transactionRoot?: string;
      validatorsHash?: string;
      version: number;
  }
  - Readonly aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }
  - Optional Readonly assetRoot?: string
  - Optional Readonly eventRoot?: string
  - Readonly generatorAddress: string
  - Readonly height: number
  - Optional id?: string
  - Readonly impliesMaxPrevotes: boolean
  - Readonly maxHeightGenerated: number
  - Readonly maxHeightPrevoted: number
  - Readonly previousBlockID: string
  - Optional signature?: string
  - Optional Readonly stateRoot?: string
  - Readonly timestamp: number
  - Optional Readonly transactionRoot?: string
  - Optional Readonly validatorsHash?: string
  - Readonly version: number
- transactions: TransactionJSON[]
Returns Promise<void>
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:375

init

init(context: PluginInitContext<Record<string, unknown>>): Promise<void>
Parameters
- context: PluginInitContext<Record<string, unknown>>
Returns Promise<void>
Overrides BasePlugin.init
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:95

load

load(): Promise<void>
Returns Promise<void>
Overrides BasePlugin.load
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:101

unload

unload(): Promise<void>
Returns Promise<void>
Overrides BasePlugin.unload
- Defined in framework-plugins/lisk-framework-forger-plugin/src/forger_plugin.ts:116

Class ForgerPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ForgerPlugin

Properties

Private _forgerPluginDB

Private _forgersList

Optional Readonly configSchema

endpoint

Protected logger

Accessors

apiClient

Returns APIClient

appConfig

Returns ApplicationConfigForPlugin

config

Returns T

dataPath

Returns string

events

Returns string[]

name

Returns string

nodeModulePath

Returns string

Methods

Private _addForgerInfo

Parameters

Readonly aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }

Optional Readonly assetRoot?: string

Optional Readonly eventRoot?: string

Readonly generatorAddress: string

Readonly height: number

Optional id?: string

Readonly impliesMaxPrevotes: boolean

Readonly maxHeightGenerated: number

Readonly maxHeightPrevoted: number

Readonly previousBlockID: string

Optional signature?: string

Optional Readonly stateRoot?: string

Readonly timestamp: number

Optional Readonly transactionRoot?: string

Optional Readonly validatorsHash?: string

Readonly version: number

forgerTransactionsInfo: ForgerTransactionsInfo

Returns Promise<void>

Private _addStakesReceived

Parameters

transactions: readonly TransactionJSON[]

Returns Promise<void>

Private _getFee

Parameters

transactions: readonly TransactionJSON[]

Returns bigint

Private _getForgerHeaderAndTransactionsInfo

Parameters

Readonly aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }

Optional Readonly assetRoot?: string

Optional Readonly eventRoot?: string

Readonly generatorAddress: string

Readonly height: number

Optional id?: string

Readonly impliesMaxPrevotes: boolean

Readonly maxHeightGenerated: number

Readonly maxHeightPrevoted: number

Readonly previousBlockID: string

Optional signature?: string

Optional Readonly stateRoot?: string

Readonly timestamp: number

Optional Readonly transactionRoot?: string

Optional Readonly validatorsHash?: string

Readonly version: number

transactions: TransactionJSON[]

Returns ForgerTransactionsInfo

`Private` _forgerPluginDB

`Private` _forgersList

`Optional` `Readonly` configSchema

`Protected` logger

`Private` _addForgerInfo

`Readonly` aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }

`Optional` `Readonly` assetRoot?: string

`Optional` `Readonly` eventRoot?: string

`Readonly` generatorAddress: string

`Readonly` height: number

`Optional` id?: string

`Readonly` impliesMaxPrevotes: boolean

`Readonly` maxHeightGenerated: number

`Readonly` maxHeightPrevoted: number

`Readonly` previousBlockID: string

`Optional` signature?: string

`Optional` `Readonly` stateRoot?: string

`Readonly` timestamp: number

`Optional` `Readonly` transactionRoot?: string

`Optional` `Readonly` validatorsHash?: string

`Readonly` version: number

`Private` _addStakesReceived

`Private` _getFee

`Private` _getForgerHeaderAndTransactionsInfo

`Readonly` aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }

`Optional` `Readonly` assetRoot?: string

`Optional` `Readonly` eventRoot?: string

`Readonly` generatorAddress: string

`Readonly` height: number

`Optional` id?: string

`Readonly` impliesMaxPrevotes: boolean

`Readonly` maxHeightGenerated: number

`Readonly` maxHeightPrevoted: number

`Readonly` previousBlockID: string

`Optional` signature?: string

`Optional` `Readonly` stateRoot?: string

`Readonly` timestamp: number

`Optional` `Readonly` transactionRoot?: string

`Optional` `Readonly` validatorsHash?: string

`Readonly` version: number

`Private` _getForgerReceivedStakes

`Private` _revertForgerInfo

`Private` _revertStakesReceived

`Private` _setForgersList

`Private` _subscribeToChannel

`Private` _syncForgerInfo

`Private` _updateMissedBlock

`Readonly` aggregateCommit: { readonly height: number; readonly aggregationBits: string; readonly certificateSignature: string; }

`Optional` `Readonly` assetRoot?: string

`Optional` `Readonly` eventRoot?: string

`Readonly` generatorAddress: string

`Readonly` height: number

`Optional` id?: string

`Readonly` impliesMaxPrevotes: boolean

`Readonly` maxHeightGenerated: number

`Readonly` maxHeightPrevoted: number

`Readonly` previousBlockID: string

`Optional` signature?: string

`Optional` `Readonly` stateRoot?: string

`Readonly` timestamp: number

`Optional` `Readonly` transactionRoot?: string

`Optional` `Readonly` validatorsHash?: string

`Readonly` version: number