Class PoSModule

Hierarchy

BaseModule
- PoSModule

Constructors

constructor

new PoSModule(): PoSModule
Returns PoSModule
Overrides BaseModule.constructor
- Defined in framework/src/modules/pos/module.ts:136

Properties

`Private` `Readonly` _changeCommissionCommand

_changeCommissionCommand: ChangeCommissionCommand = ...

`Private` `Readonly` _claimRewardsCommand

_claimRewardsCommand: ClaimRewardsCommand = ...

`Private` _feeMethod

_feeMethod: FeeMethod

`Private` `Readonly` _internalMethod

_internalMethod: InternalMethod = ...

`Private` _moduleConfig

_moduleConfig: ModuleConfig

`Private` _randomMethod

_randomMethod: RandomMethod

`Private` `Readonly` _registerValidatorCommand

_registerValidatorCommand: ValidatorRegistrationCommand = ...

`Private` `Readonly` _reportMisbehaviorCommand

_reportMisbehaviorCommand: ReportMisbehaviorCommand = ...

`Private` `Readonly` _stakeCommand

_stakeCommand: StakeCommand = ...

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Private` `Readonly` _unlockCommand

_unlockCommand: UnlockCommand = ...

`Private` `Readonly` _updateGeneratorKeyCommand

_updateGeneratorKeyCommand: UpdateGeneratorKeyCommand = ...

`Private` _validatorsMethod

_validatorsMethod: ValidatorsMethod

commands

configSchema

configSchema: {
    $id: string;
    properties: {
        commissionIncreasePeriod: {
            format: string;
            type: string;
        };
        factorSelfStakes: {
            format: string;
            type: string;
        };
        failSafeInactiveWindow: {
            format: string;
            type: string;
        };
        failSafeMissedBlocks: {
            format: string;
            type: string;
        };
        maxBFTWeightCap: {
            format: string;
            maximum: number;
            minimum: number;
            type: string;
        };
        maxCommissionIncreaseRate: {
            format: string;
            type: string;
        };
        maxLengthName: {
            format: string;
            type: string;
        };
        maxNumberPendingUnlocks: {
            format: string;
            type: string;
        };
        maxNumberSentStakes: {
            format: string;
            type: string;
        };
        minWeightStandby: {
            format: string;
            type: string;
        };
        numberActiveValidators: {
            format: string;
            type: string;
        };
        numberStandbyValidators: {
            format: string;
            type: string;
        };
        posTokenID: {
            format: string;
            type: string;
        };
        punishmentWindow: {
            format: string;
            type: string;
        };
        roundLength: {
            format: string;
            type: string;
        };
        useInvalidBLSKey: {
            type: string;
        };
        validatorRegistrationFee: {
            format: string;
            type: string;
        };
    };
    required: string[];
    type: string;
} = configSchema

Type declaration

$id: string
properties: {
    commissionIncreasePeriod: {
        format: string;
        type: string;
    };
    factorSelfStakes: {
        format: string;
        type: string;
    };
    failSafeInactiveWindow: {
        format: string;
        type: string;
    };
    failSafeMissedBlocks: {
        format: string;
        type: string;
    };
    maxBFTWeightCap: {
        format: string;
        maximum: number;
        minimum: number;
        type: string;
    };
    maxCommissionIncreaseRate: {
        format: string;
        type: string;
    };
    maxLengthName: {
        format: string;
        type: string;
    };
    maxNumberPendingUnlocks: {
        format: string;
        type: string;
    };
    maxNumberSentStakes: {
        format: string;
        type: string;
    };
    minWeightStandby: {
        format: string;
        type: string;
    };
    numberActiveValidators: {
        format: string;
        type: string;
    };
    numberStandbyValidators: {
        format: string;
        type: string;
    };
    posTokenID: {
        format: string;
        type: string;
    };
    punishmentWindow: {
        format: string;
        type: string;
    };
    roundLength: {
        format: string;
        type: string;
    };
    useInvalidBLSKey: {
        type: string;
    };
    validatorRegistrationFee: {
        format: string;
        type: string;
    };
}
- commissionIncreasePeriod: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- factorSelfStakes: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- failSafeInactiveWindow: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- failSafeMissedBlocks: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- maxBFTWeightCap: {
      format: string;
      maximum: number;
      minimum: number;
      type: string;
  }
  - format: string
  - maximum: number
  - minimum: number
  - type: string
- maxCommissionIncreaseRate: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- maxLengthName: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- maxNumberPendingUnlocks: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- maxNumberSentStakes: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- minWeightStandby: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- numberActiveValidators: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- numberStandbyValidators: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- posTokenID: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- punishmentWindow: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- roundLength: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
- useInvalidBLSKey: {
  type: string;
  }
  - type: string
- validatorRegistrationFee: {
  format: string;
  type: string;
  }
  - format: string
  - type: string
required: string[]
type: string

endpoint

endpoint: PoSEndpoint = ...

events

events: NamedRegistry = ...

method

method: PoSMethod = ...

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

Accessors

name

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

Methods

`Private` _capWeight

_capWeight(validators: ValidatorWeight[], capValue: number): ValidatorWeight[]
Parameters
- validators: ValidatorWeight[]
- capValue: number
Returns ValidatorWeight[]
- Defined in framework/src/modules/pos/module.ts:816

`Private` _capWeightIfNeeded

_capWeightIfNeeded(activeValidators: ValidatorWeight[]): ValidatorWeight[]
Parameters
- activeValidators: ValidatorWeight[]
Returns ValidatorWeight[]
- Defined in framework/src/modules/pos/module.ts:806

`Private` _ceiling

_ceiling(x: bigint, y: bigint): bigint
Parameters
- x: bigint
- y: bigint
Returns bigint
- Defined in framework/src/modules/pos/module.ts:839

`Private` _createStakeWeightSnapshot

_createStakeWeightSnapshot(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/pos/module.ts:576

`Private` _didBootstrapRoundsEnd

_didBootstrapRoundsEnd(context: BlockAfterExecuteContext): Promise<boolean>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<boolean>
- Defined in framework/src/modules/pos/module.ts:737

`Private` _getActiveValidators

_getActiveValidators(context: BlockAfterExecuteContext, snapshotValidators: {
address: Buffer;
weight: bigint;
}[], round: number): Promise<ValidatorWeight[]>
Parameters
- context: BlockAfterExecuteContext
- snapshotValidators: {
  address: Buffer;
  weight: bigint;
  }[]
- round: number
Returns Promise<ValidatorWeight[]>
- Defined in framework/src/modules/pos/module.ts:752

`Private` _updateProductivity

_updateProductivity(context: BlockAfterExecuteContext, previousTimestamp: number): Promise<void>
Parameters
- context: BlockAfterExecuteContext
- previousTimestamp: number
Returns Promise<void>
- Defined in framework/src/modules/pos/module.ts:691

`Private` _updateValidators

_updateValidators(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
- Defined in framework/src/modules/pos/module.ts:617

addDependencies

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

`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:83

