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

Update docs for --light mode #3191

Merged
merged 4 commits into from
Mar 24, 2022
Merged

Update docs for --light mode #3191

merged 4 commits into from
Mar 24, 2022

Conversation

piotr-iohk
Copy link
Contributor

@piotr-iohk piotr-iohk commented Mar 21, 2022

  • I have updated docs (cli.md and use case) for upcoming --light mode

Comments

Issue Number

ADP-1426

@piotr-iohk piotr-iohk self-assigned this Mar 21, 2022
@piotr-iohk piotr-iohk requested a review from Unisay March 21, 2022 20:28
Comment on lines +117 to +122
--node-socket FILE Path to the node's domain socket file (POSIX) or pipe
name (Windows). Note: Maximum length for POSIX socket
files is approx. 100 bytes. Note: Windows named pipes
are of the form \\.\pipe\cardano-node
--light Enable light mode
--blockfrost-token-file FILE
Copy link
Contributor

@Unisay Unisay Mar 23, 2022

Choose a reason for hiding this comment

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

These options are mutually exclusive. I don't know if this documentation is supposed to indicate it somehow.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a copy-paste of Available options from cardano-wallet serve --help... the mutual exclusiveness is there indicated by usage:

Usage: cardano-wallet serve [--listen-address HOST] 
                            (--node-socket FILE | --light
                              --blockfrost-token-file FILE) 
                            [--random-port | --port INT] 
                            [--tls-ca-cert FILE --tls-sv-cert FILE
                              --tls-sv-key FILE] 
                            (--mainnet | --testnet FILE | --staging FILE) 
                            [--database DIR] [--sync-tolerance DURATION] 
                            [--shutdown-handler] 
                            [--pool-metadata-fetching ( none | direct | SMASH-URL )]
                            [--token-metadata-server URL] 
                            [--trace-NAME SEVERITY]

Perhaps a note in docs would be handy too.

piotr-iohk and others added 2 commits March 23, 2022 22:04
@piotr-iohk
Copy link
Contributor Author

bors r+

@iohk-bors
Copy link
Contributor

iohk-bors bot commented Mar 24, 2022

Build succeeded:

@iohk-bors iohk-bors bot merged commit 25f070c into master Mar 24, 2022
@iohk-bors iohk-bors bot deleted the piotr/ADP-1426/docs branch March 24, 2022 14:06
WilliamKingNoel-Bot pushed a commit that referenced this pull request Mar 24, 2022
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.

2 participants