Bianjie/lcd implementation #2118

HaoyangLiu · 2018-08-22T03:09:26Z

Lcd spec location: https://github.com/cosmos/cosmos-sdk/tree/adrian/lcd_spec_final/docs/light
Main new feature:

Add query store proof verification
Add swagger-ui
Lcd can connect to multiply full nodes and will do load balancing
Support modular APIs. Currently we only support key management, token query, token send, stake query, node version query.

Test report:
https://github.com/HaoyangLiu/cosmos-sdk/blob/haoyang/lcd-test/docs/light/Cosmos-LCD-Test-Report.md

Closes #525

update

…to bianjie/lcd

…to haoyang/lcd-implementation

Haoyang/lcd implementation

Refactor code according to lint result

Haoyang/lcd implementation

HaoyangLiu · 2018-08-22T03:17:27Z

@jaekwon @jackzampolin
This is bianjie lcd implementation which has brought in proof verification and swagger-ui. Please help take a look at this pull request. Thanks

fedekunze

Hi @HaoyangLiu, thanks so much for the work here. Could you change every reference of LCD to Gaia-lite ?

fedekunze · 2018-08-22T09:06:54Z

client/context/context.go

@@ -113,3 +116,15 @@ func (ctx CLIContext) WithUseLedger(useLedger bool) CLIContext {
 	ctx.UseLedger = useLedger
 	return ctx
 }
+
+// WithCert - return a copy of the context with an updated Cert


Use Tendermint Lint to avoid verbose comments. You won't need to add the function name at the beginning of the comment with it

fedekunze · 2018-08-22T09:19:22Z

store/rootmultistore.go

