e2da4caae4
In order to guarantee a secure connection between apps and the LCD the communication must be encrypted - even if clients and server run on the same local machine, credentials must never be transmitted in clear text. Upon start up, the server generates a self-signed certificate and a key. Both are stored as temporary files; removal is guaranteed on exit. This new behaviour is now enabled by default, though users are provided with a --insecure flag to switch it off.
57 lines
2.6 KiB
Markdown
57 lines
2.6 KiB
Markdown
# Getting Started
|
|
|
|
To start a REST server, we need to specify the following parameters:
|
|
| 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 |
|
|
|
|
Sample command:
|
|
|
|
```bash
|
|
gaiacli rest-server --chain-id=test \
|
|
--laddr=tcp://localhost:1317 \
|
|
--node tcp://localhost:46657 \
|
|
--trust-node=false
|
|
```
|
|
|
|
The server listens on HTTPS by default. You can set the SSL certificate to be used by the server with these additional flags:
|
|
|
|
```bash
|
|
gaiacli rest-server --chain-id=test \
|
|
--laddr=tcp://localhost:1317 \
|
|
--node tcp://localhost:46657 \
|
|
--trust-node=false \
|
|
--certfile=mycert.pem --keyfile=mykey.key
|
|
```
|
|
|
|
If no certificate/keyfile pair is supplied, a self-signed certificate will be generated and its fingerprint printed out.
|
|
Append `--insecure` to the command line if you want to disable the secure layer and listen on an insecure HTTP port.
|
|
|
|
## Gaia Light Use Cases
|
|
|
|
LCD could be very helpful for related service providers. For a wallet service provider, LCD could
|
|
make transaction faster and more reliable in the following cases.
|
|
|
|
### Create an account
|
|
|
|
|
|
|
|
First you need to get a new seed phrase :[get-seed](api.md#keysseed---get)
|
|
|
|
After having new seed, you could generate a new account with it : [keys](api.md#keys---post)
|
|
|
|
### Transfer a token
|
|
|
|
|
|
|
|
The first step is to build an asset transfer transaction. Here we can post all necessary parameters
|
|
to /create_transfer to get the unsigned transaction byte array. Refer to this link for detailed
|
|
operation: [build transaction](api.md#create_transfer---post)
|
|
|
|
Then sign the returned transaction byte array with users' private key. Finally broadcast the signed
|
|
transaction. Refer to this link for how to broadcast the signed transaction: [broadcast transaction](api.md#create_transfer---post)
|