[2.1] Stacking pox-2

[janniks]

This PR was published to npm with the version 5.0.3-pr.50a78ae.0
e.g. npm install @stacks/[email protected] --save-exact

Methods for the upcoming @stacks/stacking changes to PoX-v2

• adds methods new stacking methods
• supports new btc addresses
• adds helpers for pox transition
• closes [Stacks 2.1] Support Stacks 2.1 in @stacks/stacking (PoX-2) #1347
• adds period checking and payload modification, to avoid failing txs
• updates some (more or less ignorable) test configs

• one test is skipped waiting for transition unlock events
• squash this PR!

feat: Add PoX-2 methods to @stacks/stacking client

A StackingClient will now automatically detect which PoX version to use for Stacking.
Adds the following PoX Stacking methods to the StackingClient: `stackExtend`, `stackIncrease`, `delegateStackExtend`, `delegateStackIncrease`, `stackAggregationCommitIndexed`, `stackAggregationIncrease`.
Adds the following helper methods to the StackingClient: `getAccountExtendedBalances`, `getAccountBalanceLocked`, `getDelegationStatus`, `getRewardSet`.

---

For Follow-Up PRs:

• Optimize period detection to make less network requests (semver compatible)
• Add explicit poxContract parameter to stacking methods, for users to choose specifically (semver compatible)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
stacksjs-docs	✅ Ready (Inspect)	Visit Preview	Nov 23, 2022 at 1:58AM (UTC)

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (stacks-2.1@cc0c50c). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head 6b2e9b1 differs from pull request most recent head 50a78ae. Consider uploading reports for the commit 50a78ae to get more accurate results

@@              Coverage Diff              @@
##             stacks-2.1    #1354   +/-   ##
=============================================
  Coverage              ?   63.48%           
=============================================
  Files                 ?      116           
  Lines                 ?     8493           
  Branches              ?     1877           
=============================================
  Hits                  ?     5392           
  Misses                ?     2973           
  Partials              ?      128           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[janniks]

@zone117x What's the best way to detect period-2 via API endpoints?
I've tried using the docker regtest env with tag stacks2.1-transition, but period 1 and 2 seem indistinguishable from each other.

e.g. Running docker run -p "20443:20443" -e "MINE_INTERVAL=30s" -e "STACKS_21_HEIGHT=110" -e "STACKS_POX2_HEIGHT=120" zone117x/stacks-api-e2e:stacks2.1-transition :
These are the /v2/pox outputs for block 108 (before 2.1) and 111 (after 2.1, but before pox-2)
differing lines are highlighted in blue/gray

[zone117x]

@zone117x What's the best way to detect period-2 via API endpoints?

IIRC, during period 2, contract_id will be .pox-2, yet contract_versions[1].activation_burnchain_block_height will be less than current_burnchain_block_height.

[janniks]

@zone117x ready for another review

• Requested btc address test vectors were added
• Missing aggregation.. methods were added

[janniks]

Noticed there was still incorrect Period definitions in there. 3 was basically 2b, now I added all periods and more explicit tests. ✅

[zone117x]

LGTM, thanks @janniks!