Skip to content

add clarity on how RFQ messaging actually happens #715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2024
Merged

add clarity on how RFQ messaging actually happens #715

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ba4a3e
add clarity on how RFQ messaging actually happens
Nov 6, 2024
2087a94
rfq.md: add links for BOLT 01 and BOLT 08
Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lightning-network-tools/taproot-assets/rfq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: >-

When sending Taproot Assets over the Lightning Network, an Edge Node is needed. This Edge Node receives the Taproot Asset in the channel with the direct user and swaps it for bitcoin. As the swap rate between Taproot Assets and bitcoin likely fluctuates, the user may make a Request for Quote to the Edge Node before generating a Lightning Network invoice or initiating a payment.

This request is made using BOLT 01 messages over an existing encrypted and authenticated BOLT 08 connection. The connection already exists because it is used for establishing and coordinating the Taproot Asset Channel in a way very similiar to normal Lightning channels. For more information about connection and messaging, see the [Last Mile Routing](https://github.com/Roasbeef/blips/blob/tap-blip/blip-tap.md#last-mile-routing) section of [Taproot Asset Channels bLIP](https://github.com/Roasbeef/blips/blob/tap-blip/blip-tap.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could insert links to the spec? https://github.com/lightning/bolts/blob/master/01-messaging.md

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would also be great to link to this document: https://github.com/lightninglabs/taproot-assets/blob/main/docs/rfq-and-decimal-display.md

I've created a PR to sync the tapd docs automatically to this repo, so the file should soon be available under docs/taproot-assets/rfq-and-decimal-display.md.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could insert links to the spec? https://github.com/lightning/bolts/blob/master/01-messaging.md

You mean in rfq.md or blip-tap.md?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would also be great to link to this document: https://github.com/lightninglabs/taproot-assets/blob/main/docs/rfq-and-decimal-display.md

I've created a PR to sync the tapd docs automatically to this repo, so the file should soon be available under docs/taproot-assets/rfq-and-decimal-display.md.

So will rfq-and-decimal-display.md be rendered by the gitbook, or do you just want to link into this github repository?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean in rfq.md or blip-tap.md?

I mean to link the words BOLT 01 and BOLT 08 to their definitions.

So will rfq-and-decimal-display.md be rendered by the gitbook,

Yes, once it's synced to this repo, it will be rendered and just needs to be linked.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we are able to link to synced posts without an issue, given they are synced into the docs.lightning.engineering repo

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried. How would we link to this? https://github.com/lightninglabs/docs.lightning.engineering/blob/master/docs/taproot-assets/rfq-and-decimal-display.md

I tried both https://docs.lightning.engineering/docs/taproot-assets/rfq-and-decimal-display and https://docs.lightning.engineering/docs/taproot-assets/rfq-and-decimal-display.md but that didn't work... Is there another prefix I need to use?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the document needs to be linked from the summary.md: https://github.com/lightninglabs/docs.lightning.engineering/blob/master/SUMMARY.md
Under * [Taproot Assets](lightning-network-tools/taproot-assets/README.md) it would need * [Asset Decimal Display](/docs/taproot-assets/rfq-and-decimal-display.md)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then the document would show up in the Builder's Guide as a separate guide, and can be linked from other guides

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Liongrass!
@ZZiigguurraatt it's now available under https://docs.lightning.engineering/lightning-network-tools/taproot-assets/rfq-and-decimal-display.


[Learn more: Edge Nodes](../../the-lightning-network/taproot-assets/edge-nodes.md)

The Request for Quote contains a rate and an expiration time, which allows the sender to decide whether they want to complete the payment and craft a route to the intended recipient.
Expand Down