Implement Gaia-lite LCD Spec #2113

jackzampolin · 2018-08-21T15:04:59Z

This issue is to track implementation of the newly accepted LCD API spec (#1979). Each of the interchain standards needs to be checked to ensure that it is brought up to spec. The input, return and error values in the spec also need to be updated for each endpoint. Those updates should accompany code changes. Below is a list of the ICS and their endpoints to track progress.

ICS0
- POST /txs
- POST /tx/sign
- POST /tx/broadcast
ICS1
- GET /keys
- POST /keys
- GET /keys/seed
- GET /keys/{name}
- PUT /keys/{name}
- DELETE /keys/{name}
- POST /keys/{name}/recover
- GET /auth/accounts/{address}
ICS20
- GET /bank/balances/{address}
- POST /bank/accounts/{address}/transfers
ICS 21
- GET /stake/delegators/{delegatorAddr}/validators
- GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}
- GET /stake/delegators/{delegatorAddr}/txs
- GET /stake/delegators/{delegatorAddr}/delegations Split GET delegators/{address} endpoint #2258
- GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}
- GET /stake/delegators/{delegatorAddr}/unbonding_delegations Split GET delegators/{address} endpoint #2258
- GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}
- GET /stake/delegators/{delegatorAddr}/redelegations Split GET delegators/{address} endpoint #2258
- GET /stake/redelegations? Add GET redelegation endpoint and querier #2182
- POST /stake/delegators/{delegatorAddr}/delegations Split POST delegations endpoint #2191
- POST /stake/delegators/{delegatorAddr}/unbonding_delegations Split POST delegations endpoint #2191
- POST /stake/delegators/{delegatorAddr}/redelegations Split POST delegations endpoint #2191
- GET /stake/validators
- GET /stake/validators/{validatorAddr}
- GET /stake/validators/{validatorAddr}/delegations Add cmd and endpoints to get validator delegations #2027
- GET /stake/validators/{validatorAddr}/unbonding_delegations Get unbonding_delegations and redelegations from a validator #2477
- GET /stake/validators/{validatorAddr}/redelegations Get unbonding_delegations and redelegations from a validator #2477
- GET /stake/parameters
- GET /stake/pool
ICS 22
- GET /gov/proposals
- GET /gov/proposals/{proposalId}
- GET /gov/proposals/{proposalId}/deposits Query all deposits on a governance proposal #2478
- GET /gov/proposals/{proposalId}/deposits/{address}
- GET /gov/proposals/{proposalId}/votes
- GET /gov/proposals/{proposalId}/votes/{address}
- GET /gov/parameters Query governance paramaters #2479
- POST /gov/proposals
- POST /gov/proposals/{proposalId}/deposits
- POST /gov/proposals/{proposalId}/votes
ICS 23
- GET /slashing/validators/{validatorPubKey}/signing-info [R4R]: add swagger-ui for gov, stake and slashing #2462
- GET /slashing/parameters Query Slashing Parameters #2399
- POST /slashing/validators/{validatorAddr}/unjail Rename revoke(d) to jail(ed) #2120 [R4R]: add swagger-ui for gov, stake and slashing #2462

cc @fedekunze

The text was updated successfully, but these errors were encountered:

gamarin2 · 2018-08-21T15:47:35Z

Also needed prelaunch, but not in the current spec: signing endpoint in key API.

cc @adrianbrink

jackzampolin · 2018-08-21T18:17:17Z

Can we open a PR on the spec for that @gamarin2 ?

gamarin2 · 2018-08-21T20:24:34Z

@adrianbrink is supposed to do it

faboweb · 2018-08-22T10:44:15Z

GET /bank/balance/{account} should be GET /bank/balances/{account}?
GET /slashing/validator/{validatorAddr}/signing-info should be GET /slashing/validators/{validatorAddr}/signing-info?

jackzampolin · 2018-08-22T21:01:35Z

Thank you for checking my work there @faboweb

jackzampolin · 2018-08-27T16:13:16Z

I just added one here: POST /keys/{name}/sign to sign an unsigned transaction. To accompany this and mirror the CLI, each of the routes that produce transactions need to have a ?generate= param that defaults to false, which when set to true returns only the sign bytes for the transaction.

siman · 2018-08-29T00:42:10Z

Sorry for off-topic, but what does an LCD abbreviation mean?

