From df244b5a243ad5d5c121f6f543dda2fc130c99c5 Mon Sep 17 00:00:00 2001 From: Federico Kunze Date: Fri, 28 Aug 2020 09:53:18 +0200 Subject: [PATCH 1/4] fix docsearch --- docs/.vuepress/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 8b913b73f..26fd82ace 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -14,7 +14,7 @@ module.exports = { logo: { src: '/logo.svg', }, - algolia: {id: 'BH4D9OD16A', key: '70ee930283c179ccd9a74d8a31afe300', index: 'ethermint'}, + algolia: {id: 'BH4D9OD16A', key: 'c5da4dd3636828292e3c908a0db39688', index: 'ethermint'}, topbar: {banner: false}, sidebar: { auto: false, From 0d58b3cfe9aaea0aef7128ce957c5fea28df505e Mon Sep 17 00:00:00 2001 From: Federico Kunze Date: Fri, 28 Aug 2020 11:24:10 +0200 Subject: [PATCH 2/4] update BIP44 coin type --- CHANGELOG.md | 1 + app/ethermint.go | 1 + cmd/ethermintcli/main.go | 1 + cmd/ethermintd/main.go | 1 + docs/basics/accounts.md | 35 ++++++++++++++++++++++++++++++++--- types/config.go | 8 ++++++++ types/config_test.go | 9 +++++++++ 7 files changed, 53 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec0b098d2..667676fa7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,6 +40,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements * (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) 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 diff --git a/app/ethermint.go b/app/ethermint.go index 1a3716555..a219f3fb3 100644 --- a/app/ethermint.go +++ b/app/ethermint.go @@ -42,6 +42,7 @@ func init() { // set the address prefixes config := sdk.GetConfig() ethermint.SetBech32Prefixes(config) + ethermint.SetBip44CoinType(config) } const appName = "Ethermint" diff --git a/cmd/ethermintcli/main.go b/cmd/ethermintcli/main.go index 91e4cf117..aa1b60b98 100644 --- a/cmd/ethermintcli/main.go +++ b/cmd/ethermintcli/main.go @@ -46,6 +46,7 @@ func main() { // Read in the configuration file for the sdk config := sdk.GetConfig() ethermint.SetBech32Prefixes(config) + ethermint.SetBip44CoinType(config) config.Seal() rootCmd := &cobra.Command{ diff --git a/cmd/ethermintd/main.go b/cmd/ethermintd/main.go index aaf58237f..9965287e3 100644 --- a/cmd/ethermintd/main.go +++ b/cmd/ethermintd/main.go @@ -53,6 +53,7 @@ func main() { config := sdk.GetConfig() ethermint.SetBech32Prefixes(config) + ethermint.SetBip44CoinType(config) config.Seal() ctx := server.NewDefaultContext() diff --git a/docs/basics/accounts.md b/docs/basics/accounts.md index 58d32d1d0..ed553ea22 100644 --- a/docs/basics/accounts.md +++ b/docs/basics/accounts.md @@ -6,16 +6,45 @@ order: 1 This document describes the in-built accounts system of Ethermint. {synopsis} -## Cosmos SDK Accounts +## Pre-requisite Readings - +- [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 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 +`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} Learn about Ethermint [transactions](./transactions.md) {hide} diff --git a/types/config.go b/types/config.go index ce4f38ea0..a26b34802 100644 --- a/types/config.go +++ b/types/config.go @@ -20,6 +20,9 @@ const ( Bech32PrefixConsAddr = EthBech32Prefix + sdk.PrefixValidator + sdk.PrefixConsensus // Bech32PrefixConsPub defines the Bech32 prefix of a consensus node public key Bech32PrefixConsPub = EthBech32Prefix + sdk.PrefixValidator + sdk.PrefixConsensus + sdk.PrefixPublic + + // Bip44CoinType satisfies EIP84. See https://github.com/ethereum/EIPs/issues/84 for more info. + Bip44CoinType = 60 ) // SetBech32Prefixes sets the global prefixes to be used when serializing addresses and public keys to Bech32 strings. @@ -28,3 +31,8 @@ func SetBech32Prefixes(config *sdk.Config) { config.SetBech32PrefixForValidator(Bech32PrefixValAddr, Bech32PrefixValPub) 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) +} diff --git a/types/config_test.go b/types/config_test.go index d7717e04c..966b0bcfb 100644 --- a/types/config_test.go +++ b/types/config_test.go @@ -32,3 +32,12 @@ func TestSetBech32Prefixes(t *testing.T) { require.Equal(t, sdk.GetConfig().GetBech32ConsensusAddrPrefix(), config.GetBech32ConsensusAddrPrefix()) 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()) +} From 3557c9003714817f8926b3998bcfa7c4044906a0 Mon Sep 17 00:00:00 2001 From: Federico Kunze Date: Fri, 28 Aug 2020 11:28:10 +0200 Subject: [PATCH 3/4] changelog --- CHANGELOG.md | 5 ++++- docs/.vuepress/config.js | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 667676fa7..986269800 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,7 +40,10 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements * (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) 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). + +### 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 diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 26fd82ace..8b913b73f 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -14,7 +14,7 @@ module.exports = { logo: { src: '/logo.svg', }, - algolia: {id: 'BH4D9OD16A', key: 'c5da4dd3636828292e3c908a0db39688', index: 'ethermint'}, + algolia: {id: 'BH4D9OD16A', key: '70ee930283c179ccd9a74d8a31afe300', index: 'ethermint'}, topbar: {banner: false}, sidebar: { auto: false, From 00f913abec64915030a65d6f64f5a5f5ea197cb7 Mon Sep 17 00:00:00 2001 From: Federico Kunze Date: Fri, 28 Aug 2020 17:29:00 +0200 Subject: [PATCH 4/4] set HD path --- types/config.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/types/config.go b/types/config.go index a26b34802..3595558da 100644 --- a/types/config.go +++ b/types/config.go @@ -23,6 +23,9 @@ const ( // 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. @@ -35,4 +38,5 @@ func SetBech32Prefixes(config *sdk.Config) { // SetBip44CoinType sets the global coin type to be used in hierarchical deterministic wallets. func SetBip44CoinType(config *sdk.Config) { config.SetCoinType(Bip44CoinType) + config.SetFullFundraiserPath(BIP44HDPath) }