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

package/src/transaction/allocateFee.ts

@@ -6,7 +6,7 @@ import {
 import { FeePaidByEnum } from "../wallet/enum.js";
 import { DUST_UTXO_THRESHOLD } from "../constant.js";
 
-export function checkFeeForDust(value: number) {
+export function checkFeeForDust(value: bigint) {
   if (value < DUST_UTXO_THRESHOLD) {
     throw Error("Fee strategy would result in dust output");
   }
@@ -14,11 +14,11 @@ export function checkFeeForDust(value: number) {
 
 export function checkSatsAvailable(
   sendRequestArray: Array<SendRequest>,
-  fee: number
+  fee: bigint
 ) {
   let amountAvailable = sendRequestArray.reduce(function (sum, r) {
     return sum + (r.value - DUST_UTXO_THRESHOLD);
-  }, 0);
+  }, 0n);
   if (amountAvailable < fee) {
     throw Error("Insufficient funds for transaction given fee");
   }
@@ -39,22 +39,21 @@ export function checkForNonStandardSendRequest(
 }
 
 export function sortSendRequests(sendRequestArray: Array<SendRequest>) {
-  return sendRequestArray.sort(
-    (a: SendRequest, b: SendRequest) => a.value - b.value
+  return sendRequestArray.sort((a: SendRequest, b: SendRequest) =>
+    Number(a.value - b.value)
   );
 }
 
-function distributeFees(requests: Array<SendRequest>, fee: number) {
+function distributeFees(requests: Array<SendRequest>, fee: bigint) {
   checkSatsAvailable(requests, fee);
-  fee = Number(fee);
   for (let r = 0; r < requests.length; r++) {
     if (fee > 0) {
       checkForNonStandardSendRequest(requests[r]);
-      let perRequestFee = Math.floor(fee / (requests.length - r));
-      perRequestFee += fee % (requests.length - r);
+      let perRequestFee = fee / BigInt(requests.length - r);
+      perRequestFee += fee % BigInt(requests.length - r);
       if (requests[r].value - perRequestFee < DUST_UTXO_THRESHOLD) {
         fee -= requests[r].value;
-        requests[r].value = 0;
+        requests[r].value = 0n;
       } else {
         fee -= perRequestFee;
         requests[r].value -= perRequestFee;
@@ -66,7 +65,7 @@ function distributeFees(requests: Array<SendRequest>, fee: number) {
 
 function firstPays(
   requests: Array<SendRequest | TokenSendRequest | OpReturnData>,
-  fee: number
+  fee: bigint
 ) {
   let payer = requests.shift()!;
   payer = checkForNonStandardSendRequest(payer);
@@ -77,7 +76,7 @@ function firstPays(
 }
 function lastPays(
   requests: Array<SendRequest | TokenSendRequest | OpReturnData>,
-  fee: number
+  fee: bigint
 ) {
   let payer = requests.pop()!;
   payer = checkForNonStandardSendRequest(payer);
@@ -88,7 +87,7 @@ function lastPays(
 }
 function anyPays(
   requests: Array<SendRequest | TokenSendRequest | OpReturnData>,
-  fee: number
+  fee: bigint
 ) {
   for (let r of requests) {
     checkForNonStandardSendRequest(r);
@@ -100,7 +99,7 @@ function anyPays(
 
 function changeThenFallback(
   requests: Array<SendRequest | TokenSendRequest | OpReturnData>,
-  fee: number,
+  fee: bigint,
   change: bigint,
   fallbackFn: Function
 ) {
@@ -113,7 +112,7 @@ function changeThenFallback(
 
 export function allocateFee(
   requests: Array<SendRequest | TokenSendRequest | OpReturnData>,
-  fee: number,
+  fee: bigint,
   feePaidBy: FeePaidByEnum,
   change: bigint
 ): Array<SendRequest> {

package/src/util/amountInSatoshi.test.ts

@@ -13,15 +13,7 @@ test("Get price of Bch, BCH, bch in sat", async () => {
 
 test("Get price of sat(s)", async () => {
   let rate = await amountInSatoshi(1, "sat");
-  expect(rate).toBe(1);
-  rate = await amountInSatoshi(1, "sats");
-  expect(rate).toBe(1);
-  rate = await amountInSatoshi(1, "Satoshi");
-  expect(rate).toBe(1);
-  rate = await amountInSatoshi(1, "SATOSHIS");
-  expect(rate).toBe(1);
-  rate = await amountInSatoshi(1, "satoshis");
-  expect(rate).toBe(1);
+  expect(rate).toBe(1n);
 });
 
 test("Get price of USD, Usd, usd", async () => {

package/src/util/amountInSatoshi.ts

@@ -15,23 +15,19 @@ import { sanitizeUnit } from "../util/sanitizeUnit.js";
 export async function amountInSatoshi(
   value: number,
   rawUnit: any
-): Promise<number> {
+): Promise<bigint> {
   const unit = sanitizeUnit(rawUnit);
   switch (unit) {
     case UnitEnum.BCH:
-      return Math.round(value * bchParam.subUnits);
-    case UnitEnum.SATOSHI:
-      return value;
+      return BigInt(Math.round(value * Number(bchParam.subUnits)));
     case UnitEnum.SAT:
-      return value;
-    case UnitEnum.SATS:
-      return value;
-    case UnitEnum.SATOSHIS:
-      return value;
+      return BigInt(value);
     default:
       const Currency_over_BCH = await ExchangeRate.get(rawUnit);
       const SAT_over_BCH = bchParam.subUnits;
 
-      return Math.round(Number(value * (SAT_over_BCH / Currency_over_BCH)));
+      return BigInt(
+        Math.round(Number(value * (Number(SAT_over_BCH) / Currency_over_BCH)))
+      );
   }
 }

package/src/util/asSendRequestObject.ts

@@ -1,5 +1,4 @@
 import { base64ToBin } from "@bitauth/libauth";
-import { UnitEnum } from "../enum.js";
 import {
   OpReturnData,
   SendRequest,
@@ -31,12 +30,14 @@ export function asSendRequestObject(
               )
             );
           } else {
-            // ['cashaddr', 120, 'sats'],
+            // ['cashaddr', 120] or ['cashaddr', 120n],
             resp.push(
               new SendRequest({
                 cashaddr: r[0] as string,
-                value: r[1] as number,
-                unit: r[2] as UnitEnum,
+                value:
+                  typeof r[1] === "number"
+                    ? BigInt(Math.floor[1])
+                    : (r[1] as bigint),
               })
             );
           }
@@ -56,9 +57,7 @@ export function asSendRequestObject(
 }
 
 function convertToClass(object: SendRequest | TokenSendRequest | OpReturnData) {
-  if (object.hasOwnProperty("unit")) {
-    return new SendRequest(object as SendRequest);
-  } else if (object.hasOwnProperty("tokenId")) {
+  if (object.hasOwnProperty("category")) {
     return new TokenSendRequest(object as TokenSendRequest);
   } else if (object.hasOwnProperty("buffer")) {
     return OpReturnData.fromUint8Array((object as OpReturnData).buffer);
@@ -70,6 +69,12 @@ function convertToClass(object: SendRequest | TokenSendRequest | OpReturnData) {
     return OpReturnData.fromUint8Array(
       Uint8Array.from(base64ToBin((object as any).dataBuffer))
     );
+  } else if (
+    object.hasOwnProperty("cashaddr") &&
+    object.hasOwnProperty("value") &&
+    object.hasOwnProperty("category") === false
+  ) {
+    return new SendRequest(object as SendRequest);
   }
 
   throw new Error("Unsupported send object");

package/src/util/convert.ts

@@ -1,3 +1,4 @@
+import { bchParam } from "../chain.js";
 import { amountInSatoshi } from "./amountInSatoshi.js";
 import { satoshiToAmount } from "./satoshiToAmount.js";
 
@@ -30,3 +31,20 @@ export async function convertObject({
 }) {
   return await convert(value, from, to);
 }
+
+// sats -> bch
+export function toBch(sats: bigint): number {
+  return Number(sats) / Number(bchParam.subUnits);
+}
+
+// bch -> sats
+export function toSat(bch: string | number): bigint {
+  return BigInt(Math.round(Number(bch) * Number(bchParam.subUnits)));
+}
+
+export async function toCurrency(
+  sats: bigint,
+  currency: string
+): Promise<number> {
+  return convert(Number(sats), "sat", currency);
+}

package/src/util/index.ts

@@ -8,7 +8,7 @@ export {
   binToBase64,
   sha256,
 } from "@bitauth/libauth";
-export { convert, convertObject } from "./convert.js";
+export * from "./convert.js";
 export { delay } from "./delay.js";
 export { derivedNetwork } from "./deriveNetwork.js";
 export { derivePublicKeyHash } from "./derivePublicKeyHash.js";
@@ -22,17 +22,12 @@ export {
 export { getRuntimePlatform, RuntimePlatform } from "./getRuntimePlatform.js";
 export { getUsdRate } from "./getUsdRate.js";
 export { hash160 } from "./hash160.js";
-export { ExchangeRate } from "../rate/ExchangeRate.js";
+export { ExchangeRate, ExchageRatePromise } from "../rate/ExchangeRate.js";
 export { sanitizeAddress } from "./sanitizeAddress.js";
 export { sanitizeUnit } from "./sanitizeUnit.js";
 export { getWeakRandomInt } from "./randomInt.js";
 export { getXPubKey } from "../util/getXPubKey.js";
 export { sumUtxoValue } from "./sumUtxoValue.js";
-export {
-  BalanceResponse,
-  balanceFromSatoshi,
-  balanceResponseFromSatoshi,
-} from "./balanceObjectFromSatoshi.js";
 export * from "./sumUtxoValue.js";
 export { decodeHeader } from "./header.js";
 export * from "./checkUtxos.js";

package/src/util/satoshiToAmount.test.ts

@@ -1,6 +1,6 @@
 import { satoshiToAmount } from "./satoshiToAmount";
 
 test("get a zero satoshis", async () => {
-  let zero = await satoshiToAmount(0, "sat");
+  let zero = await satoshiToAmount(0n, "sat");
   expect(zero).toBe(0);
 });

package/src/util/satoshiToAmount.ts

@@ -12,27 +12,21 @@ import { sanitizeUnit } from "../util/sanitizeUnit.js";
  * @returns a promise to the value in the unit of account given by rawUnit
  */
 export async function satoshiToAmount(
-  value: number,
+  value: bigint,
   rawUnit: any
 ): Promise<number> {
   const unit = sanitizeUnit(rawUnit);
   switch (unit) {
     case UnitEnum.BCH:
-      return value / bchParam.subUnits;
-    case UnitEnum.SATOSHI:
-      return value;
+      return Number(value) / Number(bchParam.subUnits);
     case UnitEnum.SAT:
-      return value;
-    case UnitEnum.SATS:
-      return value;
-    case UnitEnum.SATOSHIS:
-      return value;
+      return Number(value);
     default:
       const Currency_over_BCH = await ExchangeRate.get(rawUnit);
       // truncate currency amounts to fixed precision (2),
       // then return the fixed value string as a float.
       const currencyValue = Number(
-        value * (Currency_over_BCH / bchParam.subUnits)
+        Number(value) * (Currency_over_BCH / Number(bchParam.subUnits))
       ).toFixed(2);
       return Number.parseFloat(currencyValue);
   }

package/src/util/sumSendRequestAmounts.ts

@@ -3,7 +3,6 @@ import {
   SendRequest,
   TokenSendRequest,
 } from "../wallet/model.js";
-import { amountInSatoshi } from "./amountInSatoshi.js";
 
 // This function sums a list of send request objects
 export async function sumSendRequestAmounts(
@@ -13,10 +12,10 @@ export async function sumSendRequestAmounts(
     const balanceArray: (BigInt | Error)[] = await Promise.all(
       requests.map(async (r: SendRequest | TokenSendRequest | OpReturnData) => {
         if (r instanceof SendRequest) {
-          return BigInt(await amountInSatoshi(r.value, r.unit));
+          return r.value;
         } else if (r instanceof TokenSendRequest) {
-          return BigInt(r.value || 1000);
-        } else return BigInt(0);
+          return r.value || 1000n;
+        } else return 0n;
       })
     );
     const balance = balanceArray.reduce(sumBalance, BigInt(0));

package/src/util/sumUtxoValue.ts

@@ -2,20 +2,20 @@ import { Utxo } from "../interface.js";
 
 export function sumUtxoValue(utxos: Utxo[]) {
   if (utxos.length > 0) {
-    const balanceArray: number[] = utxos.map((o: Utxo) => {
+    const balanceArray: bigint[] = utxos.map((o: Utxo) => {
       return o.satoshis;
     });
-    const balance = balanceArray.reduce((a: number, b: number) => a + b, 0);
+    const balance = balanceArray.reduce((a: bigint, b: bigint) => a + b, 0n);
     return balance;
   } else {
-    return 0;
+    return 0n;
   }
 }
 
 export function sumTokenAmounts(utxos: Utxo[], tokenId: string): bigint {
   if (utxos.length > 0) {
     const tokenArray: bigint[] = utxos
-      .filter((utxo) => utxo.token?.tokenId === tokenId)
+      .filter((utxo) => utxo.token?.category === tokenId)
       .map((o: Utxo) => {
         return o.token?.amount || 0n;
       });