mainnet-js 3.0.0-next.0 → 3.0.0-next.2

package/src/history/getHistory.test.ts

@@ -3,6 +3,7 @@ import { WalletTypeEnum } from "../wallet/enum";
 import { createWallet } from "../wallet/createWallet";
 import { mine } from "../mine";
 import { encodeCashAddress } from "@bitauth/libauth";
+import { toBch } from "../util";
 
 test("Should get miner history", async () => {
   const alice = await RegTestWallet.fromWIF(process.env.PRIVATE_WIF!);
@@ -28,33 +29,29 @@ test("Should get an address history", async () => {
     let sendResponse = await alice.send([
       {
         cashaddr: bob.cashaddr!,
-        value: 31000,
-        unit: "satoshis",
+        value: 31000n,
       },
       {
         cashaddr: charlie.cashaddr!,
-        value: 41000,
-        unit: "satoshis",
+        value: 41000n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
     await bob.send([
       {
         cashaddr: charlie.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 1 });
     await bob.send([
       {
         cashaddr: alice.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
     ]);
     expect(sendResponse!.txId!.length).toBe(64);
-    expect(sendResponse.balance!.bch).toBeGreaterThan(0.01);
+    expect(toBch(sendResponse.balance!)).toBeGreaterThan(0.01);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
 
     // Build Bob's wallet from a public address, check his balance.
@@ -110,28 +107,25 @@ test("Should get a history with multi-party sends", async () => {
     let sendResponse = await alice.send([
       {
         cashaddr: bob.cashaddr!,
-        value: 31000,
-        unit: "satoshis",
+        value: 31000n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
     await bob.send([
       {
         cashaddr: charlie.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 1 });
     await bob.send([
       {
         cashaddr: alice.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
     ]);
     expect(sendResponse!.txId!.length).toBe(64);
-    expect(sendResponse.balance!.bch).toBeGreaterThan(0.01);
+    expect(toBch(sendResponse.balance!)).toBeGreaterThan(0.01);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 1 });
 
     // Build Bob's wallet from a public address, check his balance.
@@ -190,31 +184,27 @@ test("Should cut results with a longer history to given count", async () => {
     let sendResponse = await alice.send([
       {
         cashaddr: bob.cashaddr!,
-        value: 31000,
-        unit: "satoshis",
+        value: 31000n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
     await bob.send([
       {
         cashaddr: charlie.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
       {
         cashaddr: alice.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
       {
         cashaddr: alice.cashaddr!,
-        value: 2100,
-        unit: "satoshis",
+        value: 2100n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 1 });
     expect(sendResponse!.txId!.length).toBe(64);
-    expect(sendResponse.balance!.bch).toBeGreaterThan(0.01);
+    expect(toBch(sendResponse.balance!)).toBeGreaterThan(0.01);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
 
     // Build Bob's wallet from a public address, check his balance.
@@ -258,30 +248,26 @@ test("Should handle input and fee from many utxos", async () => {
     let sendResponse = await alice.send([
       {
         cashaddr: bob.cashaddr!,
-        value: 600,
-        unit: "satoshis",
+        value: 600n,
       },
       {
         cashaddr: bob.cashaddr!,
-        value: 600,
-        unit: "satoshis",
+        value: 600n,
       },
       {
         cashaddr: bob.cashaddr!,
-        value: 600,
-        unit: "satoshis",
+        value: 600n,
       },
       {
         cashaddr: bob.cashaddr!,
-        value: 600,
-        unit: "satoshis",
+        value: 600n,
       },
     ]);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
     await bob.sendMax(charlie.cashaddr!);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 1 });
     expect(sendResponse!.txId!.length).toBe(64);
-    expect(sendResponse.balance!.bch).toBeGreaterThan(0.01);
+    expect(toBch(sendResponse.balance!)).toBeGreaterThan(0.01);
     await mine({ cashaddr: alice.getDepositAddress(), blocks: 10 });
 
     // Build Bob's wallet from a public address, check his balance.

package/src/history/getHistory.ts

@@ -22,38 +22,6 @@ type Transaction = TransactionCommon & {
   hash: string;
 };
 
-// export type AddressTxI = TxI & {
-//   address: string;
-// }
-
-// export const getAddressHistory = async ({
-//   address,
-//   provider,
-//   unit = "sat",
-//   fromHeight = 0,
-//   toHeight = -1,
-//   start = 0,
-//   count = -1,
-// }: {
-//   address: string;
-//   provider: NetworkProvider;
-//   unit?: UnitEnum;
-//   fromHeight?: number;
-//   toHeight?: number;
-//   start?: number;
-//   count?: number;
-// }): Promise<TransactionHistoryItem[]> => {
-//   return getHistory({
-//     addresses: [address],
-//     provider,
-//     unit,
-//     fromHeight,
-//     toHeight,
-//     start,
-//     count,
-//   });
-// }
-
 export const getHistory = async ({
   addresses,
   provider,
@@ -225,7 +193,7 @@ export const getHistory = async ({
         value: Number(prevoutOutput.valueSatoshis),
         token: prevoutOutput.token
           ? {
-              tokenId: binToHex(prevoutOutput.token.category),
+              category: binToHex(prevoutOutput.token.category),
               amount: prevoutOutput.token.amount,
               capability: prevoutOutput.token.nft?.capability
                 ? prevoutOutput.token.nft.capability
@@ -264,7 +232,7 @@ export const getHistory = async ({
         value: Number(output.valueSatoshis),
         token: output.token
           ? {
-              tokenId: binToHex(output.token.category),
+              category: binToHex(output.token.category),
               amount: output.token.amount,
               capability: output.token.nft?.capability
                 ? output.token.nft.capability
@@ -302,14 +270,14 @@ export const getHistory = async ({
         satoshiBalance -= input.value;
 
         if (input.token?.amount) {
-          ftTokenBalances[input.token.tokenId] =
-            (ftTokenBalances[input.token.tokenId] || BigInt(0)) -
+          ftTokenBalances[input.token.category] =
+            (ftTokenBalances[input.token.category] || BigInt(0)) -
             input.token.amount;
         }
 
-        if (input.token?.capability) {
-          nftTokenBalances[input.token.tokenId] =
-            (nftTokenBalances[input.token.tokenId] || BigInt(0)) - 1n;
+        if (input.token?.nft?.capability) {
+          nftTokenBalances[input.token.category] =
+            (nftTokenBalances[input.token.category] || BigInt(0)) - 1n;
         }
       }
     });
@@ -318,36 +286,36 @@ export const getHistory = async ({
         satoshiBalance += Number(output.value);
 
         if (output.token?.amount) {
-          ftTokenBalances[output.token.tokenId] =
-            (ftTokenBalances[output.token.tokenId] || BigInt(0)) +
+          ftTokenBalances[output.token.category] =
+            (ftTokenBalances[output.token.category] || BigInt(0)) +
             output.token.amount;
         }
 
-        if (output.token?.capability) {
-          nftTokenBalances[output.token.tokenId] =
-            (nftTokenBalances[output.token.tokenId] || BigInt(0)) + 1n;
+        if (output.token?.nft?.capability) {
+          nftTokenBalances[output.token.category] =
+            (nftTokenBalances[output.token.category] || BigInt(0)) + 1n;
         }
       }
     });
 
     tx.valueChange = satoshiBalance;
     tx.tokenAmountChanges = Object.entries(ftTokenBalances).map(
-      ([tokenId, amount]) => ({
-        tokenId,
+      ([category, amount]) => ({
+        category,
         amount,
         nftAmount: BigInt(0),
       })
     );
 
-    for (const [tokenId, nftAmount] of Object.entries(nftTokenBalances)) {
+    for (const [category, nftAmount] of Object.entries(nftTokenBalances)) {
       const tokenChange = tx.tokenAmountChanges.find(
-        (tokenChange) => tokenChange.tokenId === tokenId
+        (tokenChange) => tokenChange.category === category
       );
       if (tokenChange) {
         tokenChange.nftAmount = nftAmount;
       } else {
         tx.tokenAmountChanges.push({
-          tokenId,
+          category: category,
           amount: BigInt(0),
           nftAmount,
         });

package/src/history/interface.ts

@@ -17,7 +17,7 @@ export interface TransactionHistoryItem {
   balance: number;
   valueChange: number;
   tokenAmountChanges: {
-    tokenId: string;
+    category: string;
     amount: bigint;
     nftAmount: bigint;
   }[];

package/src/interface.ts

@@ -18,7 +18,7 @@ export type Network = typeof Network[keyof typeof Network];
 export interface Utxo {
   txid: string;
   vout: number;
-  satoshis: number;
+  satoshis: bigint;
   height?: number;
   coinbase?: boolean;
   token?: TokenI;
@@ -28,7 +28,6 @@ export interface Utxo {
 export interface UtxoId {
   txid: string;
   vout: number;
-  satoshis: number;
 }
 
 export interface ElectrumBalanceI {
@@ -59,9 +58,11 @@ export interface HeaderI {
 
 export interface TokenI {
   amount: bigint;
-  tokenId: string;
-  capability?: NFTCapability;
-  commitment?: string;
+  category: string;
+  nft?: {
+    capability: NFTCapability;
+    commitment: string;
+  };
 }
 
 export const NFTCapability = {

package/src/network/Connection.test.ts

@@ -14,7 +14,7 @@ test("Should connect to mainnet", async () => {
 
   let wallet = await Wallet.newRandom();
   expect(wallet.provider == globalThis.BCH).toBeTruthy();
-  expect(await wallet.getBalance("sat")).toBe(0);
+  expect(await wallet.getBalance()).toBe(0n);
 
   let height = await globalThis.BCH.getBlockHeight();
   expect(height).toBeGreaterThan(5000);
@@ -23,7 +23,7 @@ test("Should connect to mainnet", async () => {
 test("Should use global provider when creating testnet wallet", async () => {
   let wallet = await TestNetWallet.newRandom();
   expect(wallet.provider == globalThis.tBCH).toBeTruthy();
-  expect(await wallet.getBalance("sat")).toBe(0);
+  expect(await wallet.getBalance()).toBe(0n);
 
   let height = await globalThis.tBCH.getBlockHeight();
   expect(height).toBeGreaterThan(114);
@@ -34,7 +34,7 @@ test.skip("Should lower overhead in creating wallets", async () => {
   for (let i = 0; i < 100; i++) {
     let wallet = await RegTestWallet.newRandom();
     expect(wallet.provider == globalThis.rBCH).toBeTruthy();
-    expect(await wallet.getBalance("sat")).toBe(0);
+    expect(await wallet.getBalance()).toBe(0n);
   }
 
   let height = await globalThis.rBCH.getBlockHeight();

package/src/network/ElectrumNetworkProvider.ts

@@ -86,14 +86,12 @@ export default class ElectrumNetworkProvider implements NetworkProvider {
       address: cashaddr,
       txid: utxo.tx_hash,
       vout: utxo.tx_pos,
-      satoshis: utxo.value,
+      satoshis: BigInt(utxo.value),
       height: utxo.height,
       token: utxo.token_data
         ? {
+            ...utxo.token_data,
             amount: BigInt(utxo.token_data.amount),
-            tokenId: utxo.token_data.category,
-            capability: utxo.token_data.nft?.capability,
-            commitment: utxo.token_data.nft?.commitment,
           }
         : undefined,
     }));

package/src/network/Rpc.test.ts

@@ -73,7 +73,7 @@ describe("Rpc tests", () => {
 
     let result = false;
     aliceWallet.watchBalance((balance) => {
-      expect(balance.bch).toBeGreaterThan(0);
+      expect(balance).toBeGreaterThan(0);
       result = true;
       // stop watching
       return true;
@@ -105,8 +105,7 @@ describe("Rpc tests", () => {
     await aliceWallet.send([
       {
         cashaddr: bobWallet.cashaddr!,
-        value: 1000,
-        unit: "satoshis",
+        value: 1000n,
       },
     ]);
 

package/src/network/getRelayFeeCache.ts

@@ -15,9 +15,9 @@ export async function getRelayFeeCache(provider: NetworkProvider) {
       relayFeePerKbInCoins;
   }
   if (typeof relayFeePerKbInCoins === "number") {
-    return Math.round(relayFeePerKbInCoins * bchParam.subUnits) / 1000;
+    return Math.round(relayFeePerKbInCoins * Number(bchParam.subUnits)) / 1000;
   } else {
     console.warn("Couldn't get min relay fee, using default instead");
-    return Math.round(0.00001 * bchParam.subUnits) / 1000;
+    return Math.round(0.00001 * Number(bchParam.subUnits)) / 1000;
   }
 }

package/src/network/interface.ts

@@ -16,8 +16,8 @@ export interface ElectrumTokenData {
   amount: string;
   category: string;
   nft?: {
-    capability?: NFTCapability;
-    commitment?: string;
+    capability: NFTCapability;
+    commitment: string;
   };
 }
 

package/src/rate/ExchangeRate.test.ts

@@ -1,8 +1,5 @@
-import { removeFetchMock, setupFetchMock } from "../test/fetch";
-import { BalanceResponse } from "../util/balanceObjectFromSatoshi";
-import { RegTestWallet } from "../wallet/Wif";
-import { ExchangeRate, getRateFromExchange } from "./ExchangeRate";
-import { delay } from "../util/delay";
+import { setupFetchMock } from "../test/fetch";
+import { ExchangeRate } from "./ExchangeRate";
 import { initProviders, disconnectProviders } from "../network";
 import { Config } from "../config";
 
@@ -25,45 +22,6 @@ describe("Exchange rate tests", () => {
     expect(rate).toBe(1337.42);
   });
 
-  test("Test watchBalanceUsd", async () => {
-    setupFetchMock("https://markets.api.bitcoin.com/live/bitcoin", {
-      data: {
-        BCH: 1337.42,
-      },
-    });
-
-    const alice = await RegTestWallet.fromId(process.env.ALICE_ID!);
-    const bob = await RegTestWallet.newRandom();
-    const balance = (await alice.getBalance()) as BalanceResponse;
-    let cbCounter = 0;
-    const cancelWatchFn = await alice.watchBalanceUsd(async (newBalance) => {
-      cbCounter++;
-      if (cbCounter === 1) {
-        expect(newBalance.usd!).toBeGreaterThan(balance.usd!);
-      }
-    }, 3000);
-
-    setupFetchMock("https://markets.api.bitcoin.com/live/bitcoin", {
-      data: {
-        BCH: 31337.42,
-      },
-    });
-
-    await delay(3000);
-
-    await alice.send({
-      cashaddr: bob.getDepositAddress(),
-      value: 10000,
-      unit: "sat",
-    });
-
-    await delay(3000);
-
-    removeFetchMock("https://markets.api.bitcoin.com/live/bitcoin");
-    expect(cbCounter).toBe(2);
-    await cancelWatchFn();
-  });
-
   test("Test other currencies", async () => {
     const eurRate = await ExchangeRate.get("eur");
     expect(eurRate).toBeGreaterThan(0);

package/src/rate/ExchangeRate.ts

@@ -42,7 +42,7 @@ export class ExchangeRate {
   }
 
   static async getRateFromLocalStorage(
-    symbol,
+    symbol: string,
     useCache = true
   ): Promise<number> {
     if (!useCache) {
@@ -136,4 +136,7 @@ export async function getRateFromExchange(symbol: string): Promise<number> {
 }
 
 // do not await and do not throw in case we are offline
-ExchangeRate.get("usd").catch(() => {});
+// this promise can be used to warm up the cache
+export const ExchageRatePromise = ExchangeRate.get(Config.DefaultCurrency)
+  .then((result) => result)
+  .catch((error: Error) => error);