Skip to content

Commit

Permalink
fix documentation related to blockfrost cli
Browse files Browse the repository at this point in the history
  • Loading branch information
paolino committed Dec 20, 2022
1 parent 1a48e68 commit 9d7ed84
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 44 deletions.
7 changes: 1 addition & 6 deletions docs/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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)
Expand Down
38 changes: 0 additions & 38 deletions docs/user-guide/common-use-cases/how-to-start-wallet-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
```

0 comments on commit 9d7ed84

Please sign in to comment.