feat!: Add Textual SignModeHandler

docs/architecture/adr-050-sign-mode-textual.md

@@ -143,8 +143,8 @@ We define "transaction envelope" as all data in a transaction that is not in the
 ```
 Chain ID: <string>
 Account number: <uint64>
-*Public Key: <hex_string>
 Sequence: <uint64>
+*Public Key: <hex_string>
 <TxBody>                                                    // See #8.
 Fee: <coins>                                                // See value renderers for coins encoding.
 *Fee payer: <string>                                        // Skipped if no fee_payer set
@@ -306,8 +306,8 @@ SIGN_MODE_TEXTUAL:
 ```
 Chain ID: simapp-1
 Account number: 10
-*Public Key: iQ...==        // Hex pubkey
 Sequence: 2
+*Public Key: 0xA1DE...E5DE        // Hex pubkey
 This transaction has 1 message:
 Message (1/1): bank v1beta1 send coins
 From: cosmos1...abc
@@ -386,8 +386,8 @@ SIGN_MODE_TEXTUAL for the feepayer:
 ```
 Chain ID: simapp-1
 Account number: 10
-*Public Key: iR...==
 Sequence: 2
+*Public Key: iR...==
 This transaction has 1 message:
 Message (1/1): bank v1beta1 send coins
 From: cosmos1...abc
@@ -401,7 +401,7 @@ Tip: 200 ibc/CDC4587874B85BEA4FCEC3CEA5A1195139799A1FEE711A07D972537E18FDA39D
 *Gas: 100'000
 *This transaction has 1 other signer:
 *Signer (1/2):
-*Public Key: iQ...==
+*Public Key: 0xA1DE...E5DE
 *Sign mode: Direct Aux
 *Sequence: 42
 *End of other signers
@@ -515,8 +515,8 @@ SIGN_MODE_TEXTUAL for 1st signer `cosmos1...abc`:
 ```
 Chain ID: simapp-1
 Account number: 10
-*Public Key: iQ...==
 Sequence: 2
+*Public Key: 0xA1DE...E5DE
 This transaction has 2 messages:
 Message (1/2): bank v1beta1 send coins
 From: cosmos1...abc

proto/cosmos/msg/textual/v1/textual.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package cosmos.msg.textual.v1;
+
+import "cosmos/tx/signing/v1beta1/signing.proto";
+
+// TextualData represents all the information needed to generate
+// the textual SignDoc (which is a []Screen). It is meant to be
+// used as an internal type in Textual's implementations.
+message TextualData {
+  // body_bytes is a protobuf serialization of a TxBody that matches the
+  // representation in SignDoc.
+  bytes body_bytes = 1;
+
+  // auth_info_bytes is a protobuf serialization of an AuthInfo that matches the
+  // representation in SignDoc.
+  bytes auth_info_bytes = 2;
+
+  // signer_data represents all data in Textual's SignDoc that are not
+  // inside the Tx body and auth_info.
+  cosmos.tx.signing.v1beta1.SignerData signer_data = 3;
+}

proto/cosmos/tx/signing/v1beta1/signing.proto

@@ -3,6 +3,7 @@ package cosmos.tx.signing.v1beta1;
 
 import "cosmos/crypto/multisig/v1beta1/multisig.proto";
 import "google/protobuf/any.proto";
+import "cosmos_proto/cosmos.proto";
 
 option go_package = "github.com/cosmos/cosmos-sdk/types/tx/signing";
 
@@ -104,3 +105,34 @@ message SignatureDescriptor {
     }
   }
 }
+
+// SignerData is the specific information needed to sign a transaction that generally
+// isn't included in the transaction body itself.
+message SignerData {
+  // address is the address of the signer.
+	//
+	// In case of multisigs, this should be the multisig's address.
+  string address = 1 [(cosmos_proto.scalar) = "AddressString"];
+
+  // chain_id is the chain that this transaction is targeted.
+  string chain_id = 2;
+
+  // account_number is the account number of the signer.
+	//
+	// In case of multisigs, this should be the multisig account number.
+  uint64 account_number = 3;
+
+  // sequence is the account sequence number of the signer that is used
+	// for replay protection. This field is only useful for Legacy Amino signing,
+	// since in SIGN_MODE_DIRECT the account sequence is already in the signer
+	// info.
+	//
+	// In case of multisigs, this should be the multisig sequence.
+  uint64 sequence = 4;
+
+  // pub_key is the public key of the signer.
+	//
+	// In case of multisigs, this should be the pubkey of the member of the
+	// multisig that is signing the current sign doc.
+  google.protobuf.Any pub_key = 5;
+}

simapp/app_legacy.go

