client/rest, cmd/baseserver: started a basecoin REST client #190

odeke-em · 2017-07-29T00:08:38Z

A server that can be ran on port 8998

$ go get -u -v github.com/tendermint/basecoin/cmd/baseserver
$ baseserver init
$ baseserver serve

Implemented:

/keys POST -- generate a new key
/keys GET -- list all keys
/keys/{name} DELETE-- delete a named key
/keys/{name} GET -- get a named key
/keys/{name} POST, PUT -- update a named key
/sign
/build/send: However still needs to be tested and some verifications
needed
/query/account/{signature}: GET -- to query an account's balance

This base code to get the handlers starters was adapted from:

Updates #186

odeke-em · 2017-07-29T00:09:36Z

/cc @ethanfrey PTAL at the first draft of the server to get a base committed. After this first review I'll go back and then update /build/send and init and then we can have an MVP. Thank you!

ethanfrey · 2017-07-29T03:50:21Z

cmd/baseserver/main.go

+	port := 8998
+	router := mux.NewRouter()
+	ctx := rest.Context{
+		Keys: rest.New(keysManager, ""),


You can safely set the default here as "ed25519".

We use it like 97% of the time... secp256k1 is mainly used to make sure other algorithms work

Ah I see, thanks. I'll update it.

ethanfrey · 2017-07-29T03:50:47Z

cmd/baseserver/main.go

+
+	// TODO: Decide whether to use $HOME/.basecli for compatibility
+	// or just use $HOME/.baseserver?
+	cmd := cli.PrepareMainCmd(srvCli, "BC", os.ExpandEnv("$HOME/.basecli"))


Nice job figuring out how to use our system here and just the essentials.

ethanfrey · 2017-07-29T03:52:09Z

client/rest/handlers.go

+	r.HandleFunc("/keys/{name}", k.DeleteKey).Methods("DELETE")
+}
+
+type Context struct {


Looks nice and clean

ethanfrey · 2017-07-29T04:20:10Z

client/rest/types.go

+// Note: Not using the `validator:""` tags here because SendInput has
+// many fields so it would be nice to figure out all the invalid
+// inputs and report them back to the caller, in one shot.
+type SendInput struct {


nice struct here.
reuse of existing structs and pointers for checking missing fields.

ethanfrey · 2017-07-29T04:50:24Z

client/rest/handlers.go

+
+	var tx basecoin.Tx
+	coins := []coin.Coin{*si.Fees}
+	if !si.Multi { // Just doing one transaction


nice call with NewSendOneTx, but multi is a different meaning. It is to control wrapping the last with auth.OneSig or auth.MultiSig.

Ooh I see, thanks for letting me know. I'll do another iteration and work on fixing it up.

ethanfrey · 2017-07-29T04:52:00Z

client/rest/handlers.go

+	}
+
+	tx := sr.Tx
+	if err := SignTx(sr.Name, sr.Password, tx); err != nil {


Looks good.

ethanfrey · 2017-07-29T04:52:33Z

client/rest/handlers.go

+	}
+
+	var tx basecoin.Tx
+	coins := []coin.Coin{*si.Fees}


You need si.Amount for the amount to send

Roger that, thanks I'll update that.

Actually @ethanfrey, si.Fees is a Coin so it contains the amount and denomination, so we are covered here.

ethanfrey · 2017-07-29T04:54:50Z

client/rest/handlers.go

+		tx = coin.NewSendTx(in, out)
+	}
+
+	commit, err := PostTx(tx)


PostTx call should go into another endpoint POST /tx, which accepts a previously signed tx and just posts.

/build constructs the json, but doesn't sign or post.

Something (roughly) like:

tx = NewFeeTx(tx, *si.Fee) tx = NewNonceTx(tx, si.Sequence) tx = NewChainTx(tx, commands.GetChainID()) if multi { tx = auth.NewMulti(tx).Wrap() } else { tx = auth.NewSig(tx).Wrap() }

package names missing, some functions wrong, but basically this idea.

ethanfrey · 2017-07-29T04:56:52Z

Looks good. Very nice to jump into this codebase and get it working.

I left some comments, mainly on /build/send to get you to the right points... they are all under modules.

ethanfrey · 2017-07-29T04:59:18Z

Oh, also, please add a --port flag to the cli. I know this is low prio... just reminding.

```shell $ go get -u -v github.com/tendermint/basecoin/cmd/baseserver $ baseserver init $ baseserver serve ``` A server that can be ran by default on port 8998 otherwise one can specify the port using flag `--port` like this: ```shell $ baseserver serve --port 9999 ``` to serve it on port 9999, accessible at http://localhost:9999 Implemented: - [X] /keys POST -- generate a new key - [X] /keys GET -- list all keys - [X] /keys/{name} DELETE-- delete a named key - [X] /keys/{name} GET -- get a named key - [X] /keys/{name} POST, PUT -- update a named key - [X] /sign POST -- sign a transaction - [X] /build/send POST -- send money from one actor to another. However, still needs testing and verification of output - [X] /tx POST -- post a transaction to the blockchain. However, still needs testing and verification of output This base code to get the handlers starters was adapted from: * https://github.com/tendermint/go-crypto/blob/master/keys/server * https://github.com/tendermint/basecoin/blob/unstable/client/commands/proxy/root.go Updates #186

odeke-em · 2017-07-29T10:14:20Z

Done, thanks, I added the --port flag as well.

odeke-em · 2017-07-29T10:15:03Z

@ethanfrey, thank you for the first round of review! I've updated the PR PTAL.

ethanfrey · 2017-07-29T12:58:03Z

Nice job. Looks much better. There are a few things with build still. I'll make a PR on the PR to clear it up.

ethanfrey · 2017-07-29T13:41:26Z

Oh, I think there is one thing missing... query/account/xyz

You should be able to base very heavily (almost copy-paste) from modules/coin/commands/query.go

Other than that, the MVP looks finished

Allows us to query account balance from the blockchain for example: /query/account/sigs:BDADF167E6CF2CDF2D621E590FF1FED2787A40E0

odeke-em · 2017-07-29T19:27:03Z

@ethanfrey I've updated the PR with /query/account/{signature}, PTAL, thanks!

ethanfrey · 2017-07-29T20:22:34Z

client/rest/handlers.go

+func doAccountQuery(w http.ResponseWriter, r *http.Request) {
+	query := mux.Vars(r)
+	signature := query["signature"]
+	address, errResp := extractAddress(signature)


This works, but no need to run extractAddress... ParseActor does that for you.

Not wrong, just unnecessary

ethanfrey · 2017-07-29T20:23:37Z

client/rest/handlers.go

+		return
+	}
+
+	if err := proofs.OutputProof(account, proof.BlockHeight()); err != nil {


Output proof writes to stdout, no need to call it here, the writeSuccess takes it's place.

ethanfrey · 2017-07-29T20:24:32Z

client/rest/handlers.go

+		writeError(w, err)
+		return
+	}
+	writeSuccess(w, account)


If you look at OutputProof, it just adds an envelope around the data to add height info to the json. You can do it here before writeSuccess.

ethanfrey

Very nice. Just added two comments for cleanup.

I'll merge this in and test it with the frontend guys. Just those comments to note when you do a cleanup.

ethanfrey reviewed Jul 29, 2017

View reviewed changes

Fixed up business logic in build/send

de82c03

odeke-em added 3 commits July 29, 2017 12:05

Merge branch 'tendermint-rest-server-comments' into rest-server

f8c302a

client/rest: implement /query/account/{signature}

c0743af

Allows us to query account balance from the blockchain for example: /query/account/sigs:BDADF167E6CF2CDF2D621E590FF1FED2787A40E0

Merge branch 'rest-server-query' into rest-server

7c28374

ethanfrey reviewed Jul 29, 2017

View reviewed changes

ethanfrey approved these changes Jul 29, 2017

View reviewed changes

ethanfrey merged commit b08b630 into cosmos:feature/186-http-api Jul 29, 2017

odeke-em mentioned this pull request Jul 31, 2017

Add http api to mirror cli commands #186

Closed

This was referenced Mar 22, 2021

[Snyk] Security upgrade vuepress-theme-cosmos from 1.0.179 to 1.0.181 V-services-center/cosmos-sdk#43

Open

[Snyk] Security upgrade vuepress-theme-cosmos from 1.0.172 to 1.0.181 dgpatelgit/cosmos-sdk#3

Open

ParthDesai pushed a commit to ChorusOne/cosmos-sdk that referenced this pull request Apr 19, 2021

Merge PR cosmos#190: RC1 updates

b8e8f5b

snyk-bot mentioned this pull request Jul 6, 2021

[Snyk] Upgrade vuepress-theme-cosmos from 1.0.156 to 1.0.182 terrorizer1980/cosmos-sdk#1

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

client/rest, cmd/baseserver: started a basecoin REST client #190

client/rest, cmd/baseserver: started a basecoin REST client #190

odeke-em commented Jul 29, 2017 •

edited

Loading

odeke-em commented Jul 29, 2017

ethanfrey Jul 29, 2017

odeke-em Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey Jul 29, 2017

odeke-em Jul 29, 2017

ethanfrey Jul 29, 2017

odeke-em Jul 29, 2017

ethanfrey Jul 29, 2017

odeke-em Jul 29, 2017

odeke-em Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey commented Jul 29, 2017

ethanfrey commented Jul 29, 2017

odeke-em commented Jul 29, 2017

odeke-em commented Jul 29, 2017

ethanfrey commented Jul 29, 2017

ethanfrey commented Jul 29, 2017

odeke-em commented Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey Jul 29, 2017

ethanfrey left a comment

client/rest, cmd/baseserver: started a basecoin REST client #190

client/rest, cmd/baseserver: started a basecoin REST client #190

Conversation

odeke-em commented Jul 29, 2017 • edited Loading

odeke-em commented Jul 29, 2017

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

ethanfrey commented Jul 29, 2017

ethanfrey commented Jul 29, 2017

odeke-em commented Jul 29, 2017

odeke-em commented Jul 29, 2017

ethanfrey commented Jul 29, 2017

ethanfrey commented Jul 29, 2017

odeke-em commented Jul 29, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanfrey left a comment

Choose a reason for hiding this comment

odeke-em commented Jul 29, 2017 •

edited

Loading