Generalize Cosmos address to alternative pubkey hash, merge evmos (tr…

…ustwallet#2241) * Generalize Cosmos address to support alternative pubkey hash, from config; merge native Evmos implementation with Cosmos * Remove direct Trezor header * Add publickKeyHasher to Ethereum-type network as well in registry (keccak256) * Introduce Hasher enum, in CoinInfoData include enums instead of pointers * Introduce new field in registry.json: addressHasher, used by Cosmos * Additional hash tests (coverage) * Additional Solana AnyAddress test (coverage) * Add documentation on the registry.json fields
leilaa55 · May 27, 2022 · f29dd54 · f29dd54
1 parent 471ba5b
commit f29dd54
Show file tree

Hide file tree

Showing 25 changed files with 401 additions and 210 deletions.
diff --git a/codegen/lib/templates/CoinInfoData.cpp.erb b/codegen/lib/templates/CoinInfoData.cpp.erb
@@ -1,4 +1,4 @@
-// Copyright © 2017-2021 Trust Wallet.
+// Copyright © 2017-2022 Trust Wallet.
 //
 // This file is part of Trust. The full Trust copyright notice, including
 // terms governing use, modification, and redistribution, is contained in the
@@ -27,8 +27,9 @@ static const CoinInfo defaultsForMissing = {
     0,
     0,
     TWHRPUnknown,
-    Hash::sha256ripemd,
-    Hash::sha256d,
+    Hash::HashFunc_sha256ripemd,
+    Hash::HashFunc_sha256d,
+    Hash::HashFunc_sha256ripemd,
     "?",
     2,
     "",
@@ -62,8 +63,9 @@ const CoinInfo getCoinInfo(TWCoinType coin) {
                 <% if coin['p2pkhPrefix'].nil? -%>0<% else -%><%= coin['p2pkhPrefix'] %><% end -%>,
                 <% if coin['p2shPrefix'].nil? -%>0<% else -%><%= coin['p2shPrefix'] %><% end -%>,
                 TWHRP<% if coin['hrp'].nil? -%>Unknown<% else -%><%= format_name(coin['name']) %><% end -%>,
-                Hash::<% if coin['publicKeyHasher'].nil? -%>sha256ripemd<% else -%><%= coin['publicKeyHasher'] %><% end -%>,
-                Hash::<% if coin['base58Hasher'].nil? -%>sha256d<% else -%><%= coin['base58Hasher'] %><% end -%>,
+                Hash::HashFunc_<% if coin['publicKeyHasher'].nil? -%>sha256ripemd<% else -%><%= coin['publicKeyHasher'] %><% end -%>,
+                Hash::HashFunc_<% if coin['base58Hasher'].nil? -%>sha256d<% else -%><%= coin['base58Hasher'] %><% end -%>,
+                Hash::HashFunc_<% if coin['addressHasher'].nil? -%>sha256ripemd<% else -%><%= coin['addressHasher'] %><% end -%>,
                 "<%= coin['symbol'] %>",
                 <%= coin['decimals'] %>,
                 "<%= explorer_tx_url(coin) %>",

diff --git a/coverage.stats b/coverage.stats
@@ -1 +1 @@
-94.7
+94.7
diff --git a/docs/registry-fields.md b/docs/registry-fields.md
@@ -0,0 +1,181 @@
+# Documentation for registry.json
+
+The file `registry.json` contains meta info about supported blockchains.
+It is the input for some generated source files and documentation ([registry.md](registry.md)), and values from it are used during runtime.
+
+## Fields
+
+**`id`**
+Internal ID of the chain. Lowercase letters only.  Should be never changed.
+Ex.: `'bitcoin'`.
+
+**`name`**
+More readable name, can include lower/uppercase, space.
+Ex.: `'Bitcoin'`.
+
+**`displayName`**
+Optional, if present, overrides **name** for places where it is visible to the user. 
+Ex.: `'BNB Beacon Chain'`.
+
+**`coinId`**
+Internal numerical ID for the chain. In most cases it is the ID used in BIP-44 address derivation.
+See quasi-standard repository here:  https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+Ex.: `0` for Bitcoin, `60` for Ethereum.
+
+Some typical special cases:
+
+- Multiple chains/coins with the same ID: adding value `10000000` to distinguish.  Possible multiple times.
+Ex.: `10000118` for Osmosis, `118` for Cosmos; `20000714` for BNB Smart Chain.
+- Ethereum-clone chains with no own BIP-44 ID: use the `10000000 + chainID` as coinID.
+
+**`symbol`**
+Symbol of the native coin.  Typically a short, upper-case-only string.
+Ex.: `BTC`, `ETH`.
+
+**`decimals`**
+Number of decimals in coin amounts.  Amounts are typically expressed as (large) integer values, with all decimal values, like `100000` for `0.00100000` BTC (decimals=8).
+Ex.: `8` for Bitcoin, `18` for Ethereum.
+
+**`blockchain`**
+Some chains are very similar and share the implementation code.
+This flag is used to direct logic to the right implementation.
+Ex. `'Cosmos'` for Oasis, as Oasis is handled by Cosmos implementation.
+
+**`derivation`**
+Defines properties for address derivation, most importantly derivation paths.
+
+Typically only one derivation is supported per chain, in this case the definition looks like:
+
+```
+  "derivation": [
+    {
+      "path": "m/44'/60'/0'/0/0"
+    }
+  ],
+```
+
+It contains the derivation path used to derive private key (and address) from the wallet mnemonic (HD wallet).
+Derivation path is usually well known for a chain implementation, and different wallet implementations use the same path (so cross-import is possible).
+Note that the second number, the BIP-44 ID, usually matches the coinId.
+
+Some blockchains may support additional alternative derivations.  These have:
+
+- a name
+- a alternative derivation path (optional)
+
+Derivation may differ in the derivation path, or by address generation method (based on the derivation name).
+The first derivation is considered the default.
+
+Examples:
+Bitcoin uses Segwit address by default, but also supports earlier P2PKH addresses:
+
+```
+    "derivation": [
+      {
+        "name": "segwit",
+        "path": "m/84'/0'/0'/0/0",
+        "xpub": "zpub",
+        "xprv": "zprv"
+      },
+      {
+        "name": "legacy",
+        "path": "m/44'/0'/0'/0/0",
+        "xpub": "xpub",
+        "xprv": "xprv"
+      }
+    ],
+```
+
+Solana supports two derivations, which differ in derivation path:
+
+```
+    "derivation": [
+      {
+        "path": "m/44'/501'/0'"
+      },
+      {
+        "name": "solana",
+        "path": "m/44'/501'/0'/0'"
+      }
+    ],
+```
+
+**`xpub` and `xprv`**
+Defines the XPub and XPriv format used, Bitcoin-style. Defined inside the derivation section (as they may differ per derivation).
+
+**`curve`**
+Defines the elliptic curve used in private-public key generation and signing.
+Ex.: `'secp256k1'` for Bitcoin and Ethereum, `'ed25519'` for Polkadot.
+
+**`publicKeyType`**
+The type of public key used.
+Ex.: `'secp256k1'` for Bitcoin, `'secp256k1Extended'` for Ethereum.
+
+**`staticPrefix`**
+Optional byte prefix, used in some Bitcoin-like chains.
+Ex.: `7` for Decred.
+
+**`p2pkhPrefix` and `p2shPrefix`**
+Defines the prefix byte used in P2PKH and P2SH addresses, Bitcoin style.
+Ex. `0` and `5` for Bitcoin.
+
+**`hrp`**
+Human Readable Prefix used to prefix an address, used to indicate type of address, to minimalize risk of accidental address mix-up across chains.
+Ex. `'bc'` for Bitcoin, `'cosmos'` for Cosmos.
+
+**`publicKeyHasher`**
+Hash method used in XPub derivation.
+Default is `sha256ripemd`.
+Ex.: `'sha256ripemd'` for Bitcoin, `'blake256ripemd'` for Decred.
+
+**`base58Hasher`**
+Hash method used in extended private and public key derivation, for checksumming within Base58 addresses.
+Default is `sha256d`.
+Ex.: `'sha256d'` for Bitcoin, `'blake256d'` for Decred.
+
+**`addressHasher`**
+Hash method used in the publicKey -> address generation.
+Only some chain implementation use this setting, in most implementation this is fixed (and value here is only informative).
+Default is `sha256ripemd`.
+Ex.: missing ('sha256ripemd') for Bitcoin, `'keccak256'` for Ethereum, `'sha256ripemd'` for Cosmos, `'keccak256'` for Native Evmos, despite being a Cosmos fork.
+
+**`explorer`**
+Explorer web service for this chain. Sub-fields are used so that full URLs can be built for any address or transactions.
+Note that the sample values should include existing IDs, so that the resulting full URL is valid.
+
+Example:
+
+```
+  "explorer": {
+    "url": "https://blockchair.com",
+    "txPath": "/bitcoin/transaction/",
+    "accountPath": "/bitcoin/address/",
+    "sampleTx": "0607f62530b68cfcc91c57a1702841dd399a899d0eecda8e31ecca3f52f01df2",
+    "sampleAccount": "17A16QmavnUfCW11DAApiJxp7ARnxN5pGX"
+  },
+```
+
+This results in the full URL for the sample address:
+https://blockchair.com/bitcoin/address/17A16QmavnUfCW11DAApiJxp7ARnxN5pGX
+which is a working URL.
+
+Beware of the starting-ending slashes used.
+
+**`info`**
+Section with project info:
+
+**`info/url`**
+Main project website.
+
+**`info/source`**
+Link to the default implementation of the node or RPC gateway that can be used by a wallet.
+
+**`info/rpc`**
+Optional URL to an available public RPC service.
+
+**`info/documentation`**
+Main porject documentation site/subsite.
+
+**`deprecated`**
+If set to `true`, the project is considered deprecated: its info is kept here, but it will not be supported.
+Ex. `'true'` for Kin.
diff --git a/include/TrustWalletCore/TWBlockchain.h b/include/TrustWalletCore/TWBlockchain.h
@@ -48,10 +48,9 @@ enum TWBlockchain {
     TWBlockchainDecred = 35, // Bitcoin
     TWBlockchainZcash = 36, // Bitcoin
     TWBlockchainGroestlcoin = 37, // Bitcoin
-    TWBlockchainNativeEvmos = 38, // Cosmos
-    TWBlockchainThorchain = 39, // Cosmos
-    TWBlockchainRonin = 40, // Ethereum
-    TWBlockchainKusama = 41, // Polkadot
+    TWBlockchainThorchain = 38, // Cosmos
+    TWBlockchainRonin = 39, // Ethereum
+    TWBlockchainKusama = 40, // Polkadot
 };
 
 TW_EXTERN_C_END