2020-07-02 08:22:45 +00:00
<!--
order: 1
-->
# Encoding
2020-11-12 19:42:24 +00:00
Learn about the encoding formats used on Ethermint. {synopsis}
2020-07-02 08:22:45 +00:00
## Pre-requisite Readings
2020-07-06 16:56:02 +00:00
- [Cosmos SDK Encoding ](https://docs.cosmos.network/master/core/encoding.html ) {prereq}
2020-11-12 19:42:24 +00:00
- [Ethereum RLP ](https://eth.wiki/en/fundamentals/rlp ) {prereq}
2020-07-02 08:22:45 +00:00
## Encoding Formats
2020-11-12 19:42:24 +00:00
### Protocol Buffers
2020-07-02 08:22:45 +00:00
2020-11-12 19:42:24 +00:00
The Cosmos [Stargate ](https://stargate.cosmos.network/ ) release introduces
[protobuf ](https://developers.google.com/protocol-buffers ) as the main encoding format for both
2021-08-03 17:35:31 +00:00
client and state serialization. All the EVM module types that are used for state and clients
2020-11-12 19:42:24 +00:00
(transaction messages, genesis, query services, etc) will be implemented as protocol buffer messages.
2020-07-02 08:22:45 +00:00
### Amino
2020-11-12 19:42:24 +00:00
The Cosmos SDK also supports the legacy Amino encoding format for backwards compatibility with
2021-08-03 17:35:31 +00:00
previous versions, specially for client encoding and signing with Ledger devices. Ethermint does not
support Amino in the EVM module, but it is supported for all other Cosmos SDK modules that enable it.
2020-07-02 08:22:45 +00:00
2020-11-12 19:42:24 +00:00
### RLP
2020-07-02 08:22:45 +00:00
2020-11-12 19:42:24 +00:00
Recursive Length Prefix ([RLP](https://eth.wiki/en/fundamentals/rlp)), is an encoding/decoding algorithm that serializes a message and
allows for quick reconstruction of encoded data. Ethermint uses RLP to encode/decode Ethereum
messages for JSON-RPC handling to conform messages to the proper Ethereum format. This allows
messages to be encoded and decoded in the exact format as Ethereum's.
2020-07-02 08:22:45 +00:00
2021-08-03 17:35:31 +00:00
The `x/evm` transactions (`MsgEthereumTx`) encoding is performed by casting the message to a go-ethereum's `Transaction` and then marshaling the transaction data using RLP:
```go
// TxEncoder overwrites sdk.TxEncoder to support MsgEthereumTx
func (g txConfig) TxEncoder() sdk.TxEncoder {
return func(tx sdk.Tx) ([]byte, error) {
msg, ok := tx.(*evmtypes.MsgEthereumTx)
if ok {
return msg.AsTransaction().MarshalBinary()
}
return g.TxConfig.TxEncoder()(tx)
}
}
// TxDecoder overwrites sdk.TxDecoder to support MsgEthereumTx
func (g txConfig) TxDecoder() sdk.TxDecoder {
return func(txBytes []byte) (sdk.Tx, error) {
tx := & ethtypes.Transaction{}
err := tx.UnmarshalBinary(txBytes)
if err == nil {
msg := & evmtypes.MsgEthereumTx{}
msg.FromEthereumTx(tx)
return msg, nil
}
return g.TxConfig.TxDecoder()(txBytes)
}
}
```
2020-07-02 08:22:45 +00:00
## Next {hide}
2020-11-12 19:42:24 +00:00
Learn how [pending state ](./pending_state.md ) is handled on Ethermint. {hide}
