Change smart chain derivation path (trustwallet#1101)

Author: hewigovens

android/app/src/androidTest/java/com/trustwallet/core/app/blockchains/CoinAddressDerivationTests.kt

@@ -36,7 +36,7 @@ class CoinAddressDerivationTests {
         CALLISTO -> assertEquals("0x3E6FFC80745E6669135a76F4A7ce6BCF02436e04", address)
         DASH -> assertEquals("XqHiz8EXYbTAtBEYs4pWTHh7ipEDQcNQeT", address)
         DIGIBYTE -> assertEquals("dgb1qtjgmerfqwdffyf8ghcrkgy52cghsqptynmyswu", address)
-        ETHEREUM -> assertEquals("0x8f348F300873Fd5DA36950B2aC75a26584584feE", address)
+        ETHEREUM, SMARTCHAIN -> assertEquals("0x8f348F300873Fd5DA36950B2aC75a26584584feE", address)
         ETHEREUMCLASSIC -> assertEquals("0x078bA3228F3E6C08bEEac9A005de0b7e7089aD1c", address)
         GOCHAIN -> assertEquals("0x5940ce4A14210d4Ccd0ac206CE92F21828016aC2", address)
         GROESTLCOIN -> assertEquals("grs1qexwmshts5pdpeqglkl39zyl6693tmfwp0cue4j", address)
@@ -89,6 +89,6 @@ class CoinAddressDerivationTests {
         FILECOIN -> assertEquals("f1zzykebxldfcakj5wdb5n3n7priul522fnmjzori", address)
         ELROND -> assertEquals("erd1jfcy8aeru6vlx4fe6h3pc3vlpe2cnnur5zetxdhp879yagq7vqvs8na4f8", address)
         BANDCHAIN -> assertEquals("band1624hqgend0s3d94z68fyka2y5jak6vd7u0l50r", address)
-        SMARTCHAIN -> assertEquals("0x49784f90176D8D9d4A3feCDE7C1373dAAb5b13b8", address)
+        SMARTCHAINLEGACY -> assertEquals("0x49784f90176D8D9d4A3feCDE7C1373dAAb5b13b8", address)
     }
 }

android/app/src/androidTest/java/com/trustwallet/core/app/blockchains/binancesmartchain/TestBinanceSmartChainAddress.kt android/app/src/androidTest/java/com/trustwallet/core/app/blockchains/smartchain/TestBinanceSmartChainAddress.kt

@@ -1468,7 +1468,7 @@
   },
   {
     "id": "bsc",
-    "name": "Smart Chain",
+    "name": "Smart Chain Legacy",
     "coinId": 10000714,
     "slip44": 714,
     "symbol": "BNB",
@@ -1490,5 +1490,30 @@
       "clientPublic": "https://data-seed-prebsc-1-s1.binance.org:8545",
       "clientDocs": "https://github.com/ethereum/wiki/wiki/JSON-RPC"
     }
+  },
+  {
+    "id": "smartchain",
+    "name": "Smart Chain",
+    "coinId": 20000714,
+    "slip44": 714,
+    "symbol": "BNB",
+    "decimals": 18,
+    "blockchain": "Ethereum",
+    "derivationPath": "m/44'/60'/0'/0/0",
+    "curve": "secp256k1",
+    "publicKeyType": "secp256k1Extended",
+    "explorer": {
+      "url": "https://bscscan.com",
+      "txPath": "/tx/",
+      "accountPath": "/address/",
+      "sampleTx": "0xb9ae2e808fe8e57171f303ad8f6e3fd17d949b0bfc7b4db6e8e30a71cc517d7e",
+      "sampleAccount": "0x35552c16704d214347f29Fa77f77DA6d75d7C752"
+    },
+    "info": {
+      "url": "https://www.binance.org/en/smartChain",
+      "client": "https://github.com/binance-chain/bsc",
+      "clientPublic": "https://bsc-dataseed1.binance.org",
+      "clientDocs": "https://eth.wiki/json-rpc/API"
+    }
   }
 ]

coins.json

@@ -64,4 +64,4 @@ This list is generated from [./coins.json](../coins.json)
 | 19167   | Zelcash          | ZEL    | <img src="https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/zelcash/info/logo.png" width="32" />      | <https://zel.cash>            |
 | 5718350 | Wanchain         | WAN    | <img src="https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/wanchain/info/logo.png" width="32" />     | <https://wanchain.org>        |
 | 5741564 | Waves            | WAVES  | <img src="https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/waves/info/logo.png" width="32" />        | <https://wavesplatform.com>   |
-| 10000714 | Smart Chain      | BNB    | <img src="https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/bsc/info/logo.png" width="32" />          | <https://www.binance.org/en/smartChain> |
+| 20000714 | Smart Chain      | BNB    | <img src="https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/bsc/info/logo.png" width="32" />          | <https://www.binance.org/en/smartChain> |

