Refactor EIP-712 signature verification

CHANGELOG.md

@@ -64,6 +64,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (cli) [#1360](https://github.com/evmos/ethermint/pull/1360) Introduce a new `grpc-only` flag, such that when enabled, will start the node in a query-only mode. Note, gRPC MUST be enabled with this flag.
 * (rpc) [#1378](https://github.com/evmos/ethermint/pull/1378) Add support for EVM RPC metrics
 * (ante) [#1390](https://github.com/evmos/ethermint/pull/1390) Added multisig tx support.
+* (ante) [#1397](https://github.com/evmos/ethermint/pull/1397) Refactor EIP-712 signature verification to support EIP-712 multi-signing.
 
 ### Bug Fixes
 

app/ante/ante_test.go

@@ -31,6 +31,7 @@ import (
  evmtypes "github.com/evmos/ethermint/x/evm/types"
 
  banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+ govtypes "github.com/cosmos/cosmos-sdk/x/gov/types/v1beta1"
 )
 
 func (suite AnteTestSuite) TestAnteHandler() {
@@ -507,6 +508,181 @@ func (suite AnteTestSuite) TestAnteHandler() {
  return tx
  }, true, false, false,
  },
+ {
+ "passes - EIP-712 multi-key",
+ func() sdk.Tx {
+ numKeys := 5
+ privKeys, pubKeys := suite.GenerateMultipleKeys(numKeys)
+ pk := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ msg := banktypes.NewMsgSend(
+ sdk.AccAddress(pk.Address()),
+ addr[:],
+ sdk.NewCoins(
+ sdk.NewCoin(
+ "photon",
+ sdk.NewInt(1),
+ ),
+ ),
+ )
+
+ txBuilder := suite.CreateTestSignedMultisigTx(
+ privKeys,
+ signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON,
+ msg,
+ "ethermint_9000-1",
+ 2000000,
+ "EIP-712",
+ )
+
+ return txBuilder.GetTx()
+ }, false, false, true,
+ },
+ {
+ "passes - Mixed multi-key",
+ func() sdk.Tx {
+ numKeys := 5
+ privKeys, pubKeys := suite.GenerateMultipleKeys(numKeys)
+ pk := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ msg := banktypes.NewMsgSend(
+ sdk.AccAddress(pk.Address()),
+ addr[:],
+ sdk.NewCoins(
+ sdk.NewCoin(
+ "photon",
+ sdk.NewInt(1),
+ ),
+ ),
+ )
+
+ txBuilder := suite.CreateTestSignedMultisigTx(
+ privKeys,
+ signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON,
+ msg,
+ "ethermint_9000-1",
+ 2000000,
+ "mixed", // Combine EIP-712 and standard signatures
+ )
+
+ return txBuilder.GetTx()
+ }, false, false, true,
+ },
+ {
+ "passes - Mixed multi-key with MsgVote",
+ func() sdk.Tx {
+ numKeys := 5
+ privKeys, pubKeys := suite.GenerateMultipleKeys(numKeys)
+ pk := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ msg := govtypes.NewMsgVote(
+ sdk.AccAddress(pk.Address()),
+ 1,
+ govtypes.OptionYes,
+ )
+
+ txBuilder := suite.CreateTestSignedMultisigTx(
+ privKeys,
+ signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON,
+ msg,
+ "ethermint_9000-1",
+ 2000000,
+ "mixed", // Combine EIP-712 and standard signatures
+ )
+
+ return txBuilder.GetTx()
+ }, false, false, true,
+ },
+ {
+ "Fails - Multi-Key with incorrect Chain ID",
+ func() sdk.Tx {
+ numKeys := 5
+ privKeys, pubKeys := suite.GenerateMultipleKeys(numKeys)
+ pk := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ msg := banktypes.NewMsgSend(
+ sdk.AccAddress(pk.Address()),
+ addr[:],
+ sdk.NewCoins(
+ sdk.NewCoin(
+ "photon",
+ sdk.NewInt(1),
+ ),
+ ),
+ )
+
+ txBuilder := suite.CreateTestSignedMultisigTx(
+ privKeys,
+ signing.SignMode_SIGN_MODE_LEGACY_AMINO_JSON,
+ msg,
+ "ethermint_9005-1",
+ 2000000,
+ "mixed",
+ )
+
+ return txBuilder.GetTx()
+ }, false, false, false,
+ },
+ {
+ "Fails - Multi-Key with incorrect sign mode",
+ func() sdk.Tx {
+ numKeys := 5
+ privKeys, pubKeys := suite.GenerateMultipleKeys(numKeys)
+ pk := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ msg := banktypes.NewMsgSend(
+ sdk.AccAddress(pk.Address()),
+ addr[:],
+ sdk.NewCoins(
+ sdk.NewCoin(
+ "photon",
+ sdk.NewInt(1),
+ ),
+ ),
+ )
+
+ txBuilder := suite.CreateTestSignedMultisigTx(
+ privKeys,
+ signing.SignMode_SIGN_MODE_DIRECT,
+ msg,
+ "ethermint_9000-1",
+ 2000000,
+ "mixed",
+ )
+
+ return txBuilder.GetTx()
+ }, false, false, false,
+ },
+ {
+ "Fails - Multi-Key with too little gas",
+ func() sdk.Tx {
+ numKeys := 5
+ privKeys, pubKeys := suite.GenerateMultipleKeys(numKeys)
+ pk := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ msg := banktypes.NewMsgSend(
+ sdk.AccAddress(pk.Address()),
+ addr[:],
+ sdk.NewCoins(
+ sdk.NewCoin(
+ "photon",
+ sdk.NewInt(1),
+ ),
+ ),
+ )
+
+ txBuilder := suite.CreateTestSignedMultisigTx(
+ privKeys,
+ signing.SignMode_SIGN_MODE_DIRECT,
+ msg,
+ "ethermint_9000-1",
+ 2000,
+ "mixed", // Combine EIP-712 and standard signatures
+ )
+
+ return txBuilder.GetTx()
+ }, false, false, false,
+ },
  }
 
  for _, tc := range testCases {
@@ -939,7 +1115,7 @@ func (suite *AnteTestSuite) TestConsumeSignatureVerificationGas() {
  multisigKey1 := kmultisig.NewLegacyAminoPubKey(2, pkSet1)
  multisignature1 := multisig.NewMultisig(len(pkSet1))
  expectedCost1 := expectedGasCostByKeys(pkSet1)
- 
+
  for i := 0; i < len(pkSet1); i++ {
  stdSig := legacytx.StdSignature{PubKey: pkSet1[i], Signature: sigSet1[i]}
  sigV2, err := legacytx.StdSignatureToSignatureV2(cdc, stdSig)

app/ante/utils_test.go

@@ -25,16 +25,20 @@ import (
  "github.com/cosmos/cosmos-sdk/client"
  "github.com/cosmos/cosmos-sdk/client/tx"
  codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+ kmultisig "github.com/cosmos/cosmos-sdk/crypto/keys/multisig"
  cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
+ "github.com/cosmos/cosmos-sdk/crypto/types/multisig"
  "github.com/cosmos/cosmos-sdk/simapp"
  "github.com/cosmos/cosmos-sdk/testutil/testdata"
  sdk "github.com/cosmos/cosmos-sdk/types"
  txtypes "github.com/cosmos/cosmos-sdk/types/tx"
  "github.com/cosmos/cosmos-sdk/types/tx/signing"
+ sdkante "github.com/cosmos/cosmos-sdk/x/auth/ante"
  authsigning "github.com/cosmos/cosmos-sdk/x/auth/signing"
  authtx "github.com/cosmos/cosmos-sdk/x/auth/tx"
  authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
  cryptocodec "github.com/evmos/ethermint/crypto/codec"
+ "github.com/evmos/ethermint/crypto/ethsecp256k1"
 
  "github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
  evtypes "github.com/cosmos/cosmos-sdk/x/evidence/types"
@@ -111,6 +115,7 @@ func (suite *AnteTestSuite) SetupTest() {
  encodingConfig := encoding.MakeConfig(app.ModuleBasics)
  // We're using TestMsg amino encoding in some tests, so register it here.
  encodingConfig.Amino.RegisterConcrete(&testdata.TestMsg{}, "testdata.TestMsg", nil)
+ eip712.SetEncodingConfig(encodingConfig)
 
  suite.clientCtx = client.Context{}.WithTxConfig(encodingConfig.TxConfig)
 
@@ -448,6 +453,132 @@ func (suite *AnteTestSuite) CreateTestEIP712CosmosTxBuilder(
  return builder
 }
 
+// Generate a set of pub/priv keys to be used in creating multi-keys
+func (suite *AnteTestSuite) GenerateMultipleKeys(n int) ([]cryptotypes.PrivKey, []cryptotypes.PubKey) {
+ privKeys := make([]cryptotypes.PrivKey, n)
+ pubKeys := make([]cryptotypes.PubKey, n)
+ for i := 0; i < n; i++ {
+ privKey, err := ethsecp256k1.GenerateKey()
+ suite.Require().NoError(err)
+ privKeys[i] = privKey
+ pubKeys[i] = privKey.PubKey()
+ }
+ return privKeys, pubKeys
+}
+
+// Signs a set of messages using each private key within a given multi-key
+func (suite *AnteTestSuite) generateMultikeySignatures(signMode signing.SignMode, privKeys []cryptotypes.PrivKey, signDocBytes []byte, signType string) (signatures []signing.SignatureV2) {
+ var (
+ msg []byte
+ err error
+ )
+
+ n := len(privKeys)
+ signatures = make([]signing.SignatureV2, n)
+
+ for i := 0; i < n; i++ {
+ privKey := privKeys[i]
+
+ msg = signDocBytes
+
+ if signType == "EIP-712" || (signType == "mixed" && i%2 == 0) {
+ msg, err = eip712.GetEIP712HashForMsg(signDocBytes)
+ suite.Require().NoError(err)
+ }
+
+ sigBytes, _ := privKey.Sign(msg)
+ sigData := &signing.SingleSignatureData{
+ SignMode: signMode,
+ Signature: sigBytes,
+ }
+
+ signatures[i] = signing.SignatureV2{
+ PubKey: privKey.PubKey(),
+ Data: sigData,
+ }
+ }
+
+ return signatures
+}
+
+// Create and sign a multi-signed tx for the given message. `signType` indicates whether to use standard signing ("Standard"),
+// EIP-712 signing ("EIP-712"), or a mix of the two ("mixed").
+func (suite *AnteTestSuite) CreateTestSignedMultisigTx(privKeys []cryptotypes.PrivKey, signMode signing.SignMode, msg sdk.Msg, chainId string, gas uint64, signType string) client.TxBuilder {
+ pubKeys := make([]cryptotypes.PubKey, len(privKeys))
+ for i, privKey := range privKeys {
+ pubKeys[i] = privKey.PubKey()
+ }
+
+ // Re-derive multikey
+ numKeys := len(privKeys)
+ multiKey := kmultisig.NewLegacyAminoPubKey(numKeys, pubKeys)
+
+ // Create multi-key account
+ multiKeyAcc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, sdk.AccAddress(multiKey.Address()))
+ suite.app.AccountKeeper.SetAccount(suite.ctx, multiKeyAcc)
+
+ // Update balance for multikey account
+ suite.app.EvmKeeper.SetBalance(suite.ctx, common.BytesToAddress(multiKey.Address()), big.NewInt(10000000000))
+
+ // Init builder
+ txBuilder := suite.clientCtx.TxConfig.NewTxBuilder()
+
+ // Set fees
+ txBuilder.SetGasLimit(gas)
+ txBuilder.SetFeeAmount(sdk.NewCoins(
+ sdk.NewCoin(
+ "aphoton",
+ sdk.NewInt(10000),
+ ),
+ ))
+
+ // Set message
+ err := txBuilder.SetMsgs([]sdk.Msg{msg}...)
+ suite.Require().NoError(err)
+
+ // Set memo and tip
+ txBuilder.SetMemo("")
+
+ // Prepare signature field
+ sig := multisig.NewMultisig(len(pubKeys))
+ txBuilder.SetSignatures(signing.SignatureV2{
+ PubKey: multiKey,
+ Data: sig,
+ })
+
+ // Create signer bytes
+ acc, err := sdkante.GetSignerAcc(suite.ctx, suite.app.AccountKeeper, sdk.AccAddress(multiKey.Address()))
+ suite.Require().NoError(err)
+ signerInfo := authsigning.SignerData{
+ Address: sdk.MustBech32ifyAddressBytes(sdk.GetConfig().GetBech32AccountAddrPrefix(), acc.GetAddress().Bytes()),
+ ChainID: chainId,
+ AccountNumber: acc.GetAccountNumber(),
+ Sequence: acc.GetSequence(),
+ PubKey: multiKey,
+ }
+
+ signerBytes, err := suite.clientCtx.TxConfig.SignModeHandler().GetSignBytes(
+ signMode,
+ signerInfo,
+ txBuilder.GetTx(),
+ )
+ suite.Require().NoError(err)
+
+ // Sign for each key and update signature field
+ sigs := suite.generateMultikeySignatures(signMode, privKeys, signerBytes, signType)
+ for _, pkSig := range sigs {
+ err = multisig.AddSignatureV2(sig, pkSig, pubKeys)
+ suite.Require().NoError(err)
+ }
+
+ txBuilder.SetSignatures(signing.SignatureV2{
+ PubKey: multiKey,
+ Data: sig,
+ })
+
+ return txBuilder
+}
+
 func NextFn(ctx sdk.Context, _ sdk.Tx, _ bool) (sdk.Context, error) {
  return ctx, nil
 }

cmd/ethermintd/root.go

@@ -37,6 +37,7 @@ import (
  "github.com/evmos/ethermint/client/debug"
  "github.com/evmos/ethermint/crypto/hd"
  "github.com/evmos/ethermint/encoding"
+ "github.com/evmos/ethermint/ethereum/eip712"
  "github.com/evmos/ethermint/server"
  servercfg "github.com/evmos/ethermint/server/config"
  srvflags "github.com/evmos/ethermint/server/flags"
@@ -61,6 +62,8 @@ func NewRootCmd() (*cobra.Command, params.EncodingConfig) {
  WithKeyringOptions(hd.EthSecp256k1Option()).
  WithViper(EnvPrefix)
 
+ eip712.SetEncodingConfig(encodingConfig)
+
  rootCmd := &cobra.Command{
  Use: "ethermintd",
  Short: "Ethermint Daemon",