如何開發一款以太坊（安卓）錢包系列1 - 通過助記詞建立賬號

Tiny熊發表於2019-03-16
安卓

最新內容會更新在主站深入淺出區塊鏈社群
原文連結:以太坊（安卓）錢包系列1 - 通過助記詞建立賬號

上週我開源了一款錢包，反映很好，一週時間不到已經快到100 Star。接下來我會幾篇系列文章把開發以太坊錢包的核心要點寫出來，也算是對程式碼的一個解讀。

寫在前面

錢包是使用Android安卓平臺編寫，使用的是原生程式碼Java 語言編寫， 是基於Java 1.8 版本，也使用了Java 1.8 中一些較新的語言特性，如 Lambda表示式等；另外還較多使用了ReactiveX/RxAndroid響應式程式設計用法。

在本系列文章中，重點是介紹以太坊錢包賬號、交易等邏輯，有時可能會假定讀者已經瞭解Android開發等相關知識，因為這些內容不是文章的重點，因此不會過多介紹，請海涵。

錢包包含的功能

通常一個錢包會包含以下功能：

  • [x] 支援通過生成助記詞、Keystore檔案、私鑰 建立錢包賬號。
  • [x] 支援匯出錢包賬號助記詞、私鑰、Keystore檔案。
  • [x] 支援多個錢包賬號管理
  • [x] 賬戶餘額查詢及轉賬功能（二維碼掃描支援）。
  • [x] 支援ERC20 代幣（餘額顯示、轉賬、代幣幣價顯示）
  • [x] 支援用法幣（美元和人民幣）實時顯示幣價。
  • [x] 歷史交易列表顯示

建立賬號預備知識

我們先來介紹第一個功能：通過生成助記詞、Keystore檔案、私鑰建立錢包賬號。
本系列中，錢包都是指分層確定性錢包，（HD錢包 Hierarchical Deterministic Wallets）， 之前部落格有一篇文章分層錢包進行了詳細的介紹，還不熟悉的可以讀一下。
為了保持本文的完整，這裡做一個總結性回顧：以太坊及比特幣的地址是由隨機生成的私鑰經過橢圓曲線等演算法單向推倒而來 ，BIP32及BIP44是為方便管理私鑰提出的分層推倒方案，BIP39 定義助記詞讓分層種子的備份更方便。
而KeyStore檔案是用來解密以太坊儲存私鑰的一種方式，大家可以閱讀下這篇文章: 賬號Keystore檔案匯入匯出瞭解更多。

實現完成的，介面如下圖：

如何開發一款以太坊（安卓）錢包系列1 - 通過助記詞建立賬號

這是一張匯入錢包賬號的截圖（匯入和建立，其實原理一樣），介面仿照ImToken，不過本文將不會介紹UI部分的編寫。

Web3j & bitcoinj

為了完成建立賬號功能，我們需要使用到兩個庫：Web3j 和 bitcoinj

Web3是一套和以太坊通訊的封裝庫，Web3j是Java版本的實現，例如發起交易和智慧合約進行互動，下圖很好的表達了其作用。
如何開發一款以太坊（安卓）錢包系列1 - 通過助記詞建立賬號

不過本文中的功能，主要是使用了web3j中橢圓曲線加密及KeyStore檔案的生成與解密。

bitcoinj 的功能和web3類似，它是比特幣協議的Java實現，他實現了 BIP32、BIP44及BIP39 相關協議。

Android使用Gradle來構建，直接在app/build.gradle檔案中加入：

implementation 'org.web3j:core:4.1.0-android'
implementation 'org.bitcoinj:bitcoinj-core:0.14.7'

提示： 實踐中遇到的一個問題，由於bitcoinj 中引入了 com.lambdaworks:scrypt加密庫， 它包含的lib/x86_64/darwin/libscrypt.dylib檔案，會導致在進行Android App Bundle 編譯時會出現錯誤（好像也會導致某些機型沒法安裝），解決辦法是在 build.gradle 加入一下語句，把這個檔案在打包時排除掉。
> packagingOptions {
> exclude 'lib/x86_64/darwin/libscrypt.dylib'
> }

建立賬號實現

通過助記詞常見錢包賬號

這是目前錢包客戶端，最常見的一種為使用者常見賬號的方式，這裡會包含一下幾個核心步驟：

  1. 生成一個隨機數種子；
  2. 通過隨機數種子得到助記詞；
  3. 通過 種子 + 路徑 派生生成私鑰；
  4. 使用KeyStore儲存私鑰；
  5. 私鑰推倒出賬號地址。

大家可以在再次閱讀分層錢包，理解為何這麼做的原因。

理解了上面幾點，那麼程式碼就容易明白了，程式碼在程式碼庫中的app/src/pro/upchain/wallet/utils/ETHWalletUtils.java中，關鍵程式碼邏輯如下：

    // 建立錢包物件入口函式
    public static ETHWallet generateMnemonic(String walletName, String pwd) {
        String[] pathArray = "m/44'/60'/0'/0/0".split("/");

        long creationTimeSeconds = System.currentTimeMillis() / 1000;

        SecureRandom secureRandom = SecureRandomUtils.secureRandom();
        DeterministicSeed ds = new DeterministicSeed(secureRandom, 128, "", creationTimeSeconds);

        return generateWalletByMnemonic(walletName, ds, pathArray, pwd);
    }

    /**
     * @param walletName 錢包名稱
     * @param ds         助記詞加密種子
     * @param pathArray  助記詞標準
     * @param pwd        密碼
     * @return
     */
    @Nullable
    public static ETHWallet generateWalletByMnemonic(String walletName, DeterministicSeed ds,
                                                     String[] pathArray, String pwd) {
        //種子
        byte[] seedBytes = ds.getSeedBytes();
        //助記詞
        List<String> mnemonic = ds.getMnemonicCode();

        if (seedBytes == null)
            return null;

        //  衍生推倒key
        DeterministicKey dkKey = HDKeyDerivation.createMasterPrivateKey(seedBytes);
        for (int i = 1; i < pathArray.length; i++) {
            ChildNumber childNumber;
            if (pathArray[i].endsWith("'")) {
                int number = Integer.parseInt(pathArray[i].substring(0,
                        pathArray[i].length() - 1));
                childNumber = new ChildNumber(number, true);
            } else {
                int number = Integer.parseInt(pathArray[i]);
                childNumber = new ChildNumber(number, false);
            }
            dkKey = HDKeyDerivation.deriveChildKey(dkKey, childNumber);
        }

        ECKeyPair keyPair = ECKeyPair.create(dkKey.getPrivKeyBytes());
        ETHWallet ethWallet = generateWallet(walletName, pwd, keyPair);
        if (ethWallet != null) {
            ethWallet.setMnemonic(convertMnemonicList(mnemonic));
        }
        return ethWallet;
    }

        @Nullable
    private static ETHWallet generateWallet(String walletName, String pwd, ECKeyPair ecKeyPair) {
        WalletFile keyStoreFile;
        try {
            keyStoreFile = Wallet.create(pwd, ecKeyPair, 1024, 1); // WalletUtils. .generateNewWalletFile();
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }

        BigInteger publicKey = ecKeyPair.getPublicKey();
        String s = publicKey.toString();

        String wallet_dir = AppFilePath.Wallet_DIR;

        String keystorePath = "keystore_" + walletName + ".json";
        File destination = new File(wallet_dir, "keystore_" + walletName + ".json");

        //目錄不存在則建立目錄，建立不了則報錯
        if (!createParentDir(destination)) {
            return null;
        }
        try {
            objectMapper.writeValue(destination, keyStoreFile);
        } catch (IOException e) {
            e.printStackTrace();
            return null;
        }

        ETHWallet ethWallet = new ETHWallet();
        ethWallet.setName(walletName);
        ethWallet.setAddress(Keys.toChecksumAddress(keyStoreFile.getAddress()));
        ethWallet.setKeystorePath(destination.getAbsolutePath());
        ethWallet.setPassword(Md5Utils.md5(pwd));
        return ethWallet;
    }

上述程式碼中，generateMnemonic()是入口函式，最終返回的是一個ETHWallet 自定義的錢包實體類，一個例項就對應一個錢包，ETHWallet儲存了錢包相關的屬性，後面會詳細介紹，如果對它序列化儲存錢包賬號及多個錢包賬號管理。

幾個注意事項

關於助記詞及私鑰的儲存，有幾點要特別注意，否則有可能和其他錢包無法相容或導致私鑰洩漏。

這部分作為訂閱者福利，發表在我的小專欄，趁還未漲價，趕緊訂閱吧，超值的！

參考文件

加入知識星球，和一群優秀的區塊鏈從業者一起學習。
深入淺出區塊鏈 - 系統學習區塊鏈，打造最好的區塊鏈技術部落格。

相關文章