docs/coins.md

@@ -82,7 +82,8 @@ enum TWCoinType {
     TWCoinTypeFilecoin = 461,
     TWCoinTypeElrond = 508,
     TWCoinTypeBandChain = 494,
-    TWCoinTypeSmartChain = 10000714,
+    TWCoinTypeSmartChainLegacy = 10000714,
+    TWCoinTypeSmartChain = 20000714,
 };
 
 /// Returns the blockchain for a coin type.

include/TrustWalletCore/TWCoinType.h

@@ -23,6 +23,7 @@ class Entry: public CoinEntry {
             TWCoinTypePOANetwork,
             TWCoinTypeThunderToken,
             TWCoinTypeTomoChain,
+            TWCoinTypeSmartChainLegacy,
             TWCoinTypeSmartChain,
         };
     }

src/Ethereum/Entry.h

@@ -144,6 +144,7 @@ TWData* _Nonnull TWAnyAddressData(struct TWAnyAddress* _Nonnull address) {
     case TWCoinTypeTheta:
     case TWCoinTypeWanchain:
     case TWCoinTypeAion:
+    case TWCoinTypeSmartChainLegacy:
     case TWCoinTypeSmartChain:
         data = parse_hex(string);
         break;

src/interface/TWAnyAddress.cpp

@@ -49,7 +49,7 @@ class CoinAddressDerivationTests: XCTestCase {
                 case .digiByte:
                     let expectedResult = "dgb1qtjgmerfqwdffyf8ghcrkgy52cghsqptynmyswu"
                     assertCoinDerivation(coin, expectedResult, derivedAddress, address)
-                case .ethereum:
+                case .ethereum, .smartChain:
                     let expectedResult = "0x8f348F300873Fd5DA36950B2aC75a26584584feE"
                     assertCoinDerivation(coin, expectedResult, derivedAddress, address)
                 case .ethereumClassic:
@@ -199,7 +199,7 @@ class CoinAddressDerivationTests: XCTestCase {
                 case .elrond:
                     let expectedResult = "erd1jfcy8aeru6vlx4fe6h3pc3vlpe2cnnur5zetxdhp879yagq7vqvs8na4f8"
                     assertCoinDerivation(coin, expectedResult, derivedAddress, address)
-                case .smartChain:
+                case .smartChainLegacy:
                     let expectedResult = "0x49784f90176D8D9d4A3feCDE7C1373dAAb5b13b8"
                     assertCoinDerivation(coin, expectedResult, derivedAddress, address)
                 @unknown default:

swift/Tests/CoinAddressDerivationTests.swift

@@ -229,6 +229,10 @@ class KeyStoreTests: XCTestCase {
                 "address": "0x5dEc7A9299360aEb44c83B8F730F2BF5Dd1688bC",
                 "coin": 10000714,
                 "derivationPath": "m/44'/714'/0'/0/0"
+            }, {
+                "address": "0x33F44330cc4253cCd4ce4224186DB9baCe2190ea",
+                "coin": 20000714,
+                "derivationPath": "m/44'/60'/0'/0/0"
             }],
             "crypto": {
                 "cipher": "aes-128-ctr",
@@ -255,12 +259,19 @@ class KeyStoreTests: XCTestCase {
 
         let password = "e28ddf66cec05c1fc09939a00628b230459202b2493fccac288038ef37815723"
         let keyStore = try KeyStore(keyDirectory: keyDirectory)
-        _ = try keyStore.addAccounts(wallet: keyStore.bnbWallet, coins: [.smartChain], password: password)
+        _ = try keyStore.addAccounts(wallet: keyStore.bnbWallet, coins: [.smartChainLegacy, .smartChain], password: password)
+
+        XCTAssertEqual(keyStore.bnbWallet.accounts.count, 5)
+
+        let accountLegacy = keyStore.bnbWallet.accounts[3]
+
+        XCTAssertEqual(accountLegacy.coin, CoinType.smartChainLegacy)
+        XCTAssertEqual(accountLegacy.address, "0x5dEc7A9299360aEb44c83B8F730F2BF5Dd1688bC")
+
+        let account = keyStore.bnbWallet.accounts[4]
 
-        let account = keyStore.bnbWallet.accounts[3]
-        XCTAssertEqual(keyStore.bnbWallet.accounts.count, 4)
         XCTAssertEqual(account.coin, CoinType.smartChain)
-        XCTAssertEqual(account.address, "0x5dEc7A9299360aEb44c83B8F730F2BF5Dd1688bC")
+        XCTAssertEqual(account.address, "0x33F44330cc4253cCd4ce4224186DB9baCe2190ea")
 
         let saved = try String(contentsOf: keyStore.bnbWallet.keyURL)
         XCTAssertJSONEqual(saved, expected)

swift/Tests/Keystore/KeyStoreTests.swift

@@ -26,9 +26,19 @@ TEST(TWBinanceSmartChainCoinType, TWCoinType) {
     ASSERT_EQ(TWBlockchainEthereum, TWCoinTypeBlockchain(TWCoinTypeSmartChain));
     ASSERT_EQ(0x0, TWCoinTypeP2shPrefix(TWCoinTypeSmartChain));
     ASSERT_EQ(0x0, TWCoinTypeStaticPrefix(TWCoinTypeSmartChain));
+    ASSERT_EQ(20000714, TWCoinTypeSmartChain);
     assertStringsEqual(symbol, "BNB");
     assertStringsEqual(txUrl, "https://bscscan.com/tx/0xb9ae2e808fe8e57171f303ad8f6e3fd17d949b0bfc7b4db6e8e30a71cc517d7e");
     assertStringsEqual(accUrl, "https://bscscan.com/address/0x35552c16704d214347f29Fa77f77DA6d75d7C752");
-    assertStringsEqual(id, "bsc");
+    assertStringsEqual(id, "smartchain");
     assertStringsEqual(name, "Smart Chain");
 }
+
+TEST(TWBinanceSmartChainLegacyCoinType, TWCoinType) {
+    auto id = WRAPS(TWCoinTypeConfigurationGetID(TWCoinTypeSmartChainLegacy));
+    auto name = WRAPS(TWCoinTypeConfigurationGetName(TWCoinTypeSmartChainLegacy));
+
+    ASSERT_EQ(10000714, TWCoinTypeSmartChainLegacy);
+    assertStringsEqual(id, "bsc");
+    assertStringsEqual(name, "Smart Chain Legacy");
+}

tests/BinanceSmartChain/TWCoinTypeTests.cpp

@@ -26,6 +26,8 @@ const auto mnemonic = "team engine square letter hero song dizzy scrub tornado f
 const TWCoinType coinTypeBc = TWCoinTypeBitcoin;
 const TWCoinType coinTypeBnb = TWCoinTypeBinance;
 const TWCoinType coinTypeBsc = TWCoinTypeSmartChain;
+const TWCoinType coinTypeEth = TWCoinTypeEthereum;
+const TWCoinType coinTypeBscLegacy = TWCoinTypeSmartChainLegacy;
 
 TEST(StoredKey, CreateWithMnemonic) {
     auto key = StoredKey::createWithMnemonic("name", password, mnemonic);
@@ -142,19 +144,27 @@ TEST(StoredKey, AddRemoveAccount) {
 
     {
         const auto derivationPath = DerivationPath("m/84'/0'/0'/0/0");
-        key.addAccount("bc1q375sq4kl2nv0mlmup3vm8znn4eqwu7mt6hkwhr", coinTypeBc, derivationPath, "zpub6qbsWdbcKW9sC6shTKK4VEhfWvDCoWpfLnnVfYKHLHt31wKYUwH3aFDz4WLjZvjHZ5W4qVEyk37cRwzTbfrrT1Gnu8SgXawASnkdQ994atn");
+        key.addAccount("bc1qaucw06s3agez8tyyk4zj9kt0q2934e3mcewdpf", coinTypeBc, derivationPath, "zpub6rxtad3SPT1C5GUDjPiKQ5oJN5DBeMbdUR7LrdYt12VbU7TBSpGUkdLvfVYGuj1N5edkDoZ3bu1fdN1HprQYfCBdsSH5CaAAygHGsanwtTe");
         EXPECT_EQ(key.accounts.size(), 1);
     }
     {
         const auto derivationPath = DerivationPath("m/714'/0'/0'/0/0");
-        key.addAccount("bnb1devga6q804tx9fqrnx0vtu5r36kxgp9tmk4xkm", coinTypeBnb, derivationPath, "");
-        key.addAccount("0xf3d468DBb386aaD46E92FF222adDdf872C8CC064", coinTypeBsc, derivationPath, "");
+        key.addAccount("bnb1utrnnjym7ustgw7pgyvtmnxay4qmt3ahh276nu", coinTypeBnb, derivationPath, "");
+        key.addAccount("0x23b02dC8f67eD6cF8DCa47935791954286ffe7c9", coinTypeBsc, derivationPath, "");
         EXPECT_EQ(key.accounts.size(), 3);
     }
+    {
+        const auto derivationPath = DerivationPath("m/60'/0'/0'/0/0");
+        key.addAccount("0xC0d97f61A84A0708225F15d54978D628Fe2C5E62", coinTypeEth, derivationPath, "");
+        key.addAccount("0xC0d97f61A84A0708225F15d54978D628Fe2C5E62", coinTypeBscLegacy, derivationPath, "");
+        EXPECT_EQ(key.accounts.size(), 5);
+    }
 
     key.removeAccount(coinTypeBc);
     key.removeAccount(coinTypeBnb);
     key.removeAccount(coinTypeBsc);
+    key.removeAccount(coinTypeEth);
+    key.removeAccount(coinTypeBscLegacy);
     EXPECT_EQ(key.accounts.size(), 0);
 }
 

tests/Keystore/StoredKeyTests.cpp

@@ -140,13 +140,18 @@ TEST(HDWallet, DeriveAddressBitcoin) {
 TEST(HDWallet, DeriveEthereum) {
     auto wallet = WRAP(TWHDWallet, TWHDWalletCreateWithMnemonic(words.get(), passphrase.get()));
     auto key = WRAP(TWPrivateKey, TWHDWalletGetKeyForCoin(wallet.get(), TWCoinTypeEthereum));
+    auto key2 = WRAP(TWPrivateKey, TWHDWalletGetKeyForCoin(wallet.get(), TWCoinTypeSmartChain));
+
     auto publicKey = TWPrivateKeyGetPublicKeySecp256k1(key.get(), false);
+    auto publicKey2 = TWPrivateKeyGetPublicKeySecp256k1(key2.get(), false);
     auto publicKeyData = WRAPD(TWPublicKeyData(publicKey));
 
     auto address = WRAPS(TWCoinTypeDeriveAddressFromPublicKey(TWCoinTypeEthereum, publicKey));
+    auto address2 = WRAPS(TWCoinTypeDeriveAddressFromPublicKey(TWCoinTypeSmartChain, publicKey2));
 
     assertHexEqual(publicKeyData, "0414acbe5a06c68210fcbb77763f9612e45a526990aeb69d692d705f276f558a5ae68268e9389bb099ed5ac84d8d6861110f63644f6e5b447e3f86b4bab5dee011");
     assertStringsEqual(address, "0x27Ef5cDBe01777D62438AfFeb695e33fC2335979");
+    assertStringsEqual(address2, "0x27Ef5cDBe01777D62438AfFeb695e33fC2335979");
 }
 
 TEST(HDWallet, DeriveAddressEthereum) {
@@ -258,7 +263,7 @@ TEST(HDWallet, DeriveElrond) {
 TEST(HDWallet, DeriveBinance) {
     auto wallet = WRAP(TWHDWallet, TWHDWalletCreateWithMnemonic(words.get(), passphrase.get()));
     auto key = WRAP(TWPrivateKey, TWHDWalletGetKeyForCoin(wallet.get(), TWCoinTypeBinance));
-    auto key2 = WRAP(TWPrivateKey, TWHDWalletGetKeyForCoin(wallet.get(), TWCoinTypeSmartChain));
+    auto key2 = WRAP(TWPrivateKey, TWHDWalletGetKeyForCoin(wallet.get(), TWCoinTypeSmartChainLegacy));
     auto keyData = WRAPD(TWPrivateKeyData(key.get()));
     auto keyData2 = WRAPD(TWPrivateKeyData(key2.get()));
 

tests/interface/TWHDWalletTests.cpp

@@ -26,13 +26,24 @@ describe('Wallet Core types tests', () => {
         const coin = CoinType.bsc;
         expect(coin).to.equal(10000714)
         expect(CoinType.id(coin)).to.equal('bsc')
-        expect(CoinType.name(coin)).to.equal('Smart Chain')
+        expect(CoinType.name(coin)).to.equal('Smart Chain Legacy')
         expect(CoinType.slip44(coin)).to.equal(714)
         expect(CoinType.symbol(coin)).to.equal('BNB')
         expect(CoinType.decimals(coin)).to.equal(18)
         expect(CoinType.derivationPath(coin)).to.equal(`m/44'/714'/0'/0/0`)
     })
 
+    it('test CoinType.smartchain', () => {
+        const coin = CoinType.smartchain;
+        expect(coin).to.equal(20000714)
+        expect(CoinType.id(coin)).to.equal('smartchain')
+        expect(CoinType.name(coin)).to.equal('Smart Chain')
+        expect(CoinType.slip44(coin)).to.equal(714)
+        expect(CoinType.symbol(coin)).to.equal('BNB')
+        expect(CoinType.decimals(coin)).to.equal(18)
+        expect(CoinType.derivationPath(coin)).to.equal(`m/44'/60'/0'/0/0`)
+    })
+
     it('test Ethereum encoding SigningInput', () => {
         const input = TW.Ethereum.Proto.SigningInput.create({
             toAddress: '0x3535353535353535353535353535353535353535',