@@ -39,7 +39,9 @@ import (
 	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
 	"github.com/cosmos/cosmos-sdk/x/auth/posthandler"
 	authsims "github.com/cosmos/cosmos-sdk/x/auth/simulation"
+	"github.com/cosmos/cosmos-sdk/x/auth/tx"
 	authtx "github.com/cosmos/cosmos-sdk/x/auth/tx"
+	txmodule "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
 	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
@@ -498,6 +500,13 @@ func NewSimApp(
 }
 
 func (app *SimApp) setAnteHandler(txConfig client.TxConfig) {
+	// Enable textual in TxConfig
+	textual := txmodule.NewTextual(app.BankKeeper)
+	// Optionally, you can define custom field-level and message-level
+	// renderers here, using respectively `textual.DefineScalar` and
+	// `textual.DefineMessageRenderer`.
+	app.txConfig = authtx.NewTxConfigWithTextual(app.appCodec.(codec.ProtoCodecMarshaler), tx.DefaultSignModes, textual)
+
 	anteHandler, err := ante.NewAnteHandler(
 		ante.HandlerOptions{
 			AccountKeeper:   app.AccountKeeper,

tx/go.mod

@@ -26,6 +26,7 @@ require (
 
 // temporary until we tag a new go module
 replace (
+	cosmossdk.io/api => ../api
 	cosmossdk.io/core => ../core
 	cosmossdk.io/math => ../math
 )

tx/go.sum

@@ -1,5 +1,3 @@
-cosmossdk.io/api v0.2.1 h1:4m6vIHKJygrixSIfOsD3Mhij9vZlQC/+BTeb+Un9os0=
-cosmossdk.io/api v0.2.1/go.mod h1:kNpfY0UY7Cz4ZuLJ4hm9auUGfmj23UFpOQ/Bo8IKCFw=
 github.com/cosmos/cosmos-proto v1.0.0-alpha8 h1:d3pCRuMYYvGA5bM0ZbbjKn+AoQD4A7dyNG2wzwWalUw=
 github.com/cosmos/cosmos-proto v1.0.0-alpha8/go.mod h1:6/p+Bc4O8JKeZqe0VqUGTX31eoYqemTT4C1hLCWsO7I=
 github.com/cosmos/gogoproto v1.4.2 h1:UeGRcmFW41l0G0MiefWhkPEVEwvu78SZsHBvI78dAYw=

tx/signing/sign_mode_handler.go

@@ -0,0 +1,34 @@
+package signing
+
+import "google.golang.org/protobuf/types/known/anypb"
+
+// SignerData is the specific information needed to sign a transaction that generally
+// isn't included in the transaction body itself
+type SignerData struct {
+	// The address of the signer.
+	//
+	// In case of multisigs, this should be the multisig's address.
+	Address string
+
+	// ChainID is the chain that this transaction is targeted
+	ChainID string
+
+	// AccountNumber is the account number of the signer.
+	//
+	// In case of multisigs, this should be the multisig account number.
+	AccountNumber uint64
+
+	// Sequence is the account sequence number of the signer that is used
+	// for replay protection. This field is only useful for Legacy Amino signing,
+	// since in SIGN_MODE_DIRECT the account sequence is already in the signer
+	// info.
+	//
+	// In case of multisigs, this should be the multisig sequence.
+	Sequence uint64
+
+	// PubKey is the public key of the signer.
+	//
+	// In case of multisigs, this should be the pubkey of the member of the
+	// multisig that is signing the current sign doc.
+	PubKey *anypb.Any
+}

tx/textual/internal/testdata/tx.json

@@ -0,0 +1,162 @@
+[
+	{
+		"proto": {
+			"body": {
+				"messages": [
+					{
+						"@type": "/cosmos.bank.v1beta1.MsgSend",
+						"from_address": "cosmos1ulav3hsenupswqfkw2y3sup5kgtqwnvqa8eyhs",
+						"to_address": "cosmos1ejrf4cur2wy6kfurg9f2jppp2h3afe5h6pkh5t",
+						"amount": [
+							{
+								"denom": "uatom",
+								"amount": "5000"
+							}
+						]
+					}
+				]
+			},
+			"auth_info": {
+				"signer_infos": [
+					{
+						"public_key": {
+							"@type": "/cosmos.crypto.secp256k1.PubKey",
+							"key": "Auvdf+T963bciiBe9l15DNMOijdaXCUo6zqSOvH7TXlN"
+						},
+						"mode_info": { "single": { "mode": "SIGN_MODE_TEXTUAL" } },
+						"sequence": 2
+					}
+				],
+				"fee": {
+					"amount": [
+						{
+							"denom": "uatom",
+							"amount": "5000"
+						}
+					],
+					"gas_limit": 100000
+				}
+			},
+			"signer_data": {
+				"chainId": "my-chain",
+				"pubKey": {
+					"@type": "/cosmos.crypto.secp256k1.PubKey",
+					"key": "Auvdf+T963bciiBe9l15DNMOijdaXCUo6zqSOvH7TXlN"
+				},
+				"sequence": 2
+			}
+		},
+		"screens": [
+			{ "text": "Chain ID: my-chain" },
+			{ "text": "Account number: 0" },
+			{ "text": "Sequence: 2" },
+			{ "text": "Fees: 5'000 uatom" },
+			{ "text": "Gas limit: 100'000", "expert": true },
+			{
+				"text": "Hash of raw bytes: e237dc2e3f8f0b1d0310e1cd0b0ab5fc4a59e4bc3454d67eb65c3fdb0fa599c9",
+				"expert": true
+			}
+		]
+	},
+	{
+		"proto": {
+			"body": {
+				"messages": []
+			},
+			"auth_info": {
+				"signer_infos": [
+					{
+						"public_key": {
+							"@type": "/cosmos.crypto.secp256k1.PubKey",
+							"key": "Auvdf+T963bciiBe9l15DNMOijdaXCUo6zqSOvH7TXlN"
+						},
+						"mode_info": { "single": { "mode": "SIGN_MODE_TEXTUAL" } },
+						"sequence": 2
+					},
+					{
+						"public_key": {
+							"@type": "/cosmos.crypto.multisig.LegacyAminoPubKey",
+							"threshold": 2,
+							"public_keys": [
+								{
+									"@type": "/cosmos.crypto.secp256k1.PubKey",
+									"key": "AldOvgv8dU9ZZzuhGydQD5FYreLhfhoBgrDKi8ZSTbCQ"
+								},
+								{
+									"@type": "/cosmos.crypto.secp256k1.PubKey",
+									"key": "AxUMR/GKoycWplR+2otzaQZ9zhHRQWJFt3h1bPg1ltha"
+								},
+								{
+									"@type": "/cosmos.crypto.secp256k1.PubKey",
+									"key": "AlI9yVj2Aejow6bYl2nTRylfU+9LjQLEl3keq0sERx9+"
+								},
+								{
+									"@type": "/cosmos.crypto.secp256k1.PubKey",
+									"key": "A0UvHPcvCCaIoFY9Ygh0Pxq9SZTAWtduOyinit/8uo+Q"
+								},
+								{
+									"@type": "/cosmos.crypto.secp256k1.PubKey",
+									"key": "As7R9fDUnwsUVLDr1cxspp+cY9UfXfUf7i9/w+N0EzKA"
+								}
+							]
+						},
+						"mode_info": {
+							"multi": {
+								"bitarray": {
+									"extra_bits_stored": 5,
+									"elems": "SA=="
+								},
+								"mode_infos": [
+									{
+										"single": {
+											"mode": "SIGN_MODE_LEGACY_AMINO_JSON"
+										}
+									},
+									{
+										"single": {
+											"mode": "SIGN_MODE_LEGACY_AMINO_JSON"
+										}
+									}
+								]
+							}
+						},
+						"sequence": "102"
+					}
+				],
+				"fee": {
+					"amount": [
+						{
+							"denom": "uatom",
+							"amount": "5000"
+						}
+					],
+					"gas_limit": 100000,
+					"payer": "cosmos1ey69r37gfxvxg62sh4r0ktpuc46pzjrmz29g45",
+					"granter": "cosmos1ey69r37gfxvxg62sh4r0ktpuc46pzjrmz29g45"
+				}
+			},
+			"signer_data": {
+				"chainId": "my-chain",
+				"pubKey": {
+					"@type": "/cosmos.crypto.secp256k1.PubKey",
+					"key": "Auvdf+T963bciiBe9l15DNMOijdaXCUo6zqSOvH7TXlN"
+				}
+			}
+		},
+		"screens": [
+			{ "text": "Chain ID: my-chain" },
+			{ "text": "Account number: 0" },
+			{ "text": "Sequence: 0" },
+			{ "text": "Fees: 5'000 uatom" },
+			{
+				"text": "Fee payer: cosmos1ey69r37gfxvxg62sh4r0ktpuc46pzjrmz29g45",
+				"expert": true
+			},
+			{
+				"text": "Fee granter: cosmos1ey69r37gfxvxg62sh4r0ktpuc46pzjrmz29g45",
+				"expert": true
+			},
+			{ "text": "Gas limit: 100'000", "expert": true }
+		]
+	}
+]

tx/textual/valuerenderer/bytes_test.go

@@ -21,7 +21,7 @@ func TestBytesJsonTestCases(t *testing.T) {
 	err = json.Unmarshal(raw, &testcases)
 	require.NoError(t, err)
 
-	textual := valuerenderer.NewTextual(mockCoinMetadataQuerier)
+	textual := valuerenderer.NewTextual(nil)
 
 	for _, tc := range testcases {
 		data, err := base64.StdEncoding.DecodeString(tc.base64)