From 9d7ed8423a0cb62af7feb86697ccd278b1cf0cbc Mon Sep 17 00:00:00 2001 From: paolo veronelli Date: Tue, 20 Dec 2022 13:29:54 +0100 Subject: [PATCH] fix documentation related to blockfrost cli --- docs/user-guide/cli.md | 7 +--- .../how-to-start-wallet-server.md | 38 ------------------- 2 files changed, 1 insertion(+), 44 deletions(-) diff --git a/docs/user-guide/cli.md b/docs/user-guide/cli.md index 1c8ee834a97..2fee1c5193f 100644 --- a/docs/user-guide/cli.md +++ b/docs/user-guide/cli.md @@ -109,8 +109,7 @@ Serve API that listens for commands/actions. Before launching user should start :::{.cli} ``` Usage: cardano-wallet serve [--listen-address HOST] - (--node-socket FILE [--sync-tolerance DURATION] | - --light --blockfrost-token-file FILE) + (--node-socket FILE [--sync-tolerance DURATION]) [--random-port | --port INT] [--tls-ca-cert FILE --tls-sv-cert FILE --tls-sv-key FILE] @@ -136,10 +135,6 @@ Available options: time duration within which we consider being synced with the network. Expressed in seconds with a trailing 's'. (default: 300s) - --light Enable light mode - --blockfrost-token-file FILE - FILE contains an authentication token for BlockFrost - Cardano API (https://blockfrost.io). --random-port serve wallet API on any available port (conflicts with --port) --port INT port used for serving the wallet API. (default: 8090) diff --git a/docs/user-guide/common-use-cases/how-to-start-wallet-server.md b/docs/user-guide/common-use-cases/how-to-start-wallet-server.md index 1f9035f66d5..c57724d0c11 100644 --- a/docs/user-guide/common-use-cases/how-to-start-wallet-server.md +++ b/docs/user-guide/common-use-cases/how-to-start-wallet-server.md @@ -65,41 +65,3 @@ $ curl -X GET http://localhost:8090/v2/network/information | jq .sync_progress "status": "ready" } ``` - -## Light mode - -> :warning: This mode is currently **under development**. Please note that some parts may not work. - -You can start your cardano-wallet server also in **light mode**. As opposed to full-node mode, in light-mode your wallet is not connected to a locally running instance of `cardano-node`. Instead it relays on external source of blockchain data. This significantly improves synchronization speed of the wallet and also removes the need to spend time synchronizing the node itself. The downside is that external source of data is obviously less trusted than the local one provided by your own `cardano-node` instance. - -> :information_source: Cardano-wallet currently supports only one external data provider - [Blockfrost](https://blockfrost.io/). Before using the light mode one needs to generate API key on Blockfrost page and save it into the file on the filesystem. - -#### Pre-requisites -- Install cardano-wallet from [cardano wallet release page](https://github.com/input-output-hk/cardano-wallet/releases). -- Download up-to-date configuration files from [Cardano configurations](https://hydra.iohk.io/job/Cardano/iohk-nix/cardano-deployment/latest/download/1). - -#### Start `cardano-wallet` in light mode - -Let's suppose we have our API keys generated and saved in files as follows: - - `blockfrost-testnet.key` - API key for `testnet` - - `blockfrost-mainnet.key` - API key for `mainnet` - -Now we can start cardano-wallet server for testnet or mainnet: -##### Testnet -``` -$ cardano-wallet serve \ - --port 8091 \ - --light \ - --blockfrost-token-file blockfrost-testnet.key \ - --testnet byron-genesis.json \ - --database ./wallet-testnet-db-light \ -``` -##### Mainnet -``` -$ cardano-wallet serve \ - --port 8092 \ - --light \ - --blockfrost-token-file blockfrost-mainnet.key \ - --mainnet \ - --database ./wallet-db-light \ -```