@ledgerhq/coin-bitcoin 0.4.0-next.0

package/src/wallet-btc/xpub.ts

@@ -0,0 +1,394 @@
+import maxBy from "lodash/maxBy";
+import range from "lodash/range";
+import some from "lodash/some";
+import BigNumber from "bignumber.js";
+import { TX, Address, IStorage } from "./storage/types";
+import { IExplorer } from "./explorer/types";
+import { ICrypto } from "./crypto/types";
+import { PickingStrategy } from "./pickingstrategies/types";
+import { computeDustAmount, maxTxSizeCeil } from "./utils";
+import { TransactionInfo, InputInfo, OutputInfo } from "./types";
+
+// names inside this class and discovery logic respect BIP32 standard
+class Xpub {
+  storage: IStorage;
+
+  explorer: IExplorer;
+
+  crypto: ICrypto;
+
+  xpub: string;
+
+  derivationMode: string;
+
+  freshAddress: string;
+
+  freshAddressIndex: number;
+
+  // https://github.com/bitcoinjs/bitcoinjs-lib/blob/27a840aac4a12338f1e40c54f3759bbd7a559944/src/bufferutils.js#L24
+  // only works with number so we need to be sure to pass correct numbers
+  OUTPUT_VALUE_MAX: number = Number.MAX_SAFE_INTEGER;
+
+  GAP = 20;
+
+  // need to be bigger than the number of tx from the same address that can be in the same block
+  txsSyncArraySize = 1000;
+
+  // the height of the block during the previous synchronization. We do not need to repeatedly synchronize blocks lower than this height.
+  // -1 means that this account has not been synchronized
+  syncedBlockHeight = -1;
+
+  // the height of the current block in blockchain
+  currentBlockHeight: number | undefined = undefined;
+
+  constructor({
+    storage,
+    explorer,
+    crypto,
+    xpub,
+    derivationMode,
+  }: {
+    storage: IStorage;
+    explorer: IExplorer;
+    crypto: ICrypto;
+    xpub: string;
+    derivationMode: string;
+  }) {
+    this.storage = storage;
+    this.explorer = explorer;
+    this.crypto = crypto;
+    this.xpub = xpub;
+    this.derivationMode = derivationMode;
+    this.freshAddress = "";
+    this.freshAddressIndex = 0;
+  }
+
+  async syncAddress(account: number, index: number, needReorg: boolean): Promise<boolean> {
+    const address = await this.crypto.getAddress(this.derivationMode, this.xpub, account, index);
+
+    this.storage.addAddress(
+      `${this.crypto.network.name}-${this.derivationMode}-${this.xpub}-${account}-${index}`,
+      address,
+    );
+    if (needReorg) {
+      await this.checkAddressReorg(account, index);
+    }
+    // in case pendings have changed we clean them out
+    const hasPendings = this.storage.hasPendingTx({
+      account,
+      index,
+    });
+    if (hasPendings) {
+      this.storage.removePendingTxs({ account, index });
+    }
+    await this.fetchHydrateAndStoreNewTxs(address, account, index);
+    const hasTx = this.storage.hasTx({
+      account,
+      index,
+    });
+    if (account === 0 && hasTx) {
+      this.freshAddressIndex = Math.max(this.freshAddressIndex, index + 1);
+    }
+
+    return hasTx;
+  }
+
+  async checkAddressesBlock(account: number, index: number, needReorg: boolean): Promise<boolean> {
+    const addressesResults = await Promise.all(
+      range(this.GAP).map((_, key) => this.syncAddress(account, index + key, needReorg)),
+    );
+    return some(addressesResults, lastTx => !!lastTx);
+  }
+
+  async syncAccount(account: number, needReorg: boolean): Promise<number> {
+    let index = 0;
+    // eslint-disable-next-line no-await-in-loop
+    while (await this.checkAddressesBlock(account, index, needReorg)) {
+      index += this.GAP;
+    }
+    return index;
+  }
+
+  // TODO : test fail case + incremental
+  async sync(): Promise<void> {
+    this.freshAddressIndex = 0;
+    const highestBlockFromStorage = this.storage.getHighestBlockHeightAndHash();
+    let needReorg = !!highestBlockFromStorage;
+    if (highestBlockFromStorage) {
+      const highestBlockFromExplorer = await this.explorer.getBlockByHeight(
+        highestBlockFromStorage.height,
+      );
+      if (highestBlockFromExplorer?.hash === highestBlockFromStorage.hash) {
+        needReorg = false;
+      }
+    }
+    if (needReorg) {
+      this.syncedBlockHeight = -1;
+    }
+    await Promise.all([
+      this.syncAccount(0, needReorg), // for receive addresses
+      this.syncAccount(1, needReorg), // for change addresses
+    ]);
+    this.freshAddress = await this.crypto.getAddress(
+      this.derivationMode,
+      this.xpub,
+      0,
+      this.freshAddressIndex,
+    );
+  }
+
+  async getXpubBalance(): Promise<BigNumber> {
+    const addresses = await this.getXpubAddresses();
+    return this.getAddressesBalance(addresses);
+  }
+
+  async getAccountBalance(account: number): Promise<BigNumber> {
+    const addresses = await this.getAccountAddresses(account);
+    return this.getAddressesBalance(addresses);
+  }
+
+  async getAddressBalance(address: Address): Promise<BigNumber> {
+    const unspentUtxos = this.storage.getAddressUnspentUtxos(address);
+    return unspentUtxos.reduce((total, { value }) => total.plus(value), new BigNumber(0));
+  }
+
+  async getXpubAddresses(): Promise<Address[]> {
+    return this.storage.getUniquesAddresses({});
+  }
+
+  async getAccountAddresses(account: number): Promise<Address[]> {
+    return this.storage.getUniquesAddresses({ account });
+  }
+
+  async getNewAddress(account: number, gap: number): Promise<Address> {
+    const accountAddresses = await this.getAccountAddresses(account);
+    const lastIndex = (maxBy(accountAddresses, "index") || { index: -1 }).index;
+    let index: number;
+    if (lastIndex === -1) {
+      index = 0;
+    } else {
+      index = lastIndex + gap;
+    }
+    const address: Address = {
+      address: await this.crypto.getAddress(this.derivationMode, this.xpub, account, index),
+      account,
+      index,
+    };
+
+    return address;
+  }
+
+  async buildTx(params: {
+    destAddress: string;
+    amount: BigNumber;
+    feePerByte: number;
+    changeAddress: Address;
+    utxoPickingStrategy: PickingStrategy;
+    sequence: number;
+    opReturnData?: Buffer;
+  }): Promise<TransactionInfo> {
+    const outputs: OutputInfo[] = [];
+
+    const {
+      amount,
+      opReturnData,
+      destAddress,
+      changeAddress,
+      utxoPickingStrategy,
+      feePerByte,
+      sequence,
+    } = params;
+
+    // outputs splitting
+    // btc only support value fitting in uint64 and the lib
+    // we use to serialize output only take js number in params
+    // that are actually even more restricted
+    const desiredOutputLeftToFit: OutputInfo = {
+      script: this.crypto.toOutputScript(destAddress),
+      value: amount,
+      address: destAddress,
+      isChange: false,
+    };
+
+    while (desiredOutputLeftToFit.value.gt(this.OUTPUT_VALUE_MAX)) {
+      outputs.push({
+        script: desiredOutputLeftToFit.script,
+        value: new BigNumber(this.OUTPUT_VALUE_MAX),
+        address: destAddress,
+        isChange: false,
+      });
+
+      desiredOutputLeftToFit.value = desiredOutputLeftToFit.value.minus(this.OUTPUT_VALUE_MAX);
+    }
+
+    if (desiredOutputLeftToFit.value.gt(0)) {
+      outputs.push(desiredOutputLeftToFit);
+    }
+
+    if (opReturnData) {
+      const opReturnOutput: OutputInfo = {
+        script: this.crypto.toOpReturnOutputScript(opReturnData),
+        value: new BigNumber(0),
+        address: null,
+        isChange: false,
+      };
+
+      outputs.push(opReturnOutput);
+    }
+
+    // now we select only the output needed to cover the amount + fee
+    const {
+      totalValue: total,
+      unspentUtxos: unspentUtxoSelected,
+      fee,
+      needChangeoutput,
+    } = await utxoPickingStrategy.selectUnspentUtxosToUse(this, outputs, feePerByte);
+
+    const txHexs = await Promise.all(
+      unspentUtxoSelected.map(unspentUtxo => this.explorer.getTxHex(unspentUtxo.output_hash)),
+    );
+
+    const txs = await Promise.all(
+      unspentUtxoSelected.map(unspentUtxo =>
+        this.storage.getTx(unspentUtxo.address, unspentUtxo.output_hash),
+      ),
+    );
+
+    const inputs: InputInfo[] = unspentUtxoSelected.map((utxo, index) => {
+      return {
+        txHex: txHexs[index],
+        value: utxo.value,
+        address: utxo.address,
+        output_hash: utxo.output_hash,
+        output_index: utxo.output_index,
+        sequence,
+      };
+    });
+
+    const associatedDerivations: [number, number][] = unspentUtxoSelected.map((_utxo, index) => {
+      if (txs[index] == null) {
+        throw new Error("Invalid index in txs[index]");
+      }
+      return [txs[index]?.account || 0, txs[index]?.index || 0];
+    });
+
+    const txSize = maxTxSizeCeil(
+      unspentUtxoSelected.length,
+      outputs.map(o => o.script),
+      true,
+      this.crypto,
+      this.derivationMode,
+    );
+
+    const dustLimit = computeDustAmount(this.crypto, txSize);
+
+    // Abandon the change output if change output amount is less than dust amount
+    if (needChangeoutput && total.minus(amount).minus(fee).gt(dustLimit)) {
+      outputs.push({
+        script: this.crypto.toOutputScript(changeAddress.address),
+        value: total.minus(amount).minus(fee),
+        address: changeAddress.address,
+        isChange: true,
+      });
+    }
+
+    const outputsValue: BigNumber = outputs.reduce((cur, o) => cur.plus(o.value), new BigNumber(0));
+
+    return {
+      inputs,
+      associatedDerivations,
+      outputs,
+      fee: total.minus(outputsValue).toNumber(),
+      changeAddress: changeAddress,
+    };
+  }
+
+  async broadcastTx(rawTxHex: string): Promise<any> {
+    return this.explorer.broadcast(rawTxHex);
+  }
+
+  // internal
+  async getAddressesBalance(addresses: Address[]): Promise<BigNumber> {
+    const balances = await Promise.all(addresses.map(address => this.getAddressBalance(address)));
+
+    return balances.reduce((total, balance) => total.plus(balance), new BigNumber(0));
+  }
+
+  async fetchHydrateAndStoreNewTxs(
+    address: string,
+    account: number,
+    index: number,
+  ): Promise<number> {
+    let pendingTxs: TX[] = [];
+    let txs: TX[] = [];
+    let inserted = 0;
+    do {
+      let lastTxBlockheight =
+        this.storage.getLastConfirmedTxBlock({
+          account,
+          index,
+        })?.height || -1;
+      lastTxBlockheight = Math.max(lastTxBlockheight, this.syncedBlockHeight);
+      if (pendingTxs.length > 0) {
+        txs = await this.explorer.getTxsSinceBlockheight(
+          this.txsSyncArraySize,
+          { address, account, index },
+          lastTxBlockheight + 1,
+          this.currentBlockHeight,
+          false,
+        );
+        inserted += this.storage.appendTxs(txs); // insert not pending tx
+      } else {
+        [pendingTxs, txs] = await Promise.all([
+          this.explorer.getTxsSinceBlockheight(
+            this.txsSyncArraySize,
+            { address, account, index },
+            0,
+            this.currentBlockHeight,
+            true,
+          ),
+          this.explorer.getTxsSinceBlockheight(
+            this.txsSyncArraySize,
+            { address, account, index },
+            lastTxBlockheight + 1,
+            this.currentBlockHeight,
+            false,
+          ),
+        ]);
+        inserted += this.storage.appendTxs(txs); // insert not pending tx
+      }
+    } while (txs.length >= this.txsSyncArraySize); // check whether page is full, if not, it is the last page
+    inserted += this.storage.appendTxs(pendingTxs); // insert pending tx
+    return inserted;
+  }
+
+  async checkAddressReorg(account: number, index: number): Promise<void> {
+    const lastConfirmedTxBlock = this.storage.getLastConfirmedTxBlock({
+      account,
+      index,
+    });
+
+    if (!lastConfirmedTxBlock) {
+      return;
+    }
+
+    const block = await this.explorer.getBlockByHeight(lastConfirmedTxBlock.height);
+
+    // all good the block is valid
+    if (block && block.hash === lastConfirmedTxBlock.hash) {
+      return;
+    }
+
+    // in this case the block is not valid so we delete everything
+    // for that address
+    // TODO: delete only everything for this (address, block)
+    // but need to think if its possible with current storage implem
+
+    this.storage.removeTxs({
+      account,
+      index,
+    });
+  }
+}
+
+export default Xpub;

