R4R: Bianjie/lcd implementation #2147

abelliumnt · 2018-08-25T02:39:44Z

proceed from: #2118

…to haoyang/lcd-implementation

…plementation-new

Haoyang/lcd implementation new

fedekunze · 2018-08-26T22:10:49Z

client/lcd/root.go

+// Which is much friendly for further development
+func ServeSwaggerCommand(cdc *wire.Codec) *cobra.Command {
+ cmd := &cobra.Command{
+ Use: "lite-server",


@HaoyangLiu Could you add the cmd to the Gaia-lite section of clients.md docs ?

fedekunze · 2018-08-26T22:14:14Z

cmd/gaia/cmd/gaiacli/main.go

@@ -66,6 +67,7 @@ func main() {
 tendermintCmd,
 ibcCmd,
 lcd.ServeCommand(cdc),
+ lcd.ServeSwaggerCommand(cdc),


Please add to Basecoin's basecli file as well

fedekunze

utACK. Thanks so much for the work here @HaoyangLiu. There are a couple things left related to docs and examples only. Please address those before merging

fedekunze · 2018-08-27T08:40:07Z

docs/light/getting_started.md

-### Transfer a token
+When the connected full node is trusted, then the proof is not necessary, so you can run gaia-lite node with trust-node option:
+```
+gaiacli lite-server --chain-id {your chain id} --trust-node


fedekunze · 2018-08-27T08:42:00Z

docs/light/getting_started.md

-![transfer](pics/transfer-tokens.png)
+If you have want to run gaia-lite node in a remote server, then you must specify the public ip to swagger-host-ip
+```
+gaiacli lite-server --chain-id {your chain id} --swagger-host-ip {remove server public ip}


gaiacli lite-server --chain-id=<chain_id> --swagger-host-ip=<remote_server_ip>. Typo in remove ?

fedekunze · 2018-08-27T08:43:57Z

docs/sdk/clients.md

-::: tip Note
-🚧 We are actively working on documentation for Gaia-lite.
-:::
+The Gaia-Lite is a light gaiad node. Unlike gaiad full node, it doesn't participate consensus and execute transactions, so it only require very little storage and calculation resource. However, it can provide the same security as a gaia full node.


This is a very concise and well written explanation about Gaia-lite, thanks !

fedekunze · 2018-08-27T08:45:53Z

docs/light/getting_started.md

-operation: [build transaction](api.md#create_transfer---post)
+The gaia-lite node can connect to multiple full nodes. Then gaia-lite will do load balancing for full nodes which is helpful to improve reliability and TPS. You can do this by this command:
+```
+gaiacli lite-server --chain-id {your chain id} --node-list tcp://10.10.10.10:26657,tcp://20.20.20.20:26657


gaiacli lite-server --chain-id=<chain_id> --node-list=tcp://10.10.10.10:26657,tcp://20.20.20.20:26657. Although not sure if the node list needs to be in between " ". Will double check that

I have double checked that. The node list doesn't need to be in between " "

fedekunze · 2018-08-27T08:46:14Z

docs/sdk/clients.md

+
+You can start a gaia-lite node with the following command:
+```
+gaiacli lite-server --chain-id {your chain id}


gaiacli lite-server --chain-id-<chain_id>

abelliumnt · 2018-08-27T10:05:03Z

I have change the code according to your comment. Please check it.

jackzampolin · 2018-08-27T15:50:32Z

@HaoyangLiu Pulling this down today and will get started testing. Can you make sure all the routes and docs here match this issue: #2113

Looking forward to getting this merged!

fedekunze · 2018-08-27T16:07:33Z

docs/light/getting_started.md


-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)
+The gaia-lite support modular rest APIs. Now it supports four modules: general, key, token and stake. If you need all of them, just start it with this command:


@jackzampolin :

Gaia-lite is built in a modular format. Each Cosmos module defines it's own RPC API. Currently the following modules are supported: transaction, key, bank (token), staking, governance, and slashing.

abelliumnt · 2018-08-27T16:28:20Z

Hi @jackzampolin, now ICS0, ICS22, ICS23 are still not supported. The following APIs in ICS1 are not supported too.

 GET /auth/accounts/{address}
 POST /keys/{name}/sign

Do you expect full implementation of all APIs in #2113 in this PR? If so, I will continus to implement the unsupported APIs and append the code to this PR.

jackzampolin · 2018-08-27T16:36:03Z

@HaoyangLiu I expect full implementation of of ICS0, ICS22, ICS23, but maybe not in this PR. How about you finish up the ICS0 and ICS1 work in this PR and implement ICS0, ICS22 and ICS23 in a follow up PR. Does that work for you?

abelliumnt · 2018-08-27T16:55:38Z

@jackzampolin
That's OK for me. I will finish ICS0 and ICS1 ASAP. Thanks

abelliumnt · 2018-08-27T17:07:49Z

@jackzampolin
According to the spec, all rest APIs' response have a wrapper. For example, the response of /keys (get) is like this:

{
    "rest api":"1.0",
    "code":200,
    "error":"",
    "result":
		[
            {
                "name":"monkey",
                "address":"cosmosaccaddr1fedh326uxqlxs8ph9ej7cf854gz7fd5zlym5pd",
                "pub_key":"cosmosaccpub1zcjduc3q8s8ha96ry4xc5xvjp9tr9w9p0e5lk5y0rpjs5epsfxs4wmf72x3shvus0t"
            },
            {
                "name":"test",
                "address":"cosmosaccaddr1thlqhjqw78zvcy0ua4ldj9gnazqzavyw4eske2",
                "pub_key":"cosmosaccpub1zcjduc3qyx6hlf825jcnj39adpkaxjer95q7yvy25yhfj3dmqy2ctev0rxmse9cuak"
            }
        ]
}

However, currently, the response of /keys (get) in gaiacli rest-server is like this:

[
	{
		"name":"monkey",
		"address":"cosmosaccaddr1fedh326uxqlxs8ph9ej7cf854gz7fd5zlym5pd",
		"pub_key":"cosmosaccpub1zcjduc3q8s8ha96ry4xc5xvjp9tr9w9p0e5lk5y0rpjs5epsfxs4wmf72x3shvus0t"
	},
	{
		"name":"test",
		"address":"cosmosaccaddr1thlqhjqw78zvcy0ua4ldj9gnazqzavyw4eske2",
		"pub_key":"cosmosaccpub1zcjduc3qyx6hlf825jcnj39adpkaxjer95q7yvy25yhfj3dmqy2ctev0rxmse9cuak"
	}
]

I wonder if the wrapper is necessary. Because the wrapper may bring in some additional work for user who want to switch from "gaiacli rest-server" to "gaiacli lite-server"

jackzampolin · 2018-08-27T18:06:18Z

@HaoyangLiu Lets leave off the wrapper and update the documentation accordingly. You can add the docs update to this PR.

abelliumnt · 2018-08-28T09:02:15Z

So far, I have implemented all rest APIs in ICS0, ICS1, ICS20 and ICS21. As for ICS22 and ICS23, I will implement them in later PR.

alexanderbez

This is a big PR, so I left some initial comments on the client stuff first. Will continue reviewing 👍

Thanks for the work!

alexanderbez · 2018-08-28T17:58:43Z

client/context/context.go

@@ -10,6 +10,7 @@ import (
 "github.com/spf13/viper"

 rpcclient "github.com/tendermint/tendermint/rpc/client"
+ tendermintLite"github.com/tendermint/tendermint/lite"


formatting error

alexanderbez · 2018-08-28T17:59:01Z

client/context/context.go

+func (ctx CLIContext) WithClientManager(clientManager *ClientManager) CLIContext {
+ ctx.ClientManager = clientManager
+ return ctx
+}


Missing newline.

alexanderbez · 2018-08-28T18:10:49Z

client/context/loadbalancing.go

@@ -0,0 +1,46 @@
+package context


Seems like this entire needs to be formatted correctly. Also, it should probably be renamed to client_manager.go

alexanderbez · 2018-08-28T18:11:14Z

client/context/loadbalancing.go

+type ClientManager struct {
+ clients []rpcclient.Client
+ currentIndex int
+ mutex sync.RWMutex


I think it'll suffice to just have a write only mutex here (I don't see any logic that obtains a read-lock).

Do you mean use sync.Mutex instead?

alexanderbez · 2018-08-28T18:12:32Z

client/context/loadbalancing.go

+ mgr.currentIndex = 0
+ }
+ return client
+}


Missing new line.

alexanderbez · 2018-08-28T18:43:50Z

client/context/query.go

@@ -281,6 +305,50 @@ func (ctx CLIContext) ensureBroadcastTx(txBytes []byte) error {
 return nil
 }

+// proofVerify perform response proof verification
+func (ctx CLIContext) proofVerify(path string, resp abci.ResponseQuery) error {


verifyProof sounds better I think.

alexanderbez · 2018-08-28T18:45:54Z

client/context/query.go

+ }
+
+ // Validate the substore commit hash against trusted appHash
+ substoreCommitHash, err := store.VerifyMultiStoreCommitInfo(multiStoreProof.StoreName, multiStoreProof.CommitIDList, commit.Header.AppHash)


I think we can break this call into multiple lines for legibility.

alexanderbez · 2018-08-28T18:46:34Z

client/context/query.go

@@ -300,10 +368,15 @@ func (ctx CLIContext) query(path string, key cmn.HexBytes) (res []byte, err erro
 }

 resp := result.Response
- if !resp.IsOK() {


Is resp.IsOK() invalid?

Sorry. Maybe it is a mistake in code merging. I have changed it to resp.IsOK which seems more elegant

alexanderbez · 2018-08-28T18:47:37Z

client/context/query.go

+// proofVerify perform response proof verification
+func (ctx CLIContext) proofVerify(path string, resp abci.ResponseQuery) error {
+ // Data from trusted node or subspace query doesn't need verification
+ if ctx.TrustNode || !isQueryStoreWithProof(path) {


I think the !isQueryStoreWithProof(path) should be moved outside to the caller. This provides a better abstraction.

alexanderbez · 2018-08-28T18:48:05Z

client/context/query.go

+ if len(paths) != 3 {
+ return false
+ }
+ // WARNING This should be consistent with query method in iavlstore.go


Can you elaborate on this warning and why we need it? What needs to be done about it?

In iavlstore.go, proof will be included in response only when the query path is /store or /key. I concern that this may be changed in iavlstore.go. If there are some changes about proof building in iavlstore.go, then we must change code here to be consistent with the changes.

abelliumnt · 2018-08-29T03:39:45Z

Please move to #2177.
I'm so sorry for bring in troubles to all of you.

cwgoes · 2018-08-29T12:52:30Z

Closing in favor of #2177 (as intended @HaoyangLiu?)

HaoyangLiu added 17 commits August 16, 2018 15:52

lcd implemeation

34548db

Add golang dependency for swagger

eccb889

Add key rest api

2047673

Add stake query api to lcd swagger

85f47d2

Merge branch 'bianjie/lcd' of https://github.com/cosmos/cosmos-sdk in…

187dda4

…to haoyang/lcd-implementation

Refactor code according to lint result

26af936

Refactor comment and fix test failure

4607ca9

Add lcd test for swagger lcd

7528534

Fix for test lint warnning

473fe21

Refactor comment

95e367a

Add new test for lcd with swagger

9d944b0

Refactor lcd according to code review

f266472

Refactor code according to code review

6cdf21d

Fix errors in test_cover and test_lint

9409e73

Merge branch 'haoyang/lcd-implementation-develop' into haoyang/lcd-im…

8e843bc

…plementation-new

Add new stake api and remove advanced command

70aa433

Merge pull request #5 from HaoyangLiu/haoyang/lcd-implementation-new

7eda13a

Haoyang/lcd implementation new

abelliumnt requested review from cwgoes, ebuchman and rigelrozanski as code owners August 25, 2018 02:39

abelliumnt mentioned this pull request Aug 25, 2018

Bianjie/lcd implementation #2118

Closed

fedekunze reviewed Aug 26, 2018

View reviewed changes

fedekunze approved these changes Aug 26, 2018

View reviewed changes

fedekunze added ready-for-review labels Aug 26, 2018

fedekunze requested a review from jackzampolin August 26, 2018 22:22

Add spec to client.md and add this subcommand to basecli

7a4b019

abelliumnt requested a review from zramsay as a code owner August 27, 2018 03:14

change key apis to accommodate to doc/light/api.md

00c43fa

fedekunze reviewed Aug 27, 2018

View reviewed changes

Refactor lcd related spec

f6ebccf

fedekunze reviewed Aug 27, 2018

View reviewed changes

HaoyangLiu added 3 commits August 28, 2018 15:30

Add missed api in ICS0 and ICS1, remove the response wrapper in api.md

986504f

Fix failures in test_cover and test_lint

9427eb5

Add key sign command and fix test_lint failure in key sign

81f294b

Merge with cosmos develop

b6bb5ff

jackzampolin changed the title ~~Bianjie/lcd implementation~~ R4R: Bianjie/lcd implementation Aug 28, 2018

Fix failure in test_cover and test_lint

ff15759

alexanderbez suggested changes Aug 28, 2018

View reviewed changes

HaoyangLiu added 2 commits August 29, 2018 09:50

Refactor code according to code review feedback

5b250cc

Fix a mistake in previous commit

135473c

abelliumnt mentioned this pull request Aug 29, 2018

Bianjie/lcd implementation #2177

Closed

cwgoes closed this Aug 29, 2018

This was referenced Aug 30, 2018

R4R: Split LCD implementation PR, part one #2192

Merged

WIP: Split LCD implementation PR, part two #2199

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

R4R: Bianjie/lcd implementation #2147

R4R: Bianjie/lcd implementation #2147

abelliumnt commented Aug 25, 2018

fedekunze Aug 26, 2018

fedekunze Aug 26, 2018

fedekunze left a comment

fedekunze Aug 27, 2018

fedekunze Aug 27, 2018

fedekunze Aug 27, 2018

fedekunze Aug 27, 2018

abelliumnt Aug 27, 2018

fedekunze Aug 27, 2018 •

edited

Loading

abelliumnt commented Aug 27, 2018

jackzampolin commented Aug 27, 2018

fedekunze Aug 27, 2018 •

edited

Loading

abelliumnt commented Aug 27, 2018

jackzampolin commented Aug 27, 2018

abelliumnt commented Aug 27, 2018

abelliumnt commented Aug 27, 2018

jackzampolin commented Aug 27, 2018

abelliumnt commented Aug 28, 2018

alexanderbez left a comment

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

abelliumnt Aug 29, 2018

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

abelliumnt Aug 29, 2018

alexanderbez Aug 28, 2018

alexanderbez Aug 28, 2018

abelliumnt Aug 29, 2018

abelliumnt commented Aug 29, 2018

cwgoes commented Aug 29, 2018

R4R: Bianjie/lcd implementation #2147

R4R: Bianjie/lcd implementation #2147

Conversation

abelliumnt commented Aug 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedekunze left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedekunze Aug 27, 2018 • edited Loading

Choose a reason for hiding this comment

abelliumnt commented Aug 27, 2018

jackzampolin commented Aug 27, 2018

fedekunze Aug 27, 2018 • edited Loading

Choose a reason for hiding this comment

abelliumnt commented Aug 27, 2018

jackzampolin commented Aug 27, 2018

abelliumnt commented Aug 27, 2018

abelliumnt commented Aug 27, 2018

jackzampolin commented Aug 27, 2018

abelliumnt commented Aug 28, 2018

alexanderbez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abelliumnt commented Aug 29, 2018

cwgoes commented Aug 29, 2018

fedekunze Aug 27, 2018 •

edited

Loading

fedekunze Aug 27, 2018 •

edited

Loading