feat: add pox-4 signer-key to StackingClient methods

[janniks]

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

• pox-4 changes
  • adds signer-key to methods (as optional arguments, so this change can be merged before pox-4 is live)
  • removes deprecated data-vars

Waiting on

• [Nakamoto] PoX reward set state should include the signing key, not the stacker state stacks-network/stacks-core#4274
• feat: require signatures to prove control of signer-key in pox stacks-network/stacks-core#4277

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
stacksjs-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 21, 2024 4:46pm

[codecov]

Codecov Report

Attention: Patch coverage is 64.38356% with 26 lines in your changes are missing coverage. Please review.

Project coverage is 66.31%. Comparing base (4ef1815) to head (2a2f6aa).

Files	Patch %	Lines
packages/stacking/src/index.ts	48.83%	17 Missing and 5 partials ⚠️
packages/stacking/src/utils.ts	86.66%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1614      +/-   ##
==========================================
- Coverage   66.39%   66.31%   -0.08%     
==========================================
  Files         119      119              
  Lines        8719     8764      +45     
  Branches     1947     1953       +6     
==========================================
+ Hits         5789     5812      +23     
- Misses       2692     2708      +16     
- Partials      238      244       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[zone117x]

What happens if a signer key arg is provided before pox-4 is activated?

[janniks]

Good point 😉 For now I assumed folks adding a signer-key know what they're doing, currently the ABI would fail.
But it's probably better to add another throw to the 'ensure' helper for both missing and given signer-key and the respective pox.

[janniks]

Added a better ensure check.
Also waiting to see if stacks-network/stacks-core#4230 is planned.
The API should be able to use the pre-release of this PR

[friedger]

Delegate stack stx won't have signer key. There is an issue stacks-network/stacks-core#4274

[hstove]

Also FYI new function arg signer-sig for a few functions: stacks-network/stacks-core#4277

[janniks]

Thanks 🙏 Will wait for the PRs to merge to update the remainder

[hstove]

Added a helper for the signer signature: #1628

Now that this is in the next branch, I don't think there will be any more changes to the pox-4 function signatures.

[janniks]

Changed some minor missing checks/params and addressed review comments. Could I get a re-review on this? @zone117x or @hstove

[zone117x]

LGTM, nice job @janniks!

[hstove]

This is great, and I've been testing with a local version of Lockstacks and it works as expected.

One change request, though: can you change authId to be IntegerType? We could run into issues with the number type because it can technically be any u128.

[janniks]

Done ✅ Thanks