package/src/xpub.txs.loadExport.unit.test.ts

@@ -0,0 +1,96 @@
+import BitcoinLikeStorage from "./wallet-btc/storage";
+
+describe("testing transaction data load and export", () => {
+  it("testing transaction data load and export", async () => {
+    const storage = new BitcoinLikeStorage();
+    storage.appendTxs([
+      {
+        id: "9e1b337875c21f751e70ee2c2c6ee93d8a6733d0f3ba6d139ae6a0479ebcefb0",
+        inputs: [],
+        outputs: [
+          {
+            output_index: 0,
+            value: "5000000000",
+            address: "mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb",
+            output_hash: "9e1b337875c21f751e70ee2c2c6ee93d8a6733d0f3ba6d139ae6a0479ebcefb0",
+            block_height: 1,
+            rbf: false,
+          },
+          {
+            output_index: 1,
+            value: "0",
+            address: "<unknown>",
+            output_hash: "9e1b337875c21f751e70ee2c2c6ee93d8a6733d0f3ba6d139ae6a0479ebcefb0",
+            block_height: 1,
+            rbf: false,
+          },
+        ],
+        block: {
+          hash: "73c565a6f226978df23480e440b27eb02f307855f50aa3bc72ebb586938f23e0",
+          height: 1,
+          time: "2021-07-28T13:34:17Z",
+        },
+        account: 0,
+        index: 0,
+        address: "mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb",
+        received_at: "2021-07-28T13:34:17Z",
+      },
+      {
+        id: "0b9f98d07eb418fa20573112d3cba6b871d429a06c724a7888ff0886be5213d1",
+        inputs: [
+          {
+            output_hash: "2772f3963856f3eb38cb706ec8c2b62fcdeb2ce10f32cf7160afb3873be6f60d",
+            output_index: 0,
+            value: "5000000000",
+            address: "2NCDBM9DAuMrD1T8XDHMxvbTmLutP7at4AB",
+            sequence: 4294967294,
+          },
+        ],
+        outputs: [
+          {
+            output_index: 0,
+            value: "300000000",
+            address: "mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb",
+            output_hash: "0b9f98d07eb418fa20573112d3cba6b871d429a06c724a7888ff0886be5213d1",
+            block_height: 120,
+            rbf: false,
+          },
+          {
+            output_index: 1,
+            value: "4699983200",
+            address: "2MynSTpze5SDcuLr1DekSV7RVrFpQCo3LeP",
+            output_hash: "0b9f98d07eb418fa20573112d3cba6b871d429a06c724a7888ff0886be5213d1",
+            block_height: 120,
+            rbf: false,
+          },
+        ],
+        block: {
+          hash: "305d4b8d4a6d6ecca0a3dd0216f8ecd090978ed346d1845883c8aa4529d72fc8",
+          height: 120,
+          time: "2021-07-28T13:34:38Z",
+        },
+        account: 0,
+        index: 0,
+        address: "mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb",
+        received_at: "2021-07-28T13:34:38Z",
+      },
+    ]);
+    const primaryIndexCopy = Object.assign({}, storage.primaryIndex);
+    const accountIndexCopy = Object.assign({}, storage.accountIndex);
+    expect(Object.keys(primaryIndexCopy).length).toEqual(2);
+    expect(Object.keys(accountIndexCopy).length).toEqual(1);
+    /* primaryIndex:
+    {
+      'mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb-9e1b337875c21f751e70ee2c2c6ee93d8a6733d0f3ba6d139ae6a0479ebcefb0': 0,
+      'mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb-0b9f98d07eb418fa20573112d3cba6b871d429a06c724a7888ff0886be5213d1': 1
+    }
+      accountIndex:
+      { '0-0': [ 0, 1 ] }
+    */
+    expect(Object.keys(accountIndexCopy["0-0"]).length).toEqual(2);
+    const txs = (await storage.export()).txs;
+    storage.load({ txs: txs, addressCache: {} });
+    expect(storage.primaryIndex).toMatchObject(primaryIndexCopy);
+    expect(storage.accountIndex).toMatchObject(accountIndexCopy);
+  }, 30000);
+});

