Fix BIP44 coin type (#480)

* fix docsearch

* update BIP44 coin type

* changelog

* set HD path
This commit is contained in:
Federico Kunze 2020-08-28 17:35:10 +02:00 committed by GitHub
parent 6307ba9d28
commit 8a3692e174
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 60 additions and 3 deletions

View File

@ -41,6 +41,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (app) [\#471](https://github.com/ChainSafe/ethermint/pull/471) Add `x/upgrade` module for managing software updates. * (app) [\#471](https://github.com/ChainSafe/ethermint/pull/471) Add `x/upgrade` module for managing software updates.
### Bug Fixes
* (types) [\#480](https://github.com/ChainSafe/ethermint/pull/480) Update [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) coin type to `60` to satisfy [EIP84](https://github.com/ethereum/EIPs/issues/84).
## [v0.1.0] - 2020-08-23 ## [v0.1.0] - 2020-08-23
### Improvements ### Improvements

View File

@ -42,6 +42,7 @@ func init() {
// set the address prefixes // set the address prefixes
config := sdk.GetConfig() config := sdk.GetConfig()
ethermint.SetBech32Prefixes(config) ethermint.SetBech32Prefixes(config)
ethermint.SetBip44CoinType(config)
} }
const appName = "Ethermint" const appName = "Ethermint"

View File

@ -46,6 +46,7 @@ func main() {
// Read in the configuration file for the sdk // Read in the configuration file for the sdk
config := sdk.GetConfig() config := sdk.GetConfig()
ethermint.SetBech32Prefixes(config) ethermint.SetBech32Prefixes(config)
ethermint.SetBip44CoinType(config)
config.Seal() config.Seal()
rootCmd := &cobra.Command{ rootCmd := &cobra.Command{

View File

@ -53,6 +53,7 @@ func main() {
config := sdk.GetConfig() config := sdk.GetConfig()
ethermint.SetBech32Prefixes(config) ethermint.SetBech32Prefixes(config)
ethermint.SetBip44CoinType(config)
config.Seal() config.Seal()
ctx := server.NewDefaultContext() ctx := server.NewDefaultContext()

View File

@ -6,16 +6,45 @@ order: 1
This document describes the in-built accounts system of Ethermint. {synopsis} This document describes the in-built accounts system of Ethermint. {synopsis}
## Cosmos SDK Accounts ## Pre-requisite Readings
<!-- TODO: --> - [Cosmos SDK Accounts](https://docs.cosmos.network/master/basics/accounts.html) {prereq}
- [Ethereum Accounts](https://ethereum.org/en/whitepaper/#ethereum-accounts) {prereq}
## Ethermint Accounts ## Ethermint Accounts
<!-- TODO: --> Ethermint defines its own custom `Account` type that uses Ethereum's ECDSA secp256k1 curve for keys. This
satisfies the [EIP84](https://github.com/ethereum/EIPs/issues/84) for full [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) paths.
The root HD path for Ethermint-based accounts is `m/44'/60'/0'/0`.
+++ https://github.com/ChainSafe/ethermint/blob/v0.1.0/types/account.go#L31-L36
## Addresses and Public Keys
There are 3 main types of `Addresses`/`PubKeys` available by default on Ethermint:
- Addresses and Keys for **accounts**, which identify users (e.g. the sender of a `message`). They are derived using the **`eth_secp256k1`** curve.
- Addresses and Keys for **validator operators**, which identify the operators of validators. They are derived using the **`eth_secp256k1`** curve.
- Addresses and Keys for **consensus nodes**, which identify the validator nodes participating in consensus. They are derived using the **`ed25519`** curve.
| | Address bech32 Prefix | Pubkey bech32 Prefix | Curve | Address byte length | Pubkey byte length |
|--------------------|-----------------------|----------------------|-----------------|---------------------|--------------------|
| Accounts | `eth` | `ethpub` | `eth_secp256k1` | `20` | `33` (compressed) |
| Validator Operator | `ethvaloper` | `ethvaloperpub` | `eth_secp256k1` | `20` | `33` (compressed) |
| Consensus Nodes | `ethvalcons` | `ethvalconspub` | `ed25519` | `20` | `32` |
## Address formats for clients ## Address formats for clients
`EthAccount`s have can be represented in both [Bech32](https://en.bitcoin.it/wiki/Bech32) and hex format for Ethereum's Web3 tooling compatibility.
The Bech32 format is the default format for Cosmos-SDK queries and transactions through CLI and REST
clients. The hex format on the other hand, is the Ethereum `common.Address` representation of a
Cosmos `sdk.AccAddress`.
- Address (Bech32): `eth1crwhac03z2pcgu88jfnqnwu66xlthlz2rhljah`
- Address (Hex): `0xc0dd7ee1f112838470e7926609bb9ad1bebbfc4a`
- Public Key (Bech32): `ethpub1pfqnmk6pqnwwuw0h9hj58t2hyzwvqc3truhhp5tl5hfucezcfy2rs8470nkyzju2vmk645fzmw2wveaqcqek767kwa0es9rmxe9nmmjq84cpny3fvj6tpg`
## Next {hide} ## Next {hide}
Learn about Ethermint [transactions](./transactions.md) {hide} Learn about Ethermint [transactions](./transactions.md) {hide}

View File

@ -20,6 +20,12 @@ const (
Bech32PrefixConsAddr = EthBech32Prefix + sdk.PrefixValidator + sdk.PrefixConsensus Bech32PrefixConsAddr = EthBech32Prefix + sdk.PrefixValidator + sdk.PrefixConsensus
// Bech32PrefixConsPub defines the Bech32 prefix of a consensus node public key // Bech32PrefixConsPub defines the Bech32 prefix of a consensus node public key
Bech32PrefixConsPub = EthBech32Prefix + sdk.PrefixValidator + sdk.PrefixConsensus + sdk.PrefixPublic Bech32PrefixConsPub = EthBech32Prefix + sdk.PrefixValidator + sdk.PrefixConsensus + sdk.PrefixPublic
// Bip44CoinType satisfies EIP84. See https://github.com/ethereum/EIPs/issues/84 for more info.
Bip44CoinType = 60
// BIP44HDPath is the BIP44 HD path used on Ethereum.
BIP44HDPath = "44'/60'/0'/0/0"
) )
// SetBech32Prefixes sets the global prefixes to be used when serializing addresses and public keys to Bech32 strings. // SetBech32Prefixes sets the global prefixes to be used when serializing addresses and public keys to Bech32 strings.
@ -28,3 +34,9 @@ func SetBech32Prefixes(config *sdk.Config) {
config.SetBech32PrefixForValidator(Bech32PrefixValAddr, Bech32PrefixValPub) config.SetBech32PrefixForValidator(Bech32PrefixValAddr, Bech32PrefixValPub)
config.SetBech32PrefixForConsensusNode(Bech32PrefixConsAddr, Bech32PrefixConsPub) config.SetBech32PrefixForConsensusNode(Bech32PrefixConsAddr, Bech32PrefixConsPub)
} }
// SetBip44CoinType sets the global coin type to be used in hierarchical deterministic wallets.
func SetBip44CoinType(config *sdk.Config) {
config.SetCoinType(Bip44CoinType)
config.SetFullFundraiserPath(BIP44HDPath)
}

View File

@ -32,3 +32,12 @@ func TestSetBech32Prefixes(t *testing.T) {
require.Equal(t, sdk.GetConfig().GetBech32ConsensusAddrPrefix(), config.GetBech32ConsensusAddrPrefix()) require.Equal(t, sdk.GetConfig().GetBech32ConsensusAddrPrefix(), config.GetBech32ConsensusAddrPrefix())
require.Equal(t, sdk.GetConfig().GetBech32ConsensusPubPrefix(), config.GetBech32ConsensusPubPrefix()) require.Equal(t, sdk.GetConfig().GetBech32ConsensusPubPrefix(), config.GetBech32ConsensusPubPrefix())
} }
func TestSetCoinType(t *testing.T) {
config := sdk.GetConfig()
require.Equal(t, sdk.CoinType, int(config.GetCoinType()))
SetBip44CoinType(config)
require.Equal(t, Bip44CoinType, int(config.GetCoinType()))
require.Equal(t, sdk.GetConfig().GetCoinType(), config.GetCoinType())
}