Skip to content

Commit

Permalink
[skip ci]docs: transaction labels for on-chain transactions (#284)
Browse files Browse the repository at this point in the history
* [skip ci]docs: transaction labels for on-chain transactions

Add information about setting transaction labels
for on-chain transactions related to swaps.
Mention limitation that only peerswap LNDs
have on-chain labels for now.

* [skip ci]docs: transaction labels for lbtc

For LBTC transactions,
elementsd `SetLabel` will attach a label to the associated address.
  • Loading branch information
YusukeShimizu authored Mar 6, 2024
1 parent f3a6489 commit fb7d5f7
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,3 +185,22 @@ For CLN:
`lightning-cli peerswap-allowswaprequests [bool] ## 1 to allow, 0 to disallow`
For LND:
`pscli allowswaprequests --allow_swaps=[bool] ## true to allow, false to disallow`

## transaction labels
To make the related transactions identifiable, peerswap sets the label.
The label of the on-chain transaction corresponding to the swap is set as follows.

* peerswap -- Opening(swap id=b171ee)
* peerswap -- ClaimByCoop(swap id=b171ee)
* peerswap -- ClaimByCsv(swap id=b171ee)
* peerswap -- ClaimByInvoice(swap id=b171ee)

The way the label is set up in each wallet is different.

For CLN:
Currently, it is not possible to set a label on the cln wallet

For LND:
To check the label attached to a transaction use `lncli listchaintxns`.

For LBTC transactions, elementsd `SetLabel` will attach a label to the associated address.

0 comments on commit fb7d5f7

Please sign in to comment.