afterTransactionsExecute

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

`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:91

`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:82

`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:86

finalizeGenesisState

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

init

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

initGenesisState

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

`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:79

metadata

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

`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:80

`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:81

Class PoSModule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PoSModule

Properties

Private Readonly _changeCommissionCommand

Private Readonly _claimRewardsCommand

Private _feeMethod

Private Readonly _internalMethod

Private _moduleConfig

Private _randomMethod

Private Readonly _registerValidatorCommand

Private Readonly _reportMisbehaviorCommand

Private Readonly _stakeCommand

Private _tokenMethod

Private Readonly _unlockCommand

Private Readonly _updateGeneratorKeyCommand

Private _validatorsMethod

commands

configSchema

Type declaration

$id: string

commissionIncreasePeriod: { format: string; type: string; }

format: string

type: string

factorSelfStakes: { format: string; type: string; }

format: string

type: string

failSafeInactiveWindow: { format: string; type: string; }

format: string

type: string

failSafeMissedBlocks: { format: string; type: string; }

format: string

type: string

maxBFTWeightCap: { format: string; maximum: number; minimum: number; type: string; }

format: string

maximum: number

minimum: number

type: string

maxCommissionIncreaseRate: { format: string; type: string; }

format: string

type: string

maxLengthName: { format: string; type: string; }

format: string

type: string

maxNumberPendingUnlocks: { format: string; type: string; }

format: string

type: string

maxNumberSentStakes: { format: string; type: string; }

format: string

type: string

minWeightStandby: { format: string; type: string; }

format: string

type: string

numberActiveValidators: { format: string; type: string; }

format: string

type: string

numberStandbyValidators: { format: string; type: string; }

format: string

type: string

posTokenID: { format: string; type: string; }

format: string

type: string

punishmentWindow: { format: string; type: string; }

format: string

type: string

roundLength: { format: string; type: string; }

format: string

type: string

useInvalidBLSKey: { type: string; }

type: string

validatorRegistrationFee: { format: string; type: string; }

format: string

type: string

`Private` `Readonly` _changeCommissionCommand

`Private` `Readonly` _claimRewardsCommand

`Private` _feeMethod

`Private` `Readonly` _internalMethod

`Private` _moduleConfig

`Private` _randomMethod

`Private` `Readonly` _registerValidatorCommand

`Private` `Readonly` _reportMisbehaviorCommand

`Private` `Readonly` _stakeCommand

`Private` _tokenMethod

`Private` `Readonly` _unlockCommand

`Private` `Readonly` _updateGeneratorKeyCommand

`Private` _validatorsMethod

commissionIncreasePeriod: {
format: string;
type: string;
}

factorSelfStakes: {
format: string;
type: string;
}

failSafeInactiveWindow: {
format: string;
type: string;
}

failSafeMissedBlocks: {
format: string;
type: string;
}

maxBFTWeightCap: {
format: string;
maximum: number;
minimum: number;
type: string;
}

maxCommissionIncreaseRate: {
format: string;
type: string;
}

maxLengthName: {
format: string;
type: string;
}

maxNumberPendingUnlocks: {
format: string;
type: string;
}

maxNumberSentStakes: {
format: string;
type: string;
}

minWeightStandby: {
format: string;
type: string;
}

numberActiveValidators: {
format: string;
type: string;
}

numberStandbyValidators: {
format: string;
type: string;
}

posTokenID: {
format: string;
type: string;
}

punishmentWindow: {
format: string;
type: string;
}

roundLength: {
format: string;
type: string;
}

useInvalidBLSKey: {
type: string;
}

validatorRegistrationFee: {
format: string;
type: string;
}

`Private` _capWeight

`Private` _capWeightIfNeeded

`Private` _ceiling

`Private` _createStakeWeightSnapshot

`Private` _didBootstrapRoundsEnd

`Private` _getActiveValidators

snapshotValidators: {
address: Buffer;
weight: bigint;
}[]

`Private` _updateProductivity

`Private` _updateValidators

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