WIP: REST server docs #1139
WIP: REST server docs #1139
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #1139 +/- ##
===========================================
- Coverage 60.87% 60.65% -0.22%
===========================================
Files 89 89
Lines 4368 4369 +1
===========================================
- Hits 2659 2650 -9
- Misses 1539 1547 +8
- Partials 170 172 +2 |
client/README.md
Outdated
|
|
||
| ```bash | ||
| > go get -u github.com/cosmos/cosmos-sdk | ||
| package github.com/cosmos/cosmos-sdk: no Go files in /home/mossid/go/src/github.com/cosmos/cosmos-sdk |
There was a problem hiding this comment.
Is this line an error you encountered? Why is it on the tuto?
There was a problem hiding this comment.
maybe link to the quick install script? https://github.com/cosmos/cosmos-sdk/tree/rigel/spec-staking/scripts
client/README.md
Outdated
| package github.com/cosmos/cosmos-sdk: no Go files in /home/mossid/go/src/github.com/cosmos/cosmos-sdk | ||
| > cd $GOPATH/src/github.com/cosmos/cosmos-sdk | ||
| > git checkout develop | ||
| Branch develop set up to track remote branch develop from origin. |
There was a problem hiding this comment.
Remove console output from tuto
client/README.md
Outdated
| Switched to a new branch 'develop' | ||
| > dep ensure | ||
| > make install | ||
| go install -ldflags "-X github.com/cosmos/cosmos-sdk/version.GitCommit=be7ec5b" ./cmd/gaia/cmd/gaiad |
There was a problem hiding this comment.
Is this a command to run? Or is this a log? If latter, remove
client/README.md
Outdated
| ### Run node and server | ||
|
|
||
| ```bash | ||
| # If your are going to connect to an external node(e.g. testnet), skip gaiad init and gaiad start |
There was a problem hiding this comment.
Move this out of bash window, put it above. Rephrase to If your are going to connect to an external node(e.g. testnet), skip this part
| ### Test getting account | ||
|
|
||
| ```bash | ||
| > cat $HOME/.gaiad/config/genesis.json |
There was a problem hiding this comment.
This is unclear. Can you clarify the different steps, and comment? Maybe use the GET method /balance from #1092 as an example
There was a problem hiding this comment.
Test getting account section is for testing the lcd is working correctly. To do this, we first get balance from genesis file(as the "expected' value) and compare it with lcd query result(as the "actual" value). Interchain standard describes the lcd endpoints, which could be wrong if the lcd is malfunctioning, so we cannot use it as the expected value I think?
| ``` | ||
|
|
||
| ## Notable Flags | ||
|
|
|
|
||
| * `--chain-id <STRING>`: chain id of the full node to connect | ||
| * `--node <URL>`: address of the full node to connect | ||
| * `--laddr <URL>`: address to run the rest server on |
There was a problem hiding this comment.
I don't understand this flag. Don't you specify the address of the rest server when you ssh into it. To me the steps are:
- SSH into the serv
- Install
- Run the Rest server
In this case, why would you need a flag to specify the address of the server you're already ssh'd in? Maybe a flag for the port would be useful, but why specify the address?
There was a problem hiding this comment.
--laddr is mainly used for specifying tcp server port. I haven't seen any use case using it for specifying the address. Simply put localhost as the address.
There was a problem hiding this comment.
so why not change it to --lport?
There was a problem hiding this comment.
Tendermint codebase and the other part of the sdk codebase uses --laddr so we are using the same one for compatibility.
No description provided.