alexanderbez · 2018-08-29T01:14:21Z

@siman iirc, light (lite?) client daemon 👍

fedekunze · 2018-08-29T14:47:02Z

Just realized we missed GET /stake/delegators/{delegatorAddr}/redelegations/{validatorAddr} to the list that still needs to be implemented and added to the documentation

fedekunze · 2018-08-30T09:33:52Z

Also adding GET stake/validators/{validatorAddr}/delegators and GET stake/validators/{validatorAddr}/delegations as discussed in #2027

fedekunze · 2018-08-30T09:57:09Z

Proposal for splitting the POST delegation endpoint: #2191 . CC: @jackzampolin

fedekunze · 2018-09-13T20:57:33Z

I just added one here: POST /keys/{name}/sign to sign an unsigned transaction. To accompany this and mirror the CLI, each of the routes that produce transactions need to have a ?generate= param that defaults to false, which when set to true returns only the sign bytes for the transaction.

@jackzampolin it was renamed to tx/sign. Should rename it ? Personally I'm in favour of it

abelliumnt · 2018-09-23T07:23:53Z

[ ] ICS0

POST /txs

[ ] ICS1

GET /keys

POST /keys

GET /keys/seeds Do we really need this endpoint?

GET /keys/{name}

PUT /keys/{name}

DELETE /keys/{name}

POST /keys/{name}/recover

GET /auth/accounts/{address}

POST /keys/{name}/sign ***

POST /tx/sign

POST /tx/broadcast

[ ] ICS20

GET /bank/balances/{account}

POST /bank/transfers

@jackzampolin
I have some thoughts above the following APIs:

POST /txs and POST /tx/broadcast: They are duplicate.
POST /tx/sign and POST /keys/{name}/sign : I think the only thing need to be signed is transaction. So only POST /tx/sign is enough.
GET /bank/balances/{account} and GET /auth/accounts/{address}: They are duplicate.
POST /keys/{name}/recover and POST /keys: POST /keys can add new key. The post body is:

type NewKeyBody struct {
	Name     string `json:"name"`
	Password string `json:"password"`
	Seed     string `json:"seed"`
}

If seed field is not empty, then it will be used to recover a key. So POST /keys/{name}/recover is not necessary.

POST /accounts/{address}/send and POST /bank/transfers: Should we rename POST /accounts/{address}/send to POST /bank/transfers?

abelliumnt · 2018-09-23T07:26:39Z

@jackzampolin @cwgoes
Why we need both gaiacli rest-server and Gaia-lite LCD? I think their functionalities are duplicated. Could you clarify this?

faboweb · 2018-09-25T09:30:39Z

As far as I know: gaiacli rest-server is the command Gaia-lite LCD or better just Gaia-lite is the name for the product/feature.

faboweb · 2018-09-25T09:43:21Z

POST /txs and POST /tx/broadcast: They are duplicate.

Let's keep both. POST /txs is more restful, POST /tx/broadcast feels more familiar to the blockchain domain.

POST /tx/sign and POST /keys/{name}/sign

You are correct. Let's stick with just POST /tx/sign

GET /bank/balances/{account} and GET /auth/accounts/{address}

Let's go with both where GET /bank/balances/{account} returns only balances (not sequence etc.) for the sake of consistency with the token transfer POST and to show the bank module is used.

POST /keys/{name}/recover and POST /keys

Let's use the explicit POST /keys/{name}/recover endpoint for recovery and keep POST /keys for key creation which fails if a seed is provided.

POST /accounts/{address}/send and POST /bank/transfers

I propose to name this endpoint POST /bank/accounts/{address} to stay consistent with the GET request and to make it clear the bank module is used for both requests.

fedekunze · 2018-09-25T10:44:19Z

cc: @faboweb @HaoyangLiu

Let's keep both. POST /txs is more restful, POST /tx/broadcast feels more familiar to the blockchain domain.

