Merge PR #2215: Add swagger-ui for gaiacli lite-server

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2
 defaults: &defaults
   working_directory: /go/src/github.com/cosmos/cosmos-sdk
   docker:
-    - image: circleci/golang:1.10.3
+    - image: circleci/golang:1.11.1
   environment:
     GOBIN: /tmp/workspace/bin
 

.gitignore

@@ -17,6 +17,7 @@ docs/_build
 examples/basecoin/app/data
 baseapp/data/*
 client/lcd/keys/*
+client/lcd/statik/statik.go
 mytestnet
 
 # Testing

Gopkg.toml

@@ -67,6 +67,10 @@
   name = "github.com/zondax/ledger-goclient"
   version = "=v0.1.0"
 
+[[constraint]]
+  name = "github.com/rakyll/statik"
+  version = "=v0.1.4"
+
 [prune]
   go-tests = true
   unused-packages = true

Makefile

@@ -32,7 +32,7 @@ TMP_BUILD_TAGS := $(BUILD_TAGS)
 BUILD_TAGS = $(filter-out ledger, $(TMP_BUILD_TAGS))
 endif
 
-build: check-ledger
+build: check-ledger update_gaia_lite_docs
 ifeq ($(OS),Windows_NT)
 	go build $(BUILD_FLAGS) -o build/gaiad.exe ./cmd/gaia/cmd/gaiad
 	go build $(BUILD_FLAGS) -o build/gaiacli.exe ./cmd/gaia/cmd/gaiacli
@@ -44,6 +44,9 @@ endif
 build-linux:
 	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build
 
+update_gaia_lite_docs:
+	@statik -src=client/lcd/swagger-ui -dest=client/lcd -f
+
 build_cosmos-sdk-cli:
 ifeq ($(OS),Windows_NT)
 	go build $(BUILD_FLAGS) -o build/cosmos-sdk-cli.exe ./cmd/cosmos-sdk-cli
@@ -64,7 +67,7 @@ else
 	go build $(BUILD_FLAGS) -o build/democli ./examples/democoin/cmd/democli
 endif
 
-install: check-ledger
+install: check-ledger update_gaia_lite_docs
 	go install $(BUILD_FLAGS) ./cmd/gaia/cmd/gaiad
 	go install $(BUILD_FLAGS) ./cmd/gaia/cmd/gaiacli
 
@@ -179,14 +182,14 @@ test_cover:
 
 test_lint:
 	gometalinter.v2 --config=tools/gometalinter.json ./...
-	!(gometalinter.v2 --exclude /usr/lib/go/src/ --disable-all --enable='errcheck' --vendor ./... | grep -v "client/")
+	!(gometalinter.v2 --exclude /usr/lib/go/src/ --exclude client/lcd/statik/statik.go --disable-all --enable='errcheck' --vendor ./... | grep -v "client/")
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs gofmt -d -s
 	dep status >> /dev/null
 	!(grep -n branch Gopkg.toml)
 
 format:
-	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs gofmt -w -s
-	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs misspell -w
+	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs gofmt -w -s
+	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs misspell -w
 
 benchmark:
 	@go test -bench=. $(PACKAGES_NOSIMULATION)

PENDING.md

@@ -77,6 +77,7 @@ FEATURES
   * [gaia-lite] [\#966](https://github.com/cosmos/cosmos-sdk/issues/966) Add support for `generate_only=true` query argument to generate offline unsigned transactions
   * [gaia-lite] [\#1953](https://github.com/cosmos/cosmos-sdk/issues/1953) Add /sign endpoint to sign transactions generated with `generate_only=true`.
   * [gaia-lite] [\#1954](https://github.com/cosmos/cosmos-sdk/issues/1954) Add /broadcast endpoint to broadcast transactions signed by the /sign endpoint.
+  * [gaia-lite] [\#2113](https://github.com/cosmos/cosmos-sdk/issues/2113) Rename `/accounts/{address}/send` to `/bank/accounts/{address}/transfers`
 
 * Gaia CLI  (`gaiacli`)
   * [cli] Cmds to query staking pool and params

client/context/broadcast.go

@@ -69,6 +69,22 @@ func (ctx CLIContext) BroadcastTxAndAwaitCommit(tx []byte) (*ctypes.ResultBroadc
 	return res, err
 }
 
+// BroadcastTxSync broadcasts transaction bytes to a Tendermint node
+// synchronously.
+func (ctx CLIContext) BroadcastTxSync(tx []byte) (*ctypes.ResultBroadcastTx, error) {
+	node, err := ctx.GetNode()
+	if err != nil {
+		return nil, err
+	}
+
+	res, err := node.BroadcastTxSync(tx)
+	if err != nil {
+		return res, err
+	}
+
+	return res, err
+}
+
 // BroadcastTxAsync broadcasts transaction bytes to a Tendermint node
 // asynchronously.
 func (ctx CLIContext) BroadcastTxAsync(tx []byte) (*ctypes.ResultBroadcastTx, error) {

client/context/context.go

@@ -50,6 +50,7 @@ type CLIContext struct {
 	GenerateOnly  bool
 	fromAddress   types.AccAddress
 	fromName      string
+	Indent        bool
 }
 
 // NewCLIContext returns a new initialized CLIContext with parameters from the
@@ -87,6 +88,7 @@ func NewCLIContext() CLIContext {
 		GenerateOnly:  viper.GetBool(client.FlagGenerateOnly),
 		fromAddress:   fromAddress,
 		fromName:      fromName,
+		Indent:        viper.GetBool(client.FlagIndentResponse),
 	}
 }
 

client/flags.go

@@ -17,24 +17,25 @@ const (
 	DefaultGasLimit      = 200000
 	GasFlagSimulate      = "simulate"
 
-	FlagUseLedger     = "ledger"
-	FlagChainID       = "chain-id"
-	FlagNode          = "node"
-	FlagHeight        = "height"
-	FlagGas           = "gas"
-	FlagGasAdjustment = "gas-adjustment"
-	FlagTrustNode     = "trust-node"
-	FlagFrom          = "from"
-	FlagName          = "name"
-	FlagAccountNumber = "account-number"
-	FlagSequence      = "sequence"
-	FlagMemo          = "memo"
-	FlagFee           = "fee"
-	FlagAsync         = "async"
-	FlagJson          = "json"
-	FlagPrintResponse = "print-response"
-	FlagDryRun        = "dry-run"
-	FlagGenerateOnly  = "generate-only"
+	FlagUseLedger      = "ledger"
+	FlagChainID        = "chain-id"
+	FlagNode           = "node"
+	FlagHeight         = "height"
+	FlagGas            = "gas"
+	FlagGasAdjustment  = "gas-adjustment"
+	FlagTrustNode      = "trust-node"
+	FlagFrom           = "from"
+	FlagName           = "name"
+	FlagAccountNumber  = "account-number"
+	FlagSequence       = "sequence"
+	FlagMemo           = "memo"
+	FlagFee            = "fee"
+	FlagAsync          = "async"
+	FlagJson           = "json"
+	FlagPrintResponse  = "print-response"
+	FlagDryRun         = "dry-run"
+	FlagGenerateOnly   = "generate-only"
+	FlagIndentResponse = "indent"
 )
 
 // LineBreak can be included in a command list to provide a blank line
@@ -47,6 +48,7 @@ var (
 // GetCommands adds common flags to query commands
 func GetCommands(cmds ...*cobra.Command) []*cobra.Command {
 	for _, c := range cmds {
+		c.Flags().Bool(FlagIndentResponse, false, "Add indent to JSON response")
 		c.Flags().Bool(FlagTrustNode, false, "Trust connected full node (don't verify proofs for responses)")
 		c.Flags().Bool(FlagUseLedger, false, "Use a connected Ledger device")
 		c.Flags().String(FlagChainID, "", "Chain ID of tendermint node")
@@ -63,6 +65,7 @@ func GetCommands(cmds ...*cobra.Command) []*cobra.Command {
 // PostCommands adds common flags for commands to post tx
 func PostCommands(cmds ...*cobra.Command) []*cobra.Command {
 	for _, c := range cmds {
+		c.Flags().Bool(FlagIndentResponse, false, "Add indent to JSON response")
 		c.Flags().String(FlagFrom, "", "Name or address of private key with which to sign")
 		c.Flags().Int64(FlagAccountNumber, 0, "AccountNumber number to sign the tx")
 		c.Flags().Int64(FlagSequence, 0, "Sequence number to sign the tx")

client/lcd/lcd_test.go

@@ -372,8 +372,9 @@ func TestCoinSendGenerateSignAndBroadcast(t *testing.T) {
 
 	// broadcast tx
 	broadcastPayload := struct {
-		Tx auth.StdTx `json:"tx"`
-	}{Tx: signedMsg}
+		Tx     auth.StdTx `json:"tx"`
+		Return string     `json:"return"`
+	}{Tx: signedMsg, Return: "block"}
 	json, err = cdc.MarshalJSON(broadcastPayload)
 	require.Nil(t, err)
 	res, body = Request(t, port, "POST", "/tx/broadcast", json)
@@ -851,7 +852,7 @@ func doSendWithGas(t *testing.T, port, seed, name, password string, addr sdk.Acc
 		}
 	}`, coinbz, gasStr, gasAdjustmentStr, name, password, chainID, accnum, sequence))
 
-	res, body = Request(t, port, "POST", fmt.Sprintf("/accounts/%s/send%v", receiveAddr, queryStr), jsonStr)
+	res, body = Request(t, port, "POST", fmt.Sprintf("/bank/accounts/%s/transfers%v", receiveAddr, queryStr), jsonStr)
 	return
 }
 

client/lcd/root.go

@@ -18,6 +18,7 @@ import (
 	slashing "github.com/cosmos/cosmos-sdk/x/slashing/client/rest"
 	stake "github.com/cosmos/cosmos-sdk/x/stake/client/rest"
 	"github.com/gorilla/mux"
+	"github.com/rakyll/statik/fs"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	cmn "github.com/tendermint/tendermint/libs/common"
@@ -46,6 +47,7 @@ func ServeCommand(cdc *codec.Codec) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) (err error) {
 			listenAddr := viper.GetString(flagListenAddr)
 			handler := createHandler(cdc)
+			registerSwaggerUI(handler)
 			logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout)).With("module", "rest-server")
 			maxOpen := viper.GetInt(flagMaxOpenConnections)
 			sslHosts := viper.GetString(flagSSLHosts)
@@ -121,14 +123,15 @@ func ServeCommand(cdc *codec.Codec) *cobra.Command {
 	cmd.Flags().String(client.FlagNode, "tcp://localhost:26657", "Address of the node to connect to")
 	cmd.Flags().Int(flagMaxOpenConnections, 1000, "The number of maximum open connections")
 	cmd.Flags().Bool(client.FlagTrustNode, false, "Trust connected full node (don't verify proofs for responses)")
+	cmd.Flags().Bool(client.FlagIndentResponse, false, "Add indent to JSON response")
 	viper.BindPFlag(client.FlagTrustNode, cmd.Flags().Lookup(client.FlagTrustNode))
 	viper.BindPFlag(client.FlagChainID, cmd.Flags().Lookup(client.FlagChainID))
 	viper.BindPFlag(client.FlagNode, cmd.Flags().Lookup(client.FlagNode))
 
 	return cmd
 }
 
-func createHandler(cdc *codec.Codec) http.Handler {
+func createHandler(cdc *codec.Codec) *mux.Router {
 	r := mux.NewRouter()
 
 	kb, err := keys.GetKeyBase() //XXX
@@ -154,6 +157,15 @@ func createHandler(cdc *codec.Codec) http.Handler {
 	return r
 }
 
+func registerSwaggerUI(r *mux.Router) {
+	statikFS, err := fs.New()
+	if err != nil {
+		panic(err)
+	}
+	staticServer := http.FileServer(statikFS)
+	r.PathPrefix("/swagger-ui/").Handler(http.StripPrefix("/swagger-ui/", staticServer))
+}
+
 func validateCertKeyFiles(certFile, keyFile string) error {
 	if keyFile == "" {
 		return errors.New("a key file is required")

client/lcd/statik/init.go

@@ -0,0 +1,3 @@
+package statik
+
+//This just for fixing the error in importing empty github.com/cosmos/cosmos-sdk/client/lcd/statik

client/lcd/swagger-ui/index.html

@@ -0,0 +1,60 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="swagger-ui.css" >
+    <link rel="icon" type="image/png" href="favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="favicon-16x16.png" sizes="16x16" />
+    <style>
+      html
+      {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+      }
+
+      *,
+      *:before,
+      *:after
+      {
+        box-sizing: inherit;
+      }
+
+      body
+      {
+        margin:0;
+        background: #fafafa;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+
+    <script src="swagger-ui-bundle.js"> </script>
+    <script src="swagger-ui-standalone-preset.js"> </script>
+    <script>
+    window.onload = function() {
+
+      // Build a system
+      const ui = SwaggerUIBundle({
+        url: "./swagger.yaml",
+        dom_id: '#swagger-ui',
+        deepLinking: true,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIStandalonePreset
+        ],
+        plugins: [
+          SwaggerUIBundle.plugins.DownloadUrl
+        ],
+        layout: "StandaloneLayout"
+      })
+
+      window.ui = ui
+    }
+  </script>
+  </body>
+</html>