Testing Plan for Stacks 2.4

[saralab]

This document will be edited as more test items are accepted.

Blockchain track

• Verify that the .pox-3 activation works on testnet - @deantchi @kantai

  • .pox-3 added to contract_versions in /v2/pox RPC response
  • .pox-3 instantiates at the expected block height Regtest integration tests
  • Users can stack their STX into .pox-3 Regtest integration tests
  • Once the next reward cycle begins, tokens stacked in .pox-3 are used to derive the reward cycle. .pox-2 is ignored Regtest integration tests
  • 2.4 Epoch transitions successfully on Testnet - Block #2432545

• Verify correct .pox-3 behavior on devnet & testnet- @obycode - In Progress - fully tested on devnet; testnet testing pending

  • stack-increase works as expected
  • stack-extend works as expected
  • delegate-stx works as expected
  • revoke-delegate-stx works as expected
  • delegate-stack-stx works as expected
  • delegate-stack-increase works as expected
  • delegate-stack-extend works as expected
  • stack-aggregation-commit-indexed works as expected
  • verify that btc wire format tx for "delegate-stx" works
  • stack-unlock (auto-unlocks) works as expected

• Verify that all tests in https://github.com/hirosystems/stacks-2-1-testing still work correctly - @obycode

• 100% Clarity code coverage with clarinet unit tests - @jbencin - In Progress

  • Fork https://github.com/Trust-Machines/pox-clarinet-tests and modify for PoX3
  • Make a replacement for stx-account that works under Clarinet (works except when delegating)
  • Fix existing tests
  • Reach as close as possible to 100% coverage (currently at 73%)
    • This is likely as far as we can get under Clarinet. Getting delegate- would require modifying the contract to a point that would make any testing on it not very meaningful

• Stacks API works correctly with Epoch 2.4 @zone117x

  • Pox-3 events get emitted, should be same behavior as pox-2 events
  • Rosetta stacking operations uses pox-3

• Fuzz testing - @fpbgg - In Progress

  • No inconsistencies between Clarity implementation
  • Fuzz testing ongoing for Clarity

Dev tooling track - @janniks

• Stacks.js stacking library uses pox-3 automatically

Non-blocking items

Subnets

• Verify that subnets instantiate on the public 2.4 testnet - @jbencin - In Progress
  • Tested and failed. Issue has been tracked to this commit, which changes the interface of commit-block in subnet.clar
  • Update subnet contracts on testnet L1 and L2 so that they match and test again

Pools

• Ensure pools work as expected with .pox-3

Client/Wallet track

• Clients that stack will automatically direct STX to .pox-3
  • Clients can determine that STX have unlocked after the transition
  • Clients can determine when the .pox-3 contract has been instantiated
• Clients will report the correct locked / unlocked balance after the transition
  • At the transition, all STX locked in .pox-2 show up as unlocked
  • STX stacked after the transition show up as locked

Exchange track - @wileyj | @cuevasm

• Reach out to all exchanges we know of to inform them that they will need to update their code to stack user STX to .pox-3
• Offer them a testnet (or a private testnet) to try out new stacking
• Inform exchanges that they should use an officially-supported client library for .pox-3 if the are able

---

Please suggest more tests below

[cargocultscience]

Very happy to see this kind of effort and documentation!

[saralab]

Update May 16 2023:

• Private Testnet ready to test the stacking scenarios for PoX-3, stacks-increase and stacks-extend look good so far

[whoabuddy]

Tagging @yknl @dantrevino @aulneau for tooling/client/wallet topics, my guess is they are already clued in but just want to be sure they've seen this and can share with others:slightly_smiling_face:

verify that btc wire format tx for "delegate-stx" works

should this include a verification of the btc wire format for "stack-stx" too?