lightninglabs / lightninglabs/docs.lightning.engineering

clearly define genesis point and anchor outpoint

Open
#729 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Markdown
Stars
73
Forks
73
Avg merge
1h 38m
Merged PRs (30d)
31

Description

ListAssets (https://lightning.engineering/api-docs/api/taproot-assets/taproot-assets/list-assets) yields a genesis_point (https://github.com/lightninglabs/taproot-assets/blob/ee06af74d45a5eb37887876972ebaf2223fd8a82/taprpc/taprootassets.proto#L229-L230) and anchor_outpoint (https://github.com/lightninglabs/taproot-assets/blob/ee06af74d45a5eb37887876972ebaf2223fd8a82/taprpc/taprootassets.proto#L202-L203).

genesis_point is defined (https://github.com/lightninglabs/docs.lightning.engineering/blob/dede15c7582612cc2de21517825added28a5aad0/the-lightning-network/taproot-assets/glossary.md?plain=1#L55-L57), but it would be good to include this visually showing a transaction with multiple inputs. On https://docs.lightning.engineering/the-lightning-network/taproot-assets/taproot-assets-protocol there is a mention of a genesis_outpoint and a genesis output, but it is unclear if those are the same as genesis_point.

We have Anchor defined (https://github.com/lightninglabs/docs.lightning.engineering/blob/dede15c7582612cc2de21517825added28a5aad0/the-lightning-network/taproot-assets/glossary.md?plain=1#L9-L11), but it is unclear if that is the same thing as an anchor_outpoint. There is no mention of anchor on https://docs.lightning.engineering/the-lightning-network/taproot-assets/taproot-assets-protocol .

Please explain, is a genesis_point a special type of anchor_outpoint? What is an anchor_outpoint called once the asset has been transferred?

It would be nice to see the genesis point and anchor outpoint clearly defined on https://docs.lightning.engineering/the-lightning-network/taproot-assets/taproot-assets-protocol using figures so that one can visually understand how to properly interpret the response of the ListAssets RPC and understand how taproot assets are actually created and moved around using tapd. Also, having consistent names and descriptions in .proto comments/documentation, glossary, and general documentation helps to know you are connecting all documentation sources together properly.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the definitions in the glossary.md entry, the taproot-assets-protocol page, and the taprpc/taprootassets.proto comments linked in the issue. Trace the terminology through the ListAssets RPC documentation and determine the required figures and wording. Done means the genesis point and anchor outpoint are consistently defined and visually explained across the protocol page, glossary, and proto documentation.

Written by the indexing model from the issue text.

Assessment

Domain
blockchain, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.