feat: cli option to decode serialized Clarity values

[zone117x]

This PR was published to npm with the version 6.9.1-pr.b33d848.0
e.g. npm install @stacks/common@6.9.1-pr.b33d848.0 --save-exact

Description

New CLI feature to decode Clarity values into json/repr/pretty strings.

Example

The repr format string is returned by default:

$ stx decode_cv 0b00000003000000000000000000000000000000000100000000000000000000000000000000020000000000000000000000000000000003
(list 1 2 3)

Use --format json to output JSON:

$ stx decode_cv --format json 0b00000003000000000000000000000000000000000100000000000000000000000000000000020000000000000000000000000000000003
{"type":"(list 3 int)","value":[{"type":"int","value":"1"},{"type":"int","value":"2"},{"type":"int","value":"3"}]}

Use --format pretty to output a pretty-print repr string:

$ stx decode_cv --format pretty 0b00000003000000000000000000000000000000000100000000000000000000000000000000020000000000000000000000000000000003
(list
  1
  2
  3
)

Values can also be piped into the command by using - in place of the value:

$ echo 0x050011deadbeef11ababffff11deadbeef11ababffff | stx decode_cv --format json -
{"type":"principal","value":"S08XXBDYXW8TQAZZZW8XXBDYXW8TQAZZZZ88551S"}

Real world example of decoding output from a Stacks node RPC call:

$ curl -sX POST 'https://stacks-node-api.testnet.stacks.co/v2/map_entry/ST000000000000000000002AMW42H/pox-3/delegation-state?proof=0' -H 'Content-Type: application/json' -d '"0x0c0000000107737461636b65720515f1a77e086d9de40dfa879175c4fb22f426950c5d"' | jq -r .data | stx decode_cv --format pretty -
(some {
  amount-ustx: u10000000,
  delegated-to: 'SND3WM4FYSYFZM2C8K62K1XJD97W6YTXET0N4C6A,
  pox-addr: none,
  until-burn-ht: (some u2540805)
})

---

Checklist

• Unit tested updated code paths
• Tagged 1 of @janniks or @zone117x for review

[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	Nov 27, 2023 4:52pm

[codecov]

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (debeb00) 66.18% compared to head (f4ad89d) 66.31%.
Report is 31 commits behind head on main.

❗ Current head f4ad89d differs from pull request most recent head b33d848. Consider uploading reports for the commit b33d848 to get more accurate results

Files	Patch %	Lines
packages/cli/src/cli.ts	82.35%	3 Missing ⚠️
packages/transactions/src/clarity/prettyPrint.ts	93.33%	3 Missing ⚠️
packages/transactions/src/cl.ts	60.00%	2 Missing ⚠️
packages/transactions/src/transaction.ts	87.50%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1599      +/-   ##
==========================================
+ Coverage   66.18%   66.31%   +0.13%     
==========================================
  Files         118      119       +1     
  Lines        8640     8690      +50     
  Branches     1908     1914       +6     
==========================================
+ Hits         5718     5763      +45     
- Misses       2685     2802     +117     
+ Partials      237      125     -112     

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

[janniks]

Very useful!! 🎉