Skip to content

docs: add sample-tapd.conf #978

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

Merged
merged 2 commits into from
Jun 27, 2024
Merged

docs: add sample-tapd.conf #978

merged 2 commits into from
Jun 27, 2024

Conversation

Roasbeef
Copy link
Member

Generated by Claude 3.5 Sonnet, should spot check accordingly.

@Roasbeef Roasbeef added documentation Improvements or additions to documentation config labels Jun 26, 2024
@guggero guggero force-pushed the sample-tapd-conf branch from 17c4f65 to 6a6a263 Compare June 26, 2024 07:50
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.

Very nice!

Added some extra information and updated some values to look more similar to lnd's sample conf, then also added the check script we have.

@dstadulis dstadulis requested a review from Liongrass June 26, 2024 09:30
@HannahMR
Copy link

It would be great to add a bit of guidance on when config needs to be in the tapd.conf file and when it needs to be in the lit.conf file.

@Liongrass
Copy link
Contributor

The only thing I found unclear about this configuration file was the RFQ section at the very bottom.

For example, does use_mock_price_oracle_service_promise_to_not_use_on_mainnet (lol) require a boolean or not?

And the next line, if I want to use the mock price oracle, do I also need to set experimental.rfq.priceoracleaddress=?

And finally I might benefit from having an example what a USD per sat rate would look like, especially since the configuration reads "cent per sat" but the description reads "USD per sat". 1 sat is currently 0.00061 USD, would I then enter 0.00061 below?

experimental.rfq.mockoraclecentpersat=0.00061

@guggero
Copy link
Member

guggero commented Jun 26, 2024

use_mock_price_oracle_service_promise_to_not_use_on_mainnet is the value you set for the key experimental.rfq.priceoracleaddress=.
So:

experimental.rfq.priceoracleaddress=use_mock_price_oracle_service_promise_to_not_use_on_mainnet

And yes, it's that verbose on purpose.

@guggero
Copy link
Member

guggero commented Jun 26, 2024

It would be great to add a bit of guidance on when config needs to be in the tapd.conf file and when it needs to be in the lit.conf file.

If things run within litd, all config values need to be in lit.conf, but prefixed with the service (so in this case taproot-assets.xxx. I think that's generally explained here: https://github.com/lightninglabs/lightning-terminal/blob/master/docs/config-lnd-integrated.md#use-a-configuration-file

Not sure if this explanation should go into sample-tapd.conf, since that doesn't necessarily directly relate to litd. So maybe that should be described in a general "how to use the taproot assets channel feature in litd" document?

@Roasbeef Roasbeef merged commit 697b057 into main Jun 27, 2024
15 checks passed
@guggero guggero deleted the sample-tapd-conf branch June 27, 2024 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

4 participants