Skip to content
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.

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

add clarity on how RFQ messaging actually happens #715

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ZZiigguurraatt
Copy link

@ZZiigguurraatt ZZiigguurraatt commented Nov 6, 2024

This PR adds some brief clarity on how RFQ messages are actually exchanged.

Pull Request Checklist

  • The documents updated are not in the docs/ directory. These files are
    synced from upstream repositories (lnd, lit, loop, pool and faraday), and
    should be updated in their parent repo.

Copy link
Member

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Nice, thanks!

@@ -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.

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
Member

Choose a reason for hiding this comment

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

@lightninglabs-deploy
Copy link

@ZZiigguurraatt, remember to re-request review from reviewers when ready

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants