Class ValidatorsMethod

The BaseMethod provides a generic interface for module methods.

Hierarchy

BaseMethod
- ValidatorsMethod

Index

Constructors

constructor

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

Properties

`Private` _blockTime

_blockTime: number

`Protected` events

events: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

`Private` _validateLengths

_validateLengths(args: ValidatorArgs): void
Parameters
- args: ValidatorArgs
Returns void
- Defined in framework/src/modules/validators/method.ts:355

getAddressFromBLSKey

getAddressFromBLSKey(methodContext: MethodContext, blsKey: Buffer): Promise<ValidatorAddress>
Parameters
- methodContext: MethodContext
- blsKey: Buffer
Returns Promise<ValidatorAddress>
- Defined in framework/src/modules/validators/method.ts:142

getGeneratorsBetweenTimestamps

getGeneratorsBetweenTimestamps(methodContext: ImmutableMethodContext, startTimestamp: number, endTimestamp: number): Promise<Record<string, number>>
Parameters
- methodContext: ImmutableMethodContext
- startTimestamp: number
- endTimestamp: number
Returns Promise<Record<string, number>>
- Defined in framework/src/modules/validators/method.ts:274

getValidatorKeys

getValidatorKeys(methodContext: ImmutableMethodContext, address: Buffer): Promise<ValidatorKeys>
Parameters
- methodContext: ImmutableMethodContext
- address: Buffer
Returns Promise<ValidatorKeys>
- Defined in framework/src/modules/validators/method.ts:160

getValidatorsParams

getValidatorsParams(methodContext: ImmutableMethodContext): Promise<ValidatorsParams>
Parameters
- methodContext: ImmutableMethodContext
Returns Promise<ValidatorsParams>
- Defined in framework/src/modules/validators/method.ts:324

init

init(args: MethodInitArgs): void
Parameters
- args: MethodInitArgs
Returns void
- Defined in framework/src/modules/validators/method.ts:45

isKeyRegistered

isKeyRegistered(methodContext: ImmutableMethodContext, blsKey: Buffer): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- blsKey: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/validators/method.ts:266

registerValidatorKeys

registerValidatorKeys(methodContext: MethodContext, validatorAddress: Buffer, blsKey: Buffer, generatorKey: Buffer, proofOfPossession: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- validatorAddress: Buffer
- blsKey: Buffer
- generatorKey: Buffer
- proofOfPossession: Buffer
Returns Promise<void>
- Defined in framework/src/modules/validators/method.ts:49

registerValidatorWithoutBLSKey

registerValidatorWithoutBLSKey(methodContext: MethodContext, validatorAddress: Buffer, generatorKey: Buffer): Promise<boolean>
Parameters
- methodContext: MethodContext
- validatorAddress: Buffer
- generatorKey: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/validators/method.ts:108

setValidatorBLSKey

setValidatorBLSKey(methodContext: MethodContext, validatorAddress: Buffer, blsKey: Buffer, proofOfPossession: Buffer): Promise<boolean>
Parameters
- methodContext: MethodContext
- validatorAddress: Buffer
- blsKey: Buffer
- proofOfPossession: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/validators/method.ts:175

setValidatorGeneratorKey

setValidatorGeneratorKey(methodContext: MethodContext, validatorAddress: Buffer, generatorKey: Buffer): Promise<boolean>
Parameters
- methodContext: MethodContext
- validatorAddress: Buffer
- generatorKey: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/validators/method.ts:236

setValidatorsParams

setValidatorsParams(methodContext: MethodContext, validatorSetter: NextValidatorsSetter, preCommitThreshold: bigint, certificateThreshold: bigint, validators: Pick<Validator, "address" | "bftWeight">[]): Promise<void>
Parameters
- methodContext: MethodContext
- validatorSetter: NextValidatorsSetter
- preCommitThreshold: bigint
- certificateThreshold: bigint
- validators: Pick<Validator, "address" | "bftWeight">[]
Returns Promise<void>
- Defined in framework/src/modules/validators/method.ts:330

Class ValidatorsMethod

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

Returns ValidatorsMethod

Properties

Private _blockTime

Protected events

Protected stores

Methods

Private _validateLengths

Parameters

args: ValidatorArgs

Returns void

getAddressFromBLSKey

Parameters

methodContext: MethodContext

blsKey: Buffer

Returns Promise<ValidatorAddress>

getGeneratorsBetweenTimestamps

Parameters

methodContext: ImmutableMethodContext

startTimestamp: number

endTimestamp: number

Returns Promise<Record<string, number>>

getValidatorKeys

Parameters

methodContext: ImmutableMethodContext

address: Buffer

Returns Promise<ValidatorKeys>

getValidatorsParams

Parameters

methodContext: ImmutableMethodContext

Returns Promise<ValidatorsParams>

init

Parameters

args: MethodInitArgs

Returns void

isKeyRegistered

Parameters

methodContext: ImmutableMethodContext

blsKey: Buffer

Returns Promise<boolean>

registerValidatorKeys

Parameters

methodContext: MethodContext

validatorAddress: Buffer

blsKey: Buffer

generatorKey: Buffer

proofOfPossession: Buffer

Returns Promise<void>

registerValidatorWithoutBLSKey

Parameters

methodContext: MethodContext

validatorAddress: Buffer

generatorKey: Buffer

Returns Promise<boolean>

setValidatorBLSKey

Parameters

methodContext: MethodContext

validatorAddress: Buffer

blsKey: Buffer

proofOfPossession: Buffer

Returns Promise<boolean>

setValidatorGeneratorKey

Parameters

methodContext: MethodContext

validatorAddress: Buffer

generatorKey: Buffer

Returns Promise<boolean>

setValidatorsParams

Parameters

methodContext: MethodContext

`Private` _blockTime

`Protected` events

`Protected` stores

`Private` _validateLengths