Class PoSMethod

The BaseMethod provides a generic interface for module methods.

Hierarchy

BaseMethod
- PoSMethod

Index

Constructors

Properties

_config _internalMethod _moduleName _tokenMethod events stores

Methods

getLockedStakedAmount getNumberOfActiveValidators getRoundLength getRoundNumberFromHeight getStaker getValidator init isEndOfRound isNameAvailable unbanValidator updateSharedRewards

Constructors

constructor

new PoSMethod(stores: NamedRegistry, events: NamedRegistry): PoSMethod
Parameters
- stores: NamedRegistry
- events: NamedRegistry
Returns PoSMethod
Inherited from BaseMethod.constructor
- Defined in framework/src/modules/base_method.ts:21

Properties

`Private` _config

_config: ModuleConfig

`Private` _internalMethod

_internalMethod: InternalMethod

`Private` _moduleName

_moduleName: string

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Protected` events

events: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

getLockedStakedAmount

getLockedStakedAmount(ctx: ImmutableMethodContext, address: Buffer): Promise<bigint>
Parameters
- ctx: ImmutableMethodContext
- address: Buffer
Returns Promise<bigint>
- Defined in framework/src/modules/pos/method.ts:180

getNumberOfActiveValidators

getNumberOfActiveValidators(_methodContext: ImmutableMethodContext): number
Parameters
- _methodContext: ImmutableMethodContext
Returns number
- Defined in framework/src/modules/pos/method.ts:86

getRoundLength

getRoundLength(_methodContext: ImmutableMethodContext): number
Parameters
- _methodContext: ImmutableMethodContext
Returns number
- Defined in framework/src/modules/pos/method.ts:82

getRoundNumberFromHeight

getRoundNumberFromHeight(methodContext: ImmutableMethodContext, height: number): Promise<number>
Parameters
- methodContext: ImmutableMethodContext
- height: number
Returns Promise<number>
- Defined in framework/src/modules/pos/method.ts:141

getStaker

getStaker(methodContext: ImmutableMethodContext, address: Buffer): Promise<StakerData>
Parameters
- methodContext: ImmutableMethodContext
- address: Buffer
Returns Promise<StakerData>
- Defined in framework/src/modules/pos/method.ts:62

getValidator

getValidator(methodContext: ImmutableMethodContext, address: Buffer): Promise<ValidatorAccount>
Parameters
- methodContext: ImmutableMethodContext
- address: Buffer
Returns Promise<ValidatorAccount>
- Defined in framework/src/modules/pos/method.ts:72

init

init(moduleName: string, config: ModuleConfig, internalMethod: InternalMethod, tokenMethod: TokenMethod): void
Parameters
- moduleName: string
- config: ModuleConfig
- internalMethod: InternalMethod
- tokenMethod: TokenMethod
Returns void
- Defined in framework/src/modules/pos/method.ts:34

isEndOfRound

isEndOfRound(methodContext: ImmutableMethodContext, height: number): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- height: number
Returns Promise<boolean>
- Defined in framework/src/modules/pos/method.ts:151

isNameAvailable

isNameAvailable(methodContext: ImmutableMethodContext, name: string): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- name: string
Returns Promise<boolean>
- Defined in framework/src/modules/pos/method.ts:45

unbanValidator

unbanValidator(methodContext: MethodContext, address: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
Returns Promise<void>
- Defined in framework/src/modules/pos/method.ts:161

updateSharedRewards

updateSharedRewards(context: MethodContext, generatorAddress: Buffer, tokenID: Buffer, reward: bigint): Promise<void>
Parameters
- context: MethodContext
- generatorAddress: Buffer
- tokenID: Buffer
- reward: bigint
Returns Promise<void>
- Defined in framework/src/modules/pos/method.ts:90

Generated using TypeDoc