Live Common Bridge Test

This page describes how tests are implemented in order to test live-common bridge.

Transaction status
Account synchronisation

The approach is to test transactions and accounts synchronisation for the different currencies supported in Ledger Live. The transactions are not Broadcasted to the blockchain. We just verify that the bridge behave properly regarding to a tx inputs (recipient address, amount, fee…).

We record the synchronisation state to produce an expected output (Number of accounts, account balance, fresh address…).

For a specific currency, the seed used needs to be frozen, it’s mean that no new operation should be on the accounts used in the dataset as been recorded neither new accounts created.

By doing so we can ensure that the account synchronisation and the transaction status will always provide the same results.

⚠️

Prerequisite - Your computer is expected to have been set up accordingly. Please follow the following guides for this purpose:

- ledger-live CLI
- Physical Ledger device or an emulated device with Speculos

Currency / Account bridge

This section will explain how to generate and add test cases for Accounts and Currencies.

Dataset location: ledger-live/libs/ledger-live-common/src/families/{currency}

Sync accounts

Generate sync dataset (needs a Ledger device connected with the corresponding app opened).

pnpm run:cli generateTestScanAccounts -c <currency>    #Record the APDUs exchanged with the device

Then copy the result in:

ledger-live/libs/ledger-live-common/src/families/<currency>/datasets/<currency>.scanAccounts.1.ts

Send (get transaction status)

Only verify that transaction status is OK, sign and broadcast are out of the scope of those tests.

Test cases: TestRail

Generate account data:

pnpm run:cli generateTestTransaction -c bitcoin -i 1 -s 'native_segwit' --recipient 13LcRWZyZnZu1xrABuAK9Ayftg4kfVs1AA --amount 0.002

Then copy the result in:

ledger-live/libs/ledger-live-common/src/families/<currency>/datasets/<currency>.ts or ledger-live/libs/ledger-live-common/src/families/<currency>/bridge.integration.test.ts

const dataset: CurrenciesData<Transaction> = {
  scanAccounts: [scanAccounts1],
  accounts: [
    {
      transactions: [
        {
          name: "on native segwit recipient",
          transaction: fromTransactionRaw({
            family: "bitcoin",
            recipient: "bc1qqmxqdrkxgx6swrvjl9l2e6szvvkg45all5u4fl",
            amount: "997",
            feePerByte: "1",
            networkInfo
          }),
          expectedStatus: {
            amount: BigNumber("997"),
            estimatedFees: BigNumber("250"),
            totalSpent: BigNumber("1247"),
            errors: {},
            warnings: {
              feeTooHigh: new FeeTooHigh()
            }
          }
        }
      ],
// Account that will be use to send funds from
      raw: {
        id:
          "libcore:1:bitcoin:xpub6BuPWhjLqutPV8SF4RMrrn8c3t7uBZbz4CBbThpbg9GYjqRMncra9mjgSfWSK7uMDz37hhzJ8wvkbDDQQJt6VgwLoszvmPiSBtLA1bPLLSn:",
        seedIdentifier:
          "041caa3a42db5bdd125b2530c47cfbe829539b5a20a5562ec839d241c67d1862f2980d26ebffee25e4f924410c3316b397f34bd572543e72c59a7569ef9032f498",
        name: "Bitcoin 1 (legacy)",
        derivationMode: "",
        index: 0,
        freshAddress: "17gPmBH8b6UkvSmxMfVjuLNAqzgAroiPSe",
        freshAddressPath: "44'/0'/0'/0/59",
        freshAddresses: [
          {
            address: "17gPmBH8b6UkvSmxMfVjuLNAqzgAroiPSe",
            derivationPath: "44'/0'/0'/0/59"
          }
        ],
        pendingOperations: [],
        operations: [],
        currencyId: "bitcoin",
        unitMagnitude: 8,
        balance: "2757",
        blockHeight: 0,
        lastSyncDate: "",
        xpub:
          "xpub6BuPWhjLqutPV8SF4RMrrn8c3t7uBZbz4CBbThpbg9GYjqRMncra9mjgSfWSK7uMDz37hhzJ8wvkbDDQQJt6VgwLoszvmPiSBtLA1bPLLSn"
      }
    }
  ]
};

More specific tests can be written in ledger-live/libs/ledger-live-common/src/families/<currency>/bridge.integration.test.ts

After adding or modify a test you must run from the root of ledger-live:

pnpm common build

Record new outputs:

When running the integration tests, new snapshots will be generated that you can commit as expected results for the tests.

pnpm common ci-test-integration <family>

Testing with the bot Send/receive test plan