[pox-4] Pool Stacking stateful property-based tests #4550

This commit lays the groundwork for the StackStxCommand and GetStackingMinimumCommand classes for PoX-4. It also proposes the introduction of fast-check based stateful tests, similar to the efforts for sBTC (stacks-network/sbtc#152). As highlighted in #4548, this initiative is part of an ongoing effort to embrace a more rigorous, property-based testing strategy for PoX-4 interactions. The planned stateful tests aim to simulate various stacking scenarios, ensuring compliance with PoX-4 protocols and robust error handling. This strategy is expected to greatly enhance test coverage and the reliability of PoX-4 stacking operations, bolstering confidence in the protocol’s robustness and correctness. Note: This is an early-stage WIP commit. Implementation details and testing strategies are subject to substantial development and refinement.

Revamps the PoX-4 testing suite by introducing wallet labels, aiming for more intelligible logging and easier identification of wallets in tests. This enhancement affects various commands and test setups, making debugging and test verification processes more straightforward. Includes updates to wallet structures and all related command implementations to utilize these labels in their logging outputs.

Simplifies the Wallet type and its usage in PoX-4 tests by removing the prvKey and pubKey fields. This change reflects an effort to simplify the data structures and focus on the essential elements needed for testing. The reduction in fields contributes to cleaner code and minimizes unnecessary data handling in the test setup and execution.

Improves code clarity by renaming the 'client' field in the Wallet type to 'stackingClient'. This change better specifies the purpose of the client as specifically for stacking operations within the PoX-4 testing framework. The update is applied across all instances where the field is referenced, ensuring consistency and enhancing readability.

Enhances type safety by changing the 'delegatedTo' field in the Wallet type from a generic string to a more specific StxAddress type. This modification aids in preventing potential bugs by ensuring the field is used consistently as an STX address across the PoX-4 testing suite. The adjustment promotes clearer code, and better alignment with the domain model.

Introduces `amountUnlocked` to the Wallet model in PoX-4 tests to clearly differentiate between locked and available balances. This addition complements the existing balance field, enhancing understanding of staking dynamics without renaming or removing existing structures. Adjustments made in related commands and tests ensure accuracy and consistency.

- Removes `Cl` and `cvToValue` imports and cycle utility functions from `pox-4.stateful-prop.test.ts`, streamlining its focus on tests. - Adds these imports and functions to `pox_Commands.ts`, centralizing cycle-related logic within command utilities for better cohesion and reusability. This shift enhances modularity and clarity in handling reward cycle calculations across PoX-4 tests.

…xCommand

This change optimizes the generation of Clarity values for the allowUntilBurnHt property in the AllowContractCallerCommand tests. By directly creating Clarity optional values (none or some(uint)) within the fast-check generator, we remove the need for conditional post-processing. This approach simplifies the test setup and aligns more closely with the intended usage patterns of the Clarity and fast-check libraries.

- Moved `network` from `Stub` (Model) to `Real`, streamlining state management. - `unlockBurnHt` now dynamically calculated, passed via constructor, ensuring alignment with generated `period`. - Utilized `fast-check`'s `chain` for dynamic `unlockBurnHt` calculation, improving test accuracy. - Enforces discipline in constructor use and `check` method validation, highlighting the importance of explicit state and parameter handling for reliable testing.

Replace direct `console.log` and manual padding with `logCommand`, enhancing readability and simplifying logging.

#4550 (comment)

@hugocaillard

Thanks to @hugocaillard for swiftly implementing this feature.

Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

Removed the "./noopReporter.ts" from the global Vitest reporters configuration to ensure test outputs are visible by default. This change addresses an issue where the output from all tests was being hidden, making it difficult to observe test results directly. The noopReporter can still be used selectively for specific tests via: npx vitest --reporter=./noopReporter.ts run tests/pox-4/pox-4.stateful-prop.test.ts

Each `run` method now calls `model.trackCommandRun(this.constructor.name)`, enhancing observability and aiding in debugging by systematically tracking command executions. Example output: Command run method execution counts: AllowContractCallerCommand: 491 DelegateStackStxCommand: 1 DelegateStxCommand: 285 GetStackingMinimumCommand: 536 GetStxAccountCommand: 503 RevokeDelegateStxCommand: 281 StackStxCommand: 8

https://github.com/stacks-network/stacks-core/pull/4597/files/32e64e8ce33e440b5ddf9b3d804ce42e66e760ff#r1542690008

… lock period comment #4607 (comment)

#4607 (comment) Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

#4607 (comment)

…onCommitAuth`

https://github.com/stacks-network/stacks-core/pull/4628/files/852b0c5ca8b3dd7c6f91a55e464b9095fa8776d5#r1549587969

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549544398 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549544650 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549546009 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549557014 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549556367 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549622406

- removed check that verifies all the stackers have delegated to the same PoX address - addressed comments: - #4628 (comment) - #4628 (comment) - #4628 (comment)

…re-based

…zation-based

Adding the `StackAggregationIncreaseCommand` is currently causing the tests to fail. To investigate: - this may be a PoX-4 bug - this may be a command implementation issue

…e next reward cycle

…rdCycle Rename `stateRefresh` to `refreshStateForNextRewardCycle` to more explicitly indicate its function of updating the model's state upon transitioning to the next reward cycle.

- Ran `deno fmt` to ensure code formatting adheres to standard practices. - Manually wrapped comments to 79 characters width for improved readability across various code editors and diff tools. - Fixed minor typos and standardized comment punctuation. - Added missing periods at the end of parameter descriptions.

This commit lays the groundwork for the StackStxCommand and GetStackingMinimumCommand classes for PoX-4. It also proposes the introduction of fast-check based stateful tests, similar to the efforts for sBTC (stacks-network/sbtc#152). As highlighted in #4548, this initiative is part of an ongoing effort to embrace a more rigorous, property-based testing strategy for PoX-4 interactions. The planned stateful tests aim to simulate various stacking scenarios, ensuring compliance with PoX-4 protocols and robust error handling. This strategy is expected to greatly enhance test coverage and the reliability of PoX-4 stacking operations, bolstering confidence in the protocol’s robustness and correctness. Note: This is an early-stage WIP commit. Implementation details and testing strategies are subject to substantial development and refinement.

Revamps the PoX-4 testing suite by introducing wallet labels, aiming for more intelligible logging and easier identification of wallets in tests. This enhancement affects various commands and test setups, making debugging and test verification processes more straightforward. Includes updates to wallet structures and all related command implementations to utilize these labels in their logging outputs.

Simplifies the Wallet type and its usage in PoX-4 tests by removing the prvKey and pubKey fields. This change reflects an effort to simplify the data structures and focus on the essential elements needed for testing. The reduction in fields contributes to cleaner code and minimizes unnecessary data handling in the test setup and execution.

Improves code clarity by renaming the 'client' field in the Wallet type to 'stackingClient'. This change better specifies the purpose of the client as specifically for stacking operations within the PoX-4 testing framework. The update is applied across all instances where the field is referenced, ensuring consistency and enhancing readability.

Enhances type safety by changing the 'delegatedTo' field in the Wallet type from a generic string to a more specific StxAddress type. This modification aids in preventing potential bugs by ensuring the field is used consistently as an STX address across the PoX-4 testing suite. The adjustment promotes clearer code, and better alignment with the domain model.

Introduces `amountUnlocked` to the Wallet model in PoX-4 tests to clearly differentiate between locked and available balances. This addition complements the existing balance field, enhancing understanding of staking dynamics without renaming or removing existing structures. Adjustments made in related commands and tests ensure accuracy and consistency.

- Removes `Cl` and `cvToValue` imports and cycle utility functions from `pox-4.stateful-prop.test.ts`, streamlining its focus on tests. - Adds these imports and functions to `pox_Commands.ts`, centralizing cycle-related logic within command utilities for better cohesion and reusability. This shift enhances modularity and clarity in handling reward cycle calculations across PoX-4 tests.

…xCommand

This change optimizes the generation of Clarity values for the allowUntilBurnHt property in the AllowContractCallerCommand tests. By directly creating Clarity optional values (none or some(uint)) within the fast-check generator, we remove the need for conditional post-processing. This approach simplifies the test setup and aligns more closely with the intended usage patterns of the Clarity and fast-check libraries.

- Moved `network` from `Stub` (Model) to `Real`, streamlining state management. - `unlockBurnHt` now dynamically calculated, passed via constructor, ensuring alignment with generated `period`. - Utilized `fast-check`'s `chain` for dynamic `unlockBurnHt` calculation, improving test accuracy. - Enforces discipline in constructor use and `check` method validation, highlighting the importance of explicit state and parameter handling for reliable testing.

Replace direct `console.log` and manual padding with `logCommand`, enhancing readability and simplifying logging.

#4550 (comment)

@hugocaillard

Thanks to @hugocaillard for swiftly implementing this feature.

Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

Removed the "./noopReporter.ts" from the global Vitest reporters configuration to ensure test outputs are visible by default. This change addresses an issue where the output from all tests was being hidden, making it difficult to observe test results directly. The noopReporter can still be used selectively for specific tests via: npx vitest --reporter=./noopReporter.ts run tests/pox-4/pox-4.stateful-prop.test.ts

Each `run` method now calls `model.trackCommandRun(this.constructor.name)`, enhancing observability and aiding in debugging by systematically tracking command executions. Example output: Command run method execution counts: AllowContractCallerCommand: 491 DelegateStackStxCommand: 1 DelegateStxCommand: 285 GetStackingMinimumCommand: 536 GetStxAccountCommand: 503 RevokeDelegateStxCommand: 281 StackStxCommand: 8

https://github.com/stacks-network/stacks-core/pull/4597/files/32e64e8ce33e440b5ddf9b3d804ce42e66e760ff#r1542690008

… lock period comment #4607 (comment)

#4607 (comment) Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

#4607 (comment)

…onCommitAuth`

https://github.com/stacks-network/stacks-core/pull/4628/files/852b0c5ca8b3dd7c6f91a55e464b9095fa8776d5#r1549587969

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549544398 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549544650 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549546009 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549557014 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549556367 Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

https://github.com/stacks-network/stacks-core/pull/4628/files#r1549622406

- removed check that verifies all the stackers have delegated to the same PoX address - addressed comments: - #4628 (comment) - #4628 (comment) - #4628 (comment)

…re-based

…zation-based

Adding the `StackAggregationIncreaseCommand` is currently causing the tests to fail. To investigate: - this may be a PoX-4 bug - this may be a command implementation issue

…e next reward cycle

…rdCycle Rename `stateRefresh` to `refreshStateForNextRewardCycle` to more explicitly indicate its function of updating the model's state upon transitioning to the next reward cycle.

- Ran `deno fmt` to ensure code formatting adheres to standard practices. - Manually wrapped comments to 79 characters width for improved readability across various code editors and diff tools. - Fixed minor typos and standardized comment punctuation. - Added missing periods at the end of parameter descriptions.

…cks-network/stacks-core into feat/pox-4-stateful-property-testing

…bug fixes This includes the fixes in - #4644 - #4670

to ensure command updates propagate: - Split wallet data into Wallet and Stacker types in pox-4 tests. - Address fast-check execution order issues affecting state propagation. - Initialize Wallet in constructor, modify Stacker in command runs. - Ensure accurate reflection and propagation of updates across commands.

…alization

…ignature

…xtend`, `RevokeDelegateStx` This commit fixes issues regarding values generated at the generator level that are not available after the reward cycle change.

This commit fixes the way the current cycle is calculated.

…tion

Co-authored-by: Nikos Baxevanis <nikos.baxevanis@gmail.com>

…let from ex-allowed's list

…_BURNCHAIN_BLOCK_HEIGHT` consts

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[pox-4] Pool Stacking stateful property-based tests #4550

[pox-4] Pool Stacking stateful property-based tests #4550

Commits on Apr 11, 2024

Commits on Apr 12, 2024

Commits on Apr 15, 2024

Commits on Apr 17, 2024

Commits on Apr 22, 2024

Commits on Apr 23, 2024