Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Unit test review: Dynamic block rewards #9104

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Unit test review: Dynamic block rewards #9104

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8342087
Update unit tests
Incede Oct 19, 2023
ab53fed
Cleanup leftover comments
Incede Oct 19, 2023
8e1c5a0
Merge branch 'release/6.1.0' into 8025-unit-test
shuse2 Oct 31, 2023
8db170d
Merge branch 'release/6.1.0' into 8025-unit-test
shuse2 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 100 additions & 78 deletions framework/test/unit/modules/dynamic_rewards/module.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,21 @@ describe('DynamicRewardModule', () => {
let randomMethod: RandomMethod;
let validatorsMethod: ValidatorsMethod;
let posMethod: PoSMethod;
let generatorAddress: Buffer;
let standbyValidatorAddress: Buffer;
let stateStore: PrefixedStateReadWriter;
let blockHeader: BlockHeader;

const activeValidator = 4;
const minimumReward =
(BigInt(defaultConfig.brackets[0]) *
BigInt(defaultConfig.factorMinimumRewardActiveValidators)) /
DECIMAL_PERCENT_FACTOR;
const totalRewardActiveValidator = BigInt(defaultConfig.brackets[0]) * BigInt(activeValidator);
const stakeRewardActiveValidators =
totalRewardActiveValidator - minimumReward * BigInt(activeValidator);
// generatorAddress has 20% of total weight, bftWeightSum/bftWeight = BigInt(5)
const defaultReward = minimumReward + stakeRewardActiveValidators / BigInt(5);

beforeEach(async () => {
rewardModule = new DynamicRewardModule();
Expand Down Expand Up @@ -126,9 +141,7 @@ describe('DynamicRewardModule', () => {
});

describe('initGenesisState', () => {
let blockHeader: BlockHeader;
let blockExecuteContext: GenesisBlockExecuteContext;
let stateStore: PrefixedStateReadWriter;

beforeEach(() => {
stateStore = new PrefixedStateReadWriter(new InMemoryPrefixedStateDB());
Expand All @@ -151,23 +164,12 @@ describe('DynamicRewardModule', () => {

describe('beforeTransactionsExecute', () => {
let blockExecuteContext: BlockExecuteContext;
let generatorAddress: Buffer;
let standbyValidatorAddress: Buffer;
let stateStore: PrefixedStateReadWriter;

const activeValidator = 4;
const minimumReward =
(BigInt(defaultConfig.brackets[0]) *
BigInt(defaultConfig.factorMinimumRewardActiveValidators)) /
DECIMAL_PERCENT_FACTOR;
const totalRewardActiveValidator = BigInt(defaultConfig.brackets[0]) * BigInt(activeValidator);
const ratioReward = totalRewardActiveValidator - minimumReward * BigInt(activeValidator);

beforeEach(async () => {
generatorAddress = utils.getRandomBytes(20);
standbyValidatorAddress = utils.getRandomBytes(20);
stateStore = new PrefixedStateReadWriter(new InMemoryPrefixedStateDB());
const blockHeader = createBlockHeaderWithDefaults({
blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
generatorAddress,
});
Expand Down Expand Up @@ -224,9 +226,8 @@ describe('DynamicRewardModule', () => {

await rewardModule.beforeTransactionsExecute(blockExecuteContext);

// generatorAddress has 20% of total weight
expect(blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REWARD)).toEqual(
minimumReward + ratioReward / BigInt(5),
defaultReward,
);
expect(
blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REDUCTION),
Expand All @@ -244,7 +245,7 @@ describe('DynamicRewardModule', () => {
generatorMap,
);

const blockHeader = createBlockHeaderWithDefaults({
blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
generatorAddress: standbyValidatorAddress,
});
Expand All @@ -262,32 +263,72 @@ describe('DynamicRewardModule', () => {
blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REDUCTION),
).toEqual(REWARD_NO_REDUCTION);
});

it('should store zero reward with seed reveal reduction when seed reveal is invalid', async () => {
// Round not finished
const generatorMap = new Array(1).fill(0).reduce(prev => {
// eslint-disable-next-line no-param-reassign
prev[utils.getRandomBytes(20).toString('binary')] = 1;
return prev;
}, {});
(validatorsMethod.getGeneratorsBetweenTimestamps as jest.Mock).mockResolvedValue(
generatorMap,
);
(randomMethod.isSeedRevealValid as jest.Mock).mockResolvedValue(false);

await rewardModule.beforeTransactionsExecute(blockExecuteContext);

expect(blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REWARD)).toEqual(
BigInt(0),
);
expect(
blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REDUCTION),
).toEqual(REWARD_REDUCTION_SEED_REVEAL);
});

it('should return quarter deducted reward when header does not imply max prevotes', async () => {
// Round not finished
const generatorMap = new Array(1).fill(0).reduce(prev => {
// eslint-disable-next-line no-param-reassign
prev[utils.getRandomBytes(20).toString('binary')] = 1;
return prev;
}, {});
(validatorsMethod.getGeneratorsBetweenTimestamps as jest.Mock).mockResolvedValue(
generatorMap,
);
blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
impliesMaxPrevotes: false,
generatorAddress,
});
blockExecuteContext = createBlockContext({
stateStore,
header: blockHeader,
}).getBlockAfterExecuteContext();

await rewardModule.beforeTransactionsExecute(blockExecuteContext);

expect(blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REWARD)).toEqual(
defaultReward / BigInt(4),
);
expect(
blockExecuteContext.contextStore.get(CONTEXT_STORE_KEY_DYNAMIC_BLOCK_REDUCTION),
).toEqual(REWARD_REDUCTION_MAX_PREVOTES);
});
});

describe('afterTransactionsExecute', () => {
let blockExecuteContext: BlockAfterExecuteContext;
let stateStore: PrefixedStateReadWriter;
let generatorAddress: Buffer;
let standbyValidatorAddress: Buffer;
let contextStore: Map<string, unknown>;

const activeValidator = 4;
const minimumReward =
(BigInt(defaultConfig.brackets[0]) *
BigInt(defaultConfig.factorMinimumRewardActiveValidators)) /
DECIMAL_PERCENT_FACTOR;
const totalRewardActiveValidator = BigInt(defaultConfig.brackets[0]) * BigInt(activeValidator);
const ratioReward = totalRewardActiveValidator - minimumReward * BigInt(activeValidator);
const defaultReward = minimumReward + ratioReward / BigInt(5);

beforeEach(async () => {
jest.spyOn(rewardModule.events.get(RewardMintedEvent), 'log');
jest.spyOn(tokenMethod, 'userSubstoreExists');
generatorAddress = utils.getRandomBytes(20);
standbyValidatorAddress = utils.getRandomBytes(20);
contextStore = new Map<string, unknown>();
stateStore = new PrefixedStateReadWriter(new InMemoryPrefixedStateDB());
const blockHeader = createBlockHeaderWithDefaults({
blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
generatorAddress,
});
Expand Down Expand Up @@ -326,50 +367,6 @@ describe('DynamicRewardModule', () => {
.mockResolvedValue(true as never);
});

it('should return zero reward with seed reveal reduction when seed reveal is invalid', async () => {
(randomMethod.isSeedRevealValid as jest.Mock).mockResolvedValue(false);
await rewardModule.beforeTransactionsExecute(blockExecuteContext);
await rewardModule.afterTransactionsExecute(blockExecuteContext);

expect(rewardModule.events.get(RewardMintedEvent).log).toHaveBeenCalledWith(
expect.anything(),
blockExecuteContext.header.generatorAddress,
{ amount: BigInt(0), reduction: REWARD_REDUCTION_SEED_REVEAL },
);
});

it('should return quarter deducted reward when header does not imply max prevotes', async () => {
const blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
impliesMaxPrevotes: false,
generatorAddress,
});
blockExecuteContext = createBlockContext({
stateStore,
contextStore,
header: blockHeader,
}).getBlockAfterExecuteContext();
when(tokenMethod.userSubstoreExists)
.calledWith(
expect.anything(),
blockExecuteContext.header.generatorAddress,
rewardModule['_moduleConfig'].tokenID,
)
.mockResolvedValue(true as never);

await rewardModule.beforeTransactionsExecute(blockExecuteContext);
await rewardModule.afterTransactionsExecute(blockExecuteContext);

expect(rewardModule.events.get(RewardMintedEvent).log).toHaveBeenCalledWith(
expect.anything(),
blockExecuteContext.header.generatorAddress,
{
amount: defaultReward / BigInt(4),
reduction: REWARD_REDUCTION_MAX_PREVOTES,
},
);
});

it('should return full reward when header and assets are valid', async () => {
await rewardModule.beforeTransactionsExecute(blockExecuteContext);
await rewardModule.afterTransactionsExecute(blockExecuteContext);
Expand All @@ -381,7 +378,7 @@ describe('DynamicRewardModule', () => {
);
});

it('should mint the token and update shared reward when reward is non zero and user account of geenrator exists for the token id', async () => {
it('should mint the token and update shared reward when reward is non zero and user account of generator exists for the token id', async () => {
await rewardModule.beforeTransactionsExecute(blockExecuteContext);
await rewardModule.afterTransactionsExecute(blockExecuteContext);

Expand All @@ -405,7 +402,7 @@ describe('DynamicRewardModule', () => {
);
});

it('should not mint or update shared reward and return zero reward with no account reduction when reward is non zero and user account of geenrator does not exist for the token id', async () => {
it('should not mint or update shared reward and return zero reward with no account reduction when reward is non zero and user account of generator does not exist for the token id', async () => {
when(tokenMethod.userSubstoreExists)
.calledWith(
expect.anything(),
Expand Down Expand Up @@ -441,9 +438,9 @@ describe('DynamicRewardModule', () => {
expect(posMethod.updateSharedRewards).not.toHaveBeenCalled();
});

it('should store timestamp when end of round', async () => {
it('should store timestamp when it is end of round', async () => {
const timestamp = 123456789;
const blockHeader = createBlockHeaderWithDefaults({
blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
timestamp,
generatorAddress,
Expand All @@ -465,5 +462,30 @@ describe('DynamicRewardModule', () => {

expect(updatedTimestamp).toEqual(timestamp);
});

it('should store timestamp when it is not end of round', async () => {
const timestamp = 123456789;
blockHeader = createBlockHeaderWithDefaults({
height: defaultConfig.offset,
timestamp,
generatorAddress,
});
blockExecuteContext = createBlockContext({
stateStore,
contextStore,
header: blockHeader,
}).getBlockAfterExecuteContext();

(posMethod.isEndOfRound as jest.Mock).mockResolvedValue(false);

await rewardModule.beforeTransactionsExecute(blockExecuteContext);
await rewardModule.afterTransactionsExecute(blockExecuteContext);

const { timestamp: updatedTimestamp } = await rewardModule.stores
.get(EndOfRoundTimestampStore)
.get(blockExecuteContext, EMPTY_BYTES);

expect(updatedTimestamp).not.toEqual(timestamp);
});
});
});