Tx CLI proto module interface (#5989)

* WIP * WIP * WIP on removing x/auth dependency from client/tx * Revert unneeded changes * Simplify cli tx UX * Wire up bank tx REST routes * Fix assignment issue * Wire up bank NewSendTxCmd * fix lint * revert file * revert file * fix simcli * Refactor AccountRetriever * Fix build * Fix build * Fix build * Fix integration tests * Fix tests * Docs, linting * Linting * WIP on all modules * Implement other module new tx cmd's * Fix cmd's * Refactor existing GetTxCmd * Fix cmd * Removing deprecated code * Update ADR 020 & CHANGELOG * Lint * Lint * Lint * Lint * Lint * Lint * Lint * Fix client/tx tests * Fix mocks * Fix tests * Lint fixes * REST tx migration * Wire up REST * Linting * Update CHANGELOG, docs * Fix tests * lint * Address review feedback * Update CHANGELOG.md Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com> * Update CHANGELOG.md Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com> * group vars Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
2020-05-21 21:29:34 +00:00
parent 970e009653
commit 850419fffd
71 changed files with 879 additions and 1734 deletions
@@ -297,17 +297,19 @@ and messages.

 ```go
 type AccountRetriever interface {
-  EnsureExists(addr sdk.AccAddress) error
-  GetAccountNumberSequence(addr sdk.AccAddress) (uint64, uint64, error)
+  EnsureExists(querier NodeQuerier, addr sdk.AccAddress) error
+  GetAccountNumberSequence(querier NodeQuerier, addr sdk.AccAddress) (uint64, uint64, error)
 }

 type Generator interface {
-  NewTx() ClientTx
+  NewTx() TxBuilder
+  NewFee() ClientFee
+  NewSignature() ClientSignature
+  MarshalTx(tx types.Tx) ([]byte, error)
 }

-type ClientTx interface {
-  sdk.Tx
-  codec.ProtoMarshaler
+type TxBuilder interface {
+  GetTx() sdk.Tx

  SetMsgs(...sdk.Msg) error
  GetSignatures() []sdk.Signature
@@ -321,11 +323,29 @@ type ClientTx interface {
 }
 ```

-We then update `CLIContext` to have a new field: `Marshaler`.
+We then update `CLIContext` to have new fields: `JSONMarshaler`, `TxGenerator`,
+and `AccountRetriever`, and we update `AppModuleBasic.GetTxCmd` to take
+a `CLIContext` which should have all of these fields pre-populated.

-Then, each module's client handler will at the minimum accept a `Marshaler` instead
-of a concrete Amino codec and a `Generator` along with an `AccountRetriever` so
-that account fields can be retrieved for signing.
+Each client method should then use one of the `Init` methods to re-initialize
+the pre-populated `CLIContext`. `tx.GenerateOrBroadcastTx` can be used to
+generate or broadcast a transaction. For example:
+
+```go
+import "github.com/spf13/cobra"
+import "github.com/cosmos/cosmos-sdk/client/tx"
+import "github.com/cosmos/cosmos-sdk/client/context"
+
+func NewCmdDoSomething(ctx context.CLIContext) *cobra.Command {
+	return &cobra.Command{
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := ctx.InitWithInput(cmd.InOrStdin())
+			msg := NewSomeMsg{...}
+			tx.GenerateOrBroadcastTx(cliCtx, msg)
+		},
+	}
+}
+```

 ## Future Improvements