@@ -288,6 +288,23 @@ func (rs *rootMultiStore) Query(req abci.RequestQuery) abci.ResponseQuery {
 	// trim the path and make the query
 	req.Path = subpath
 	res := queryable.Query(req)
+
+	// WARNING This should be consistent with query method in iavlstore.go


Can you open a separate issue for this warning ?

fedekunze · 2018-08-22T09:23:25Z

x/bank/client/rest/sendtx.go

+// RegisterSwaggerRoutes - Central function to define routes that get registered by the main application
+func RegisterSwaggerRoutes(routerGroup *gin.RouterGroup, ctx context.CLIContext, cdc *wire.Codec, kb keys.Keybase) {
+	routerGroup.POST("/accounts/:address/send", sendRequestFn(cdc, ctx, kb))
+	routerGroup.POST("/create_transfer", createTransferTxForSignFn(cdc, ctx))


was changed to transfers. See #1979

fedekunze · 2018-08-22T09:25:48Z

x/bank/client/rest/sendtx.go

+func RegisterSwaggerRoutes(routerGroup *gin.RouterGroup, ctx context.CLIContext, cdc *wire.Codec, kb keys.Keybase) {
+	routerGroup.POST("/accounts/:address/send", sendRequestFn(cdc, ctx, kb))
+	routerGroup.POST("/create_transfer", createTransferTxForSignFn(cdc, ctx))
+	routerGroup.POST("/signed_transfer", composeAndBroadcastSignedTransferTxFn(cdc, ctx))


I would also suggest to change it to transfers and add a boolean parameter called signed in POST body. cc: @jackzampolin

add a boolean parameter called signed in POST body

Could you clarify this? Do you mean merge /create_transfer and /signed_transfer into one rest api, such as /bank/transfers? I think this sound weird. How do you think about this? @jackzampolin

Here we are adding to the transfers resource so the restful route here would be POST /bank/transfers. It sounds like this route has two different behaviors:

Create a transaction formatted for signing

Create a transaction, sign and send this transaction.

I think the dominant behavior here would be to send a transaction and the transaction generation is more secondary. In the CLI we plan to handle this workflow (generate, sign,send) by adding a --generate-only flag to commands that normally do all 3.

The analogue here would be to add a query param (maybe ?generate=true) that enables the generation behavior. What do you think @fedekunze @HaoyangLiu

Send query param in post request doesn't make sense semantically: explanation

I have another idea:
The below is the post body.

type sendBody struct { Name string `json:"name"` Password string `json:"password"` Amount sdk.Coins `json:"amount"` ChainID string `json:"chain_id"` AccountNumber int64 `json:"account_number"` Sequence int64 `json:"sequence"` Gas int64 `json:"gas"` Fee string `json:"fee"` }

If both the two fields ("name" and "password") are not empty, then the transaction will be signed and broadcasted. If not, only generate a transaction and return the transaction bytes to user.
What do you think about this idea? @jackzampolin @fedekunze

I agree with the explanation above. I like your idea more but I'd propose a slight change to it, since currently name and password are also used for testing automation purposes:

type sendBody struct { Name string `json:"name"` Password string `json:"password"` Amount sdk.Coins `json:"amount"` ChainID string `json:"chain_id"` AccountNumber int64 `json:"account_number"` Sequence int64 `json:"sequence"` Gas int64 `json:"gas"` Fee string `json:"fee"` Signed bool `json:"signed"` // true by default }

@jackzampolin thoughts ?

fedekunze · 2018-08-22T18:09:55Z

client/context/context.go

+
+// WithClientMgr - return a copy of the context with an updated ClientMgr
+func (ctx CLIContext) WithClientMgr(clientMgr *ClientManager) CLIContext {
+	ctx.ClientMgr = clientMgr


change ctx.ClientMgr to ctx.ClientManager

fedekunze · 2018-08-22T18:11:31Z

client/context/loadbalancing.go

+	return nil, errors.New("missing node URIs")
+}
+
+func (mgr *ClientManager) getClient() rpcclient.Client {


(mgr *ClientManager) ––> (manager *ClientManager)

fedekunze · 2018-08-22T18:14:04Z

client/context/query.go

@@ -277,6 +284,7 @@ func (ctx CLIContext) ensureBroadcastTx(txBytes []byte) error {
 	return nil
 }

+// nolint: gocyclo


refactor the function and split it into smaller ones instead

fedekunze · 2018-08-22T18:18:29Z

client/keys/add.go

@@ -236,6 +239,85 @@ func AddNewKeyRequestHandler(w http.ResponseWriter, r *http.Request) {
 	w.Write(bz)
 }

+// AddNewKeyRequest is the handler of adding new key in swagger rest server
+// nolint: gocyclo


same here. Refactor and split

fedekunze · 2018-08-22T18:37:36Z

client/keys/add.go

+		httputils.NewError(gtx, http.StatusBadRequest, err)
+		return
+	}
+	err = json.Unmarshal(body, &m)


Use cdc.UnmarshalJSON for consistency

fedekunze · 2018-08-22T18:40:29Z

client/keys/delete.go

+	var kb keys.Keybase
+	var m DeleteKeyBody
+
+	if err := gtx.BindJSON(&m); err != nil {


use cdc.UnmarshalJSON

fedekunze · 2018-08-22T18:42:52Z

client/keys/list.go

+		httputils.NewError(gtx, http.StatusInternalServerError, err)
+		return
+	}
+	output, err := json.MarshalIndent(keysOutput, "", "  ")


cdc.MarshalJSON

fedekunze · 2018-08-22T18:43:05Z

client/keys/show.go

+		httputils.NewError(gtx, http.StatusInternalServerError, err)
+		return
+	}
+	output, err := json.MarshalIndent(keyOutput, "", "  ")


cdc.MarshalJSON

fedekunze · 2018-08-22T18:43:44Z

client/keys/update.go

+	var kb keys.Keybase
+	var m UpdateKeyBody
+
+	if err := gtx.BindJSON(&m); err != nil {


cdc.UnmarshalJSON

jackzampolin · 2018-08-22T21:02:32Z

Another issue thats applicable here: #2113

Refactor lcd code according to code reviewers

Fix errors in test_cover and test_lint

HaoyangLiu · 2018-08-24T08:00:41Z

I have refactor the code according to your feedback. Please take a look at the newest change.

fedekunze · 2018-08-24T17:32:48Z

@HaoyangLiu random question... why did you selected bianjie/lcd as base branch instead of develop ?

jackzampolin · 2018-08-24T17:33:00Z

client/lcd/root.go

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


Can we use a different name here? This is going to sit in the gaiacli command, so maybe something like gaiacli lite serve?

HaoyangLiu · 2018-08-25T01:54:33Z

@fedekunze That is a long story. Previously, adrianbrink suggested me to create a PR to
adrian/lcd-implementation branch, then create PR from adrian/lcd-implementation to develop. I just follow this. So how above I create another PR to develop and add missed APIs (GET /stake/pool and GET /stake/parameters)? @fedekunze @jaekwon @jackzampolin

HaoyangLiu · 2018-08-25T02:51:20Z

I have created another PR to develop, please move to the new PR: #2147

fedekunze · 2018-08-26T21:54:58Z

@HaoyangLiu why was this reopened ?

HaoyangLiu · 2018-08-27T00:04:10Z

Hi @fedekunze, I'm sorry for misleading. I reopen it just in case someone may miss these two PRs about lcd. Please move to new PR #2147. This one will be closed soon.

Haifeng Xi and others added 21 commits July 11, 2018 14:38

Merge pull request #8 from cosmos/master

6aa8309

update

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk

21e36b5

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk

22161af

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk

4e61859

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk

170daf3

lcd implemeation

34548db

Add golang dependency for swagger

eccb889

Add key rest api

2047673

Add stake query api to lcd swagger

85f47d2

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk

8e0ca8d

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

60acd5c

…to bianjie/lcd

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

187dda4

…to haoyang/lcd-implementation

Merge pull request #58 from HaoyangLiu/haoyang/lcd-implementation

22495e9

Haoyang/lcd implementation

Refactor code according to lint result

26af936

Merge pull request #63 from HaoyangLiu/haoyang/lcd-implementation

4a0d1c5

Refactor code according to lint result

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

Merge pull request #66 from HaoyangLiu/haoyang/lcd-implementation

fc40419

Haoyang/lcd implementation

HaoyangLiu requested review from cwgoes, ebuchman and rigelrozanski as code owners August 22, 2018 03:09

fedekunze suggested changes Aug 22, 2018

View reviewed changes

fedekunze reviewed Aug 22, 2018

View reviewed changes

HaoyangLiu added 2 commits August 23, 2018 19:25

Refactor lcd according to code review

f266472

Refactor code according to code review

6cdf21d

HaoyangLiu mentioned this pull request Aug 24, 2018

Refactor lcd code according to code reviewers irisnet/cosmos-sdk#73

Merged

wukongcheng and others added 3 commits August 24, 2018 11:57

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

79ec713

Refactor lcd code according to code reviewers

Fix errors in test_cover and test_lint

9409e73

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

9ff57af

Fix errors in test_cover and test_lint

jackzampolin reviewed Aug 24, 2018

View reviewed changes

HaoyangLiu mentioned this pull request Aug 25, 2018

R4R: Bianjie/lcd implementation #2147

Closed

HaoyangLiu closed this Aug 25, 2018

HaoyangLiu reopened this Aug 26, 2018

HaoyangLiu closed this Aug 28, 2018

fedekunze mentioned this pull request Aug 29, 2018

Bianjie/lcd implementation #2177

Closed

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

Bianjie/lcd implementation #2118

Bianjie/lcd implementation #2118

HaoyangLiu commented Aug 22, 2018 •

edited by fedekunze

Loading

HaoyangLiu commented Aug 22, 2018

fedekunze left a comment

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018 •

edited

Loading

fedekunze Aug 22, 2018 •

edited

Loading

HaoyangLiu Aug 22, 2018

jackzampolin Aug 22, 2018

HaoyangLiu Aug 23, 2018

fedekunze Aug 23, 2018

fedekunze Aug 22, 2018 •

edited

Loading

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018 •

edited

Loading

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018

fedekunze Aug 22, 2018

jackzampolin commented Aug 22, 2018

HaoyangLiu commented Aug 24, 2018

fedekunze commented Aug 24, 2018

jackzampolin Aug 24, 2018

HaoyangLiu commented Aug 25, 2018

HaoyangLiu commented Aug 25, 2018

fedekunze commented Aug 26, 2018

HaoyangLiu commented Aug 27, 2018

Bianjie/lcd implementation #2118

Bianjie/lcd implementation #2118

Conversation

HaoyangLiu commented Aug 22, 2018 • edited by fedekunze Loading

HaoyangLiu commented Aug 22, 2018

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

fedekunze Aug 22, 2018 • edited Loading

Choose a reason for hiding this comment

fedekunze Aug 22, 2018 • edited Loading

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 22, 2018 • edited Loading

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 22, 2018 • edited Loading

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

jackzampolin commented Aug 22, 2018

HaoyangLiu commented Aug 24, 2018

fedekunze commented Aug 24, 2018

Choose a reason for hiding this comment

HaoyangLiu commented Aug 25, 2018

HaoyangLiu commented Aug 25, 2018

fedekunze commented Aug 26, 2018

HaoyangLiu commented Aug 27, 2018

HaoyangLiu commented Aug 22, 2018 •

edited by fedekunze

Loading

fedekunze Aug 22, 2018 •

edited

Loading

fedekunze Aug 22, 2018 •

edited

Loading

fedekunze Aug 22, 2018 •

edited

Loading

fedekunze Aug 22, 2018 •

edited

Loading