Add missing configurable config params #8854
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## release/6.0.0 #8854 +/- ##
=================================================
+ Coverage 83.57% 83.59% +0.01%
=================================================
Files 601 601
Lines 22486 22521 +35
Branches 3322 3324 +2
=================================================
+ Hits 18793 18826 +33
- Misses 3693 3695 +2
|
| export const defaultConfig = { | ||
| minFeePerByte: 1000, | ||
| maxBlockHeightZeroFeePerByte: 0, | ||
| minFeePerByte: MIN_FEE_PER_BYTE, |
There was a problem hiding this comment.
I am not 100% sure those values are intended as part of default configuration, perhaps we should check this.
There was a problem hiding this comment.
I was following the specs. Let me know if they are outdated.
There was a problem hiding this comment.
Those are the mainchain values. Mainchain configuration is set in LIP 63. For sidechains built with SDK, I think the values should be given dynamically at creation time, same as TOKEN_ID_FEE. Using current status, we define minFee to a default value without knowing which token it corresponds to, whic is a bit funny.
There was a problem hiding this comment.
Those are just some default values because we need some meaningful defaults, which users are supposed to override with their custom config?
There was a problem hiding this comment.
@gkoumout you mean to force user to set this value in the config for the sidechain?
| lockingPeriodSelfStaking: number; | ||
| reportMisbehaviorReward: bigint; | ||
| reportMisbehaviorLimitBanned: number; | ||
| weightScaleFactor: bigint; | ||
| } | ||
|
|
There was a problem hiding this comment.
Comment about line 33: round length is not configurable anymore..
There was a problem hiding this comment.
Round Length is no longer a directly configurable param, but a derived param. It is calculated based on number of configured validators.
So it is still part of the config.
There was a problem hiding this comment.
ok sounds good, just wanted to make sure.
| export const defaultConfig = { | ||
| minFeePerByte: 1000, | ||
| maxBlockHeightZeroFeePerByte: 0, | ||
| minFeePerByte: MIN_FEE_PER_BYTE, |
There was a problem hiding this comment.
Those are the mainchain values. Mainchain configuration is set in LIP 63. For sidechains built with SDK, I think the values should be given dynamically at creation time, same as TOKEN_ID_FEE. Using current status, we define minFee to a default value without knowing which token it corresponds to, whic is a bit funny.
| lockingPeriodSelfStaking: number; | ||
| reportMisbehaviorReward: bigint; | ||
| reportMisbehaviorLimitBanned: number; | ||
| weightScaleFactor: bigint; | ||
| } | ||
|
|
There was a problem hiding this comment.
ok sounds good, just wanted to make sure.
| export const defaultConfig = { | ||
| minFeePerByte: 1000, | ||
| maxBlockHeightZeroFeePerByte: 0, | ||
| minFeePerByte: MIN_FEE_PER_BYTE, |
There was a problem hiding this comment.
@gkoumout you mean to force user to set this value in the config for the sidechain?
What was the problem?
This PR resolves #8753
How was it solved?
Replaced config literals with constants:
MAX_TRANSACTIONS_SIZEBFT_BATCH_SIZEFACTOR_MINIMUM_REWARD_ACTIVE_VALIDATORSMIN_FEE_PER_BYTEMAX_BLOCK_HEIGHT_ZERO_FEE_PER_BYTEFACTOR_SELF_STAKESFAIL_SAFE_MISSED_BLOCKSFAIL_SAFE_INACTIVE_WINDOWMAX_BFT_WEIGHT_CAPUSE_INVALID_BLS_KEYAdded a default value in
defaultConfigand updated code not to directly import the constant, but get it from config:NUMBER_ACTIVE_VALIDATORSNUMBER_STANDBY_VALIDATORSMAX_LENGTH_NAMEMAX_NUMBER_PENDING_UNLOCKSBASE_STAKE_AMOUNTLOCKING_PERIOD_SELF_STAKINGWEIGHT_SCALE_FACTORPUNISHMENT_PERIODPUNISHMENT_WINDOW_STAKINGPUNISHMENT_WINDOW_SELF_STAKINGLOCKING_PERIOD_SELF_STAKINGAdded as default value in
defaultConfig, added config property, and updated code not to directly import the constant, but get it from config:LOCKING_PERIOD_STAKINGREPORT_MISBEHAVIOR_REWARDREPORT_MISBEHAVIOR_LIMIT_BANNEDMAX_NUMBER_OF_SIGNATURESAdded comment about different name:
MAX_COMMISSION_INCREASE_RATERenamed constant and added a comment about different name:
MAX_LENGTH_REVEALSRenamed constant to align with LIP and property name:
USER_SUBSTORE_INITIALIZATION_FEE=>USER_ACCOUNT_INITIALIZATION_FEEESCROW_SUBSTORE_INITIALIZATION_FEE=>ESCROW_ACCOUNT_INITIALIZATION_FEETRANSACTION_MAX_PARAMS_SIZE=>MAX_PARAMS_SIZEUpdated constant value to match LIP:
MAX_ASSET_DATA_SIZE_BYTESUpdated PoS util functions to get param value from config as arguments, instead of importing constants.
isCurrentlyPunished()getWaitTime()getPunishTime()hasWaited()isPunished()getPunishmentPeriod()BONUS: Changed
factorSelfStakestonumberand removed all castings of it toBigInt😎How was it tested?
All tests pass 👌🏻
Example app runs 🏃🏻