The original idea @jackzampolin and I discussed (I don't recall the exact date) is that we should would leave it as POST /txs and have a return parameter in the request body with the desired output: return=<sync|async|block>. But since we are also keeping with POST /tx/sign let's keep the 3 of them

Let's go with both where GET /bank/balances/{account} returns only balances (not sequence etc.) for the sake of consistency with the token transfer POST and to show the bank module is used.

Agree, but lets change GET /bank/balances/{account} to use an /{address} instead

Let's use the explicit POST /keys/{name}/recover endpoint for recovery and keep POST /keys for key creation which fails if a seed is provided.

👍

I propose to name this endpoint POST /bank/accounts/{address} to stay consistent with the GET request and to make it clear the bank module is used for both requests.

From just looking at the endpoint POST /bank/accounts/{address} someone could think that you're creating a new bank account to tied to your {address} (?). What about POST /bank/accounts/{address}/transfers

faboweb · 2018-09-25T10:58:35Z

return parameter in the request body with the desired output: return=<sync|async|block>

I would put them into the request URL and not into the body, so the data stays the same but the handling changes. Plus: Let's do that later.

POST /bank/accounts/{address}/transfers

👍

Agree, but lets change GET /bank/balances/{account} to use an /{address} instead

👍

fedekunze · 2018-09-25T11:23:15Z

Updated list of endpoints according to the most recent discussion

jackzampolin · 2018-10-11T20:59:19Z

Update list.

faboweb · 2018-10-12T09:48:27Z

Follow up of #2336

I propose that we don't bloat the API and remove:

GET /stake/delegators/{delegatorAddr}/redelegations/validator_from/{validatorSrcAddr}/validator_to/{validatorDstAddr}

I don't see a use case for this. I see a usecase making this more general purpose:

GET /stake/delegators/{delegatorAddr}/redelegations/{validatorSrcAddr}

fedekunze · 2018-10-12T16:30:44Z

@faboweb I get your point and I think that would be actually more useful. I even thought initially of the same idea but with GET /stake/delegators/{delegatorAddr}/redelegations/{validatorAddr} (where validatorAddr could be either src or dst).

The thing is that that functionality is not implemented since there's no key for it. The one that's similar is getting the redelegations from a validatorSrcAddr, i.e something like the following:

GET /stake/validators/{validatorSrcAddr}/redelegations

Here's the permalink to the function:

cosmos-sdk/x/stake/keeper/delegation.go

Lines 245 to 258 in c653053

 // return all redelegations from a particular validator 

 func (k Keeper) GetRedelegationsFromValidator(ctx sdk.Context, valAddr sdk.ValAddress) (reds []types.Redelegation) { 

 store := ctx.KVStore(k.storeKey) 

 iterator := sdk.KVStorePrefixIterator(store, GetREDsFromValSrcIndexKey(valAddr)) 

 defer iterator.Close() 

 for ; iterator.Valid(); iterator.Next() { 

 key := GetREDKeyFromValSrcIndexKey(iterator.Key()) 

 value := store.Get(key) 

 red := types.MustUnmarshalRED(k.cdc, key, value) 

 reds = append(reds, red) 

 } 

 return reds 

 }

Am I right @cwgoes ?

fedekunze · 2019-01-03T21:30:53Z

I think this is done, @jackzampolin can we close this ?

jackzampolin · 2019-01-03T23:41:19Z

@fedekunze Can you do the honor as this has been your baby!?

fedekunze · 2019-01-03T23:44:25Z

@fedekunze Can you do the honor as this has been your baby!?

😆 closing this ! 🎊

jackzampolin assigned fedekunze Aug 21, 2018

jackzampolin added API labels Aug 21, 2018

fedekunze mentioned this issue Aug 21, 2018

LCD Scope/Documentation #1312

Closed

jackzampolin mentioned this issue Aug 22, 2018

Bianjie/lcd implementation #2118

Closed

fedekunze mentioned this issue Aug 26, 2018

TokenAPI to specify a common REST interface for all Cosmos zones #1137

Closed

jackzampolin mentioned this issue Aug 27, 2018

R4R: Bianjie/lcd implementation #2147

Closed

This was referenced Aug 29, 2018

Add GET redelegation endpoint and querier #2182

Closed

Expose additional statistics about validators in gaia-light #1506

Closed

fedekunze added the prelaunch label Aug 31, 2018

fedekunze mentioned this issue Sep 1, 2018

GET /auth/accounts/{address} is not working #2206

Closed

fedekunze added the lite label Sep 1, 2018

fedekunze changed the title ~~Implement LCD Spec~~ Implement Gaia-lite LCD Spec Sep 1, 2018

alexanderbez added prelaunch-2.0 and removed prelaunch labels Sep 25, 2018

abelliumnt mentioned this issue Sep 30, 2018

[R4R]: add swagger-ui for gaiacli lite-server #2215

Merged

fedekunze mentioned this issue Oct 11, 2018

R4R: Redelegation endpoint and Querier #2336

Closed

5 tasks

fedekunze added the meta-issue label Oct 16, 2018

fedekunze mentioned this issue Dec 12, 2018

R4R: Redelegation Querier #2559

Merged

5 tasks

jackzampolin mentioned this issue Dec 18, 2018

LCD Purpose #3151

Closed

fedekunze closed this as completed Jan 3, 2019

chillyvee pushed a commit to chillyvee/cosmos-sdk that referenced this issue Mar 1, 2024

Update cosmos-hub-roadmap-2.0.md (cosmos#2113)

690b0c9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Gaia-lite LCD Spec #2113

Implement Gaia-lite LCD Spec #2113

jackzampolin commented Aug 21, 2018 •

edited by fedekunze

Loading

gamarin2 commented Aug 21, 2018

jackzampolin commented Aug 21, 2018

gamarin2 commented Aug 21, 2018

faboweb commented Aug 22, 2018

jackzampolin commented Aug 22, 2018

jackzampolin commented Aug 27, 2018

siman commented Aug 29, 2018

alexanderbez commented Aug 29, 2018 •

edited

Loading

fedekunze commented Aug 29, 2018 •

edited

Loading

fedekunze commented Aug 30, 2018

fedekunze commented Aug 30, 2018

fedekunze commented Sep 13, 2018

abelliumnt commented Sep 23, 2018 •

edited

Loading

abelliumnt commented Sep 23, 2018 •

edited

Loading

faboweb commented Sep 25, 2018

faboweb commented Sep 25, 2018 •

edited by fedekunze

Loading

fedekunze commented Sep 25, 2018 •

edited

Loading

faboweb commented Sep 25, 2018

fedekunze commented Sep 25, 2018

jackzampolin commented Oct 11, 2018

faboweb commented Oct 12, 2018 •

edited

Loading

fedekunze commented Oct 12, 2018 •

edited

Loading

fedekunze commented Jan 3, 2019

jackzampolin commented Jan 3, 2019

fedekunze commented Jan 3, 2019

Implement Gaia-lite LCD Spec #2113

Implement Gaia-lite LCD Spec #2113

Comments

jackzampolin commented Aug 21, 2018 • edited by fedekunze Loading

gamarin2 commented Aug 21, 2018

jackzampolin commented Aug 21, 2018

gamarin2 commented Aug 21, 2018

faboweb commented Aug 22, 2018

jackzampolin commented Aug 22, 2018

jackzampolin commented Aug 27, 2018

siman commented Aug 29, 2018

alexanderbez commented Aug 29, 2018 • edited Loading

fedekunze commented Aug 29, 2018 • edited Loading

fedekunze commented Aug 30, 2018

fedekunze commented Aug 30, 2018

fedekunze commented Sep 13, 2018

abelliumnt commented Sep 23, 2018 • edited Loading

abelliumnt commented Sep 23, 2018 • edited Loading

faboweb commented Sep 25, 2018

faboweb commented Sep 25, 2018 • edited by fedekunze Loading

fedekunze commented Sep 25, 2018 • edited Loading

faboweb commented Sep 25, 2018

fedekunze commented Sep 25, 2018

jackzampolin commented Oct 11, 2018

faboweb commented Oct 12, 2018 • edited Loading

fedekunze commented Oct 12, 2018 • edited Loading

fedekunze commented Jan 3, 2019

jackzampolin commented Jan 3, 2019

fedekunze commented Jan 3, 2019

jackzampolin commented Aug 21, 2018 •

edited by fedekunze

Loading

alexanderbez commented Aug 29, 2018 •

edited

Loading

fedekunze commented Aug 29, 2018 •

edited

Loading

abelliumnt commented Sep 23, 2018 •

edited

Loading

abelliumnt commented Sep 23, 2018 •

edited

Loading

faboweb commented Sep 25, 2018 •

edited by fedekunze

Loading

fedekunze commented Sep 25, 2018 •

edited

Loading

faboweb commented Oct 12, 2018 •

edited

Loading

fedekunze commented Oct 12, 2018 •

edited

Loading