Skip to content

Annotations

Vlad Stan edited this page Feb 17, 2021 · 5 revisions

Overview

Annotations allow users to share Bitcoin Transaction and to attach notes to certain parts of the transaction. The annotations are simple URL query params that can be added, removed and updated. Sample here.

Supported Annotations

  • tx_hex: the actual transaction data in hex format
  • tx_note: annotation for the entire transaction
  • tx_input_${i}_note: annotation for the input at index i (eg: tx_input_0_note)
  • tx_input_${i}_script_note: annotation for the unlock script at index i (tx_input_0_script_note)
  • tx_output_${i}_note: annotation for the output at index i (eg: tx_output_0_note)
  • tx_output_${i}_script_note: annotation for the unlock script at index i (tx_input_0_script_note)

Query Parameters Example

&tx_note=Sample of a Commitment Transaction used in Lightning Network.
&tx_input_0_note=Spend from the Funding Transaction
&tx_input_0_script_note=This script unlocks a P2WSH. Click the 'Edit' button and manually set the type to P2WSH in order to view the 2-of-2 multisig script.
&tx_output_0_note=[To Local] Output sends funds back to the owner (Alice) of this commitment transaction and thus must be timelocked using `OP_CHECKSEQUENCEVERIFY`. It can be claimed, without delay, by the other party if they know the revocation private key.
&tx_output_0_script_note=This is the "naked" unwrapped Revocable Sequence Maturity Contract (RSMC). In order to see the final form, click the 'Edit' button and 'Wrap in P2WSH'.
&tx_output_1_note=[To Remote] Output sends funds to the other party. If `option_anchor_outputs` applies to the commitment transaction, the `to_remote` output is encumbered by a one block csv lock. Otherwise, this output is a simple P2WPKH to remotepubkey.
&tx_output_1_script_note=This is the "naked" unwrapped Contract that pays Bob with no restrictions. In order to see the final form, click the 'Edit' button and 'Wrap in P2WSH'.
&tx_output_2_note=[Local Anchor] Output can be spent by the local node to provide incentive to mine the transaction, using child-pays-for-parent.
&tx_output_3_note=[Remote Anchor] Output can be spent by the remote node to provide incentive to mine the transaction, using child-pays-for-parent.
&tx_hex=02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a4884890000000000ffffffff04e48d6a00000000004d63210212a140cd0c6539d07cd08dfe09984dec3251ea808b892efeac3ede9402bf2b1967029000b2752103fd5960528dc152014952efdb702a88f71e3c1653b2314431701ec77e57fde83c68acc0c62d00000000002521032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991ad51b24a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb39940340ca3e2b815f7bf548fa59a79002d8093ee786b38803704130a589f749c33552145a36440a0d7d407dee948c85c2f20e4892479075cf2f166e94c2e6309907971440f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc39485076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f3475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae00000000

UI

image image image image image image

Clone this wiki locally