taproot-assets icon indicating copy to clipboard operation
taproot-assets copied to clipboard

[feature]: docs: provide JSON examples for custom channel data

Open ZZiigguurraatt opened this issue 9 months ago • 1 comments

We have some structs that can be used with json.Unmarshal to decode custom channel data (https://github.com/lightninglabs/taproot-assets/blob/4852be495676014f72f1a8267bdb46fb191695fe/rfqmsg/custom_channel_data.go#L1-L73), however, we could really use some examples of each of these in JSON format for people to easier understand and for people who don't even use golang.

ZZiigguurraatt avatar Mar 12 '25 18:03 ZZiigguurraatt

This is going to be refactored by https://github.com/lightninglabs/taproot-assets/pull/1413, see https://github.com/lightninglabs/taproot-assets/blob/0c462c10990ef7a16e1bbf76fd03f65e7d15b567/tapchannelmsg/custom_channel_data_test.go.

guggero avatar Mar 12 '25 18:03 guggero

It seems as though lncli now decodes the custom_channel_data (but not custom_records). I'm not sure if this was always the case? Maybe we can just refer people to look at that for an example instead of putting it in the documentation?

ZZiigguurraatt avatar Jun 18 '25 21:06 ZZiigguurraatt

Closing in line with a previous triage effort.

jtobin avatar Nov 25 '25 07:11 jtobin