2018-07-10 04:48:43 -07:00
|
|
|
# Getting Started
|
|
|
|
|
2018-09-21 09:33:58 -07:00
|
|
|
To start a REST server, we need to specify the following parameters:
|
2018-10-17 17:46:03 -07:00
|
|
|
|
2018-07-10 04:48:43 -07:00
|
|
|
| Parameter | Type | Default | Required | Description |
|
|
|
|
| ----------- | --------- | ----------------------- | -------- | ---------------------------------------------------- |
|
|
|
|
| chain-id | string | null | true | chain id of the full node to connect |
|
|
|
|
| node | URL | "tcp://localhost:46657" | true | address of the full node to connect |
|
|
|
|
| laddr | URL | "tcp://localhost:1317" | true | address to run the rest server on |
|
|
|
|
| trust-node | bool | "false" | true | Whether this LCD is connected to a trusted full node |
|
|
|
|
| trust-store | DIRECTORY | "$HOME/.lcd" | false | directory for save checkpoints and validator sets |
|
|
|
|
|
2019-04-15 15:47:17 -07:00
|
|
|
For example:
|
2018-07-10 04:48:43 -07:00
|
|
|
|
|
|
|
```bash
|
2018-12-12 04:17:15 -08:00
|
|
|
gaiacli rest-server --chain-id=test \
|
2018-09-21 09:33:58 -07:00
|
|
|
--laddr=tcp://localhost:1317 \
|
2018-10-17 17:46:03 -07:00
|
|
|
--node tcp://localhost:26657 \
|
2018-09-21 09:33:58 -07:00
|
|
|
--trust-node=false
|
2018-07-10 04:48:43 -07:00
|
|
|
```
|
|
|
|
|
2018-10-17 17:46:03 -07:00
|
|
|
For more information about the Gaia-Lite RPC, see the [swagger documentation](https://cosmos.network/rpc/)
|