[RnD][WIP] Emulate native bank send messages as Ethereum TXs #347
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+279
to
+282
| // EthereumTx can't contain more than 1 message | ||
| if len(tx.GetMsgs()) > 1 { | ||
| continue | ||
| } |
There was a problem hiding this comment.
why add this check? it could potentially contain multiple banktypes.MsgSend right?
Comment on lines
+51
to
53
| if !isEth && !isBankSend { | ||
| return nil, errors.New("invalid ethereum tx") | ||
| } |
There was a problem hiding this comment.
probably makes sense to adjust the error message here too, could be confusing otherwise
Suggested change
| if !isEth && !isBankSend { | |
| return nil, errors.New("invalid ethereum tx") | |
| } | |
| if !isEth && !isBankSend { | |
| return nil, errors.New("neither a valid ethereum tx or bank transfer") | |
| } |
Comment on lines
+59
to
73
| ethMsg, isEth := msg.(*evmtypes.MsgEthereumTx) | ||
| _, isBankSend := msg.(*banktypes.MsgSend) | ||
| if !isEth && !isBankSend { | ||
| continue | ||
| } | ||
|
|
||
| if isBankSend { | ||
| ethMsg, err = utilstx.BankSendTxAsEthereumTx(tx) | ||
| if err != nil { | ||
| b.logger.Debug("failed to convert bank send transaction into eth tx", "height", blk.Block.Height, "error", err.Error()) | ||
| continue | ||
| } | ||
| } | ||
|
|
||
| predecessors = append(predecessors, ethMsg) |
There was a problem hiding this comment.
more of a nit, but a slight performance boost - if it's an MsgEthereumTx you don't need the type checking for the MsgSend. Whether to first check for the Eth transaction or the bank transfer could be decided depending on which of the two is more commonly present on your chain.
Suggested change
| ethMsg, isEth := msg.(*evmtypes.MsgEthereumTx) | |
| _, isBankSend := msg.(*banktypes.MsgSend) | |
| if !isEth && !isBankSend { | |
| continue | |
| } | |
| if isBankSend { | |
| ethMsg, err = utilstx.BankSendTxAsEthereumTx(tx) | |
| if err != nil { | |
| b.logger.Debug("failed to convert bank send transaction into eth tx", "height", blk.Block.Height, "error", err.Error()) | |
| continue | |
| } | |
| } | |
| predecessors = append(predecessors, ethMsg) | |
| if ethMsg, isEth := msg.(*evmtypes.MsgEthereumTx); isEth { | |
| predecessors = append(predecessors, ethMsg) | |
| continue | |
| } | |
| if _, isBankSend := msg.(*banktypes.MsgSend); isBankSend { | |
| ethMsg, err = utilstx.BankSendTxAsEthereumTx(tx) | |
| if err != nil { | |
| b.logger.Debug("failed to convert bank send transaction into eth tx", "height", blk.Block.Height, "error", err.Error()) | |
| continue | |
| } | |
| predecessors = append(predecessors, ethMsg) | |
| } |
Comment on lines
+30
to
+38
| if len(tx.GetMsgs()) > 1 { | ||
| return nil, errors.New("tx has more than one message") | ||
| } | ||
|
|
||
| msg := tx.GetMsgs()[0] | ||
| sendMsg, ok := msg.(*banktypes.MsgSend) | ||
| if !ok { | ||
| return nil, errors.New("tx message is not a bank.MsgSend") | ||
| } |
There was a problem hiding this comment.
this assumes that only one banktypes.MsgSend can be present in a transaction - to be sure of this it would probably make sense to add a blocker for such a transaction in the ante handlers. Did you already add that?
Comment on lines
+63
to
+65
| if len(sigs) != 1 { | ||
| return nil, errors.New("transaction with one signer has more than one signature") | ||
| } |
There was a problem hiding this comment.
error message could be clearer here:
Suggested change
| if len(sigs) != 1 { | |
| return nil, errors.New("transaction with one signer has more than one signature") | |
| } | |
| if len(sigs) != 1 { | |
| return nil, fmt.Errorf("expected transaction with 1 signer; got %d", len(sigs)) | |
| } |
Comment on lines
+141
to
+166
| attrs := []sdk.Attribute{ | ||
| sdk.NewAttribute(sdk.AttributeKeyAmount, ethTx.Value().String()), | ||
| // add event for ethereum transaction hash format | ||
| sdk.NewAttribute(evmtypes.AttributeKeyEthereumTxHash, ethMsg.Hash), | ||
| // add event for index of valid ethereum tx | ||
| sdk.NewAttribute(evmtypes.AttributeKeyTxIndex, strconv.FormatUint(0, 10)), | ||
| // add event for eth tx gas used, we can't get it from cosmos tx result when it contains multiple eth tx msgs. | ||
| sdk.NewAttribute(evmtypes.AttributeKeyTxGasUsed, strconv.FormatUint(ethMsg.GetGas(), 10)), | ||
| } | ||
|
|
||
| if len(ctx.TxBytes()) > 0 { | ||
| // add event for tendermint transaction hash format | ||
| hash := tmbytes.HexBytes(tmtypes.Tx(ctx.TxBytes()).Hash()) | ||
| attrs = append(attrs, sdk.NewAttribute(evmtypes.AttributeKeyTxHash, hash.String())) | ||
| } | ||
|
|
||
| if to := ethTx.To(); to != nil { | ||
| attrs = append(attrs, sdk.NewAttribute(evmtypes.AttributeKeyRecipient, to.Hex())) | ||
| } | ||
|
|
||
| ctx.EventManager().EmitEvents(sdk.Events{ | ||
| sdk.NewEvent( | ||
| evmtypes.EventTypeEthereumTx, | ||
| attrs..., | ||
| ), | ||
| }) |
There was a problem hiding this comment.
I'd suggest adding a corresponding integration test to check if the emitted events from a bank transfer using a Cosmos message and the resulting events from an Ethereum transfer are the same
Comment on lines
+173
to
+185
|
|
||
| ethMsg, isEth := tx.GetMsgs()[res.MsgIndex].(*evmtypes.MsgEthereumTx) | ||
| _, isBankSend := tx.GetMsgs()[res.MsgIndex].(*banktypes.MsgSend) | ||
| if !isEth && !isBankSend { | ||
| return nil, errors.New("invalid ethereum tx") | ||
| } | ||
|
|
||
| if isBankSend { | ||
| ethMsg, err = utilstx.BankSendTxAsEthereumTx(tx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } |
There was a problem hiding this comment.
to avoid the code duplication it could be better to introduce a helper method
func GetEthMsgOrConvertBankSendToEthMsg(tx sdk.Tx, msg sdk.Msg) (*evmtypes.MsgEthereumTx, error) {
if ethMsg, isEth = msg.(*evmtypes.MsgEthereumTx, error); isEth {
return ethMsg, nil
}
if _, isBankSend = msg.(*banktypes.MsgSend); isBankSend {
return utilstx.BankSendTxAsEthereumTx
}
return nil, fmt.Errorf("neither ethereum tx nor bank transfer; got: %T", msg)
}
Suggested change
| ethMsg, isEth := tx.GetMsgs()[res.MsgIndex].(*evmtypes.MsgEthereumTx) | |
| _, isBankSend := tx.GetMsgs()[res.MsgIndex].(*banktypes.MsgSend) | |
| if !isEth && !isBankSend { | |
| return nil, errors.New("invalid ethereum tx") | |
| } | |
| if isBankSend { | |
| ethMsg, err = utilstx.BankSendTxAsEthereumTx(tx) | |
| if err != nil { | |
| return nil, err | |
| } | |
| } | |
| ethMsg, err := GetEthMsgOrConvertBankSendToEthMsg(tx, tx.GetMsgs()[res.MsgIndex]) | |
| if err != nil { | |
| return nil, err | |
| } |
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days-before-close if no further activity occurs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #XXX
Description
For contributor use:
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerFor admin use:
WIP,R4R,docs, etc)