Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

types: support eth hex address on accounts #502

Merged
merged 4 commits into from
Sep 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Improvements

* (types) [\#502](https://github.com/ChainSafe/ethermint/pull/502) `EthAccount` now also exposes the Ethereum hex address in `string` format to clients.
* (types) [\#494](https://github.com/ChainSafe/ethermint/pull/494) Update `EthAccount` public key JSON type to `string`.
* (app) [\#471](https://github.com/ChainSafe/ethermint/pull/471) Add `x/upgrade` module for managing software updates.
* (`x/evm`) [\#458](https://github.com/ChainSafe/ethermint/pull/458) Define parameter for token denomination used for the EVM module.
Expand Down
37 changes: 36 additions & 1 deletion docs/basics/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,44 @@ clients. The hex format on the other hand, is the Ethereum `common.Address` repr
Cosmos `sdk.AccAddress`.

- Address (Bech32): `eth1crwhac03z2pcgu88jfnqnwu66xlthlz2rhljah`
- Address (Hex): `0xc0dd7ee1f112838470e7926609bb9ad1bebbfc4a`
- Address ([EIP55](https://eips.ethereum.org/EIPS/eip-55) Hex): `0xc0dd7ee1f112838470e7926609bb9ad1bebbfc4a`
- Compressed Public Key (Bech32): `ethpub1pfqnmk6pqnwwuw0h9hj58t2hyzwvqc3truhhp5tl5hfucezcfy2rs8470nkyzju2vmk645fzmw2wveaqcqek767kwa0es9rmxe9nmmjq84cpny3fvj6tpg`

You can query an account address using the Cosmos CLI or REST clients:

```bash
# NOTE: the --output (-o) flag will define the output format in JSON or YAML (text)
ethermintcli q auth account $(ethermintcli keys show <MYKEY> -a) -o text
|
address: eth1f8rqrfwut7ngkxwth0gt99h0lxnxsp09ngvzwl
eth_address: 0x49c601A5DC5FA68b19CBbbd0b296eFF9a66805e5
coins:
- denom: aphoton
amount: "1000000000000000000"
- denom: stake
amount: "999999999900000000"
public_key: ethpub1pfqnmkepqw45vpsn6dzvm7k22zrghx0nfewjdfacy7wyycv5evfk57kyhwr8cqj5r4x
account_number: 0
sequence: 1
code_hash: c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470
```

``` bash
# GET /auth/accounts/{address}
curl -X GET "<NODE_IP>/auth/accounts/eth1f8rqrfwut7ngkxwth0gt99h0lxnxsp09ngvzwl" -H "accept: application/json"
```

::: tip
The Cosmos SDK Keyring output (i.e `ethermintcli keys`) only supports addresses and public keys in Bech32 format.
:::

To retrieve the Ethereum hex address using Web3, use the JSON-RPC `eth_accounts` endpoint:

```bash
# query against a local node
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1}' -H "Content-Type: application/json" http://localhost:26664
```

## Next {hide}

Learn about Ethermint [transactions](./transactions.md) {hide}
3 changes: 2 additions & 1 deletion docs/quickstart/run_node.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ To run a node with the same key every time: replace `ethermintcli keys add $KEY`
echo "your mnemonic here" | ethermintcli keys add $KEY --recover
```

::: tip Ethermint currently only supports 24 word mnemonics.
::: tip
Ethermint currently only supports 24 word mnemonics.
:::

You can generate a new key/mnemonic with:
Expand Down
3 changes: 3 additions & 0 deletions types/account.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ func (acc *EthAccount) SetBalance(amt sdk.Int) {

type ethermintAccountPretty struct {
Address sdk.AccAddress `json:"address" yaml:"address"`
EthAddress string `json:"eth_address" yaml:"eth_address"`
Coins sdk.Coins `json:"coins" yaml:"coins"`
PubKey string `json:"public_key" yaml:"public_key"`
AccountNumber uint64 `json:"account_number" yaml:"account_number"`
Expand All @@ -87,6 +88,7 @@ type ethermintAccountPretty struct {
func (acc EthAccount) MarshalYAML() (interface{}, error) {
alias := ethermintAccountPretty{
Address: acc.Address,
EthAddress: acc.EthAddress().String(),
Coins: acc.Coins,
AccountNumber: acc.AccountNumber,
Sequence: acc.Sequence,
Expand Down Expand Up @@ -114,6 +116,7 @@ func (acc EthAccount) MarshalYAML() (interface{}, error) {
func (acc EthAccount) MarshalJSON() ([]byte, error) {
alias := ethermintAccountPretty{
Address: acc.Address,
EthAddress: acc.EthAddress().String(),
Coins: acc.Coins,
AccountNumber: acc.AccountNumber,
Sequence: acc.Sequence,
Expand Down
3 changes: 2 additions & 1 deletion types/account_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,15 @@ func TestEthermintAccount_String(t *testing.T) {

accountStr := fmt.Sprintf(`|
address: %s
eth_address: %s
coins:
- denom: aphoton
amount: "1"
public_key: %s
account_number: 10
sequence: 50
code_hash: "0102"
`, addr, bech32pubkey)
`, addr, ethAcc.EthAddress().String(), bech32pubkey)

require.Equal(t, accountStr, ethAcc.String())

Expand Down