package/src/xpub.txs.txNoOutput.unit.test.ts

@@ -0,0 +1,30 @@
+import { mapTxToOperations } from "./logic";
+
+describe("testing transaction without output", () => {
+  it("Parse zcash transaction without output", async () => {
+    const tx = {
+      id: "0b9f98d07eb418fa20573112d3cba6b871d429a06c724a7888ff0886be5213d1",
+      inputs: [
+        {
+          output_hash: "2772f3963856f3eb38cb706ec8c2b62fcdeb2ce10f32cf7160afb3873be6f60d",
+          output_index: 0,
+          value: "5000000000",
+          address: "2NCDBM9DAuMrD1T8XDHMxvbTmLutP7at4AB",
+          sequence: 4294967294,
+        },
+      ],
+      outputs: [],
+      block: {
+        hash: "305d4b8d4a6d6ecca0a3dd0216f8ecd090978ed346d1845883c8aa4529d72fc8",
+        height: 120,
+        time: "2021-07-28T13:34:38Z",
+      },
+      account: 0,
+      index: 0,
+      address: "mwXTtHo8Yy3aNKUUZLkBDrTcKT9qG9TqLb",
+      received_at: "2021-07-28T13:34:38Z",
+    };
+    const out = mapTxToOperations(tx, "zcash", "zcash 1", new Set<string>(), new Set<string>());
+    expect(out.length).toEqual(0);
+  }, 30000);
+});

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../../tsconfig.base",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "module": "commonjs",
+    "downlevelIteration": true,
+    "lib": ["es2020", "dom"],
+    "outDir": "lib",
+    "typeRoots": ["./types", "./node_modules/@types"]
+  },
+  "include": ["src/**/*"],
+}

package/types/blake-hash.d.ts

@@ -0,0 +1,6 @@
+export class Blake {
+  update: (data: Buffer | string, encoding?: BufferEncoding) => Blake;
+  digest: (encoding?: BufferEncoding) => Buffer;
+}
+
+export default function (algorithm: string): Blake;

package/types/bs58check/base.d.ts

@@ -0,0 +1 @@
+export default function (checksum: (buffer: Buffer) => Buffer): bs58check;

package/types/coininfo.d.ts

@@ -0,0 +1,100 @@
+type Network = {
+  main: CoinInfo;
+} & Partial<Testnet>;
+type Testnet = {
+  test: CoinInfo;
+  regtest: CoinInfo;
+  simnet: CoinInfo;
+};
+type BitcoinNetwork = {
+  main: CoinInfo;
+} & Testnet;
+
+type CoinInfo = {
+  name: string;
+  unit: string;
+  per1?: number;
+  messagePrefix?: string;
+
+  testnet: boolean;
+  toBitcoinJS: () => BitcoinJS;
+  toBitcore: () => Bitcore;
+
+  hashGenesisBlock: string;
+  port: number;
+  protocol: {
+    magic: number;
+  };
+  bech32: string;
+  // vSeeds
+  seedsDns: Array<string>;
+  // base58Prefixes
+  versions: {
+    bip32: {
+      private: number;
+      public: number;
+    };
+    bip44: number;
+    private: number;
+    public: number;
+    scripthash: number;
+  };
+};
+
+// export function coininfo(input: string): Coin?;
+
+type BitcoinJS = Coin & {
+  messagePrefix: string;
+  bip32: {
+    private: number;
+    public: number;
+  };
+  pubKeyHash: number;
+  scriptHash: number;
+  wif: number;
+  dustThreshold: null;
+};
+// export function toBitcoinJS(): BitcoinJS;
+
+type Bitcore = Coin & {
+  name: string;
+  alias: string;
+  pubkeyhash: number;
+  privatekey: number;
+  scripthash: number;
+  xpubkey: number;
+  xprivkey: number;
+  networkMagic: number;
+  port: number;
+  dnsSeeds: Array<string>;
+};
+// export function toBitcore(): Bitcore;
+
+type CoinName =
+  | "bitcoincash"
+  | "blk"
+  // | "bitcoin"
+  | "bitcoin gold"
+  | "cbn"
+  | "cit"
+  | "dash"
+  | "dnr"
+  | "decred"
+  | "digibyte"
+  | "dogecoin"
+  | "grs"
+  | "litecoin"
+  | "via"
+  | "mon"
+  | "nbt"
+  | "nmc"
+  | "peercoin"
+  | "qtum"
+  | "rvn"
+  | "rdd"
+  | "viacoin"
+  | "vertcoin"
+  | "x42"
+  | "zcash";
+declare const coininfo: Record<CoinName, Network> & { bitcoin: BitcoinNetwork };
+export default coininfo;