mainnet-js 2.2.9 → 2.3.0

package/src/wallet/Wif.test.ts

@@ -16,6 +16,7 @@ import {
   utf8ToBin,
 } from "@bitauth/libauth";
 import { mine } from "../mine";
+import json from "../../polyfill/json";
 import ElectrumNetworkProvider from "../network/ElectrumNetworkProvider";
 
 beforeAll(async () => {
@@ -1069,9 +1070,9 @@ describe(`Wallet extrema behavior regression testing`, () => {
       expect(encodedTransaction.length).toBeGreaterThan(0);
 
       // check transaction was not submitted
-      expect(JSON.stringify(aliceUtxos)).toBe(
-        JSON.stringify(await aliceWallet.getAddressUtxos())
-      );
+      // BigInts can't be serialized as strings
+      //
+      expect(json(aliceUtxos)).toBe(json(await aliceWallet.getAddressUtxos()));
 
       const decoded = decodeTransaction(encodedTransaction);
       if (typeof decoded === "string") {
@@ -1112,9 +1113,7 @@ describe(`Wallet extrema behavior regression testing`, () => {
       expect(encodedTransaction.length).toBeGreaterThan(0);
 
       // check transaction was not submitted
-      expect(JSON.stringify(aliceUtxos)).toBe(
-        JSON.stringify(await aliceWallet.getAddressUtxos())
-      );
+      expect(json(aliceUtxos)).toBe(json(await aliceWallet.getAddressUtxos()));
 
       const decoded = decodeTransaction(encodedTransaction);
       if (typeof decoded === "string") {
@@ -1136,9 +1135,7 @@ describe(`Wallet extrema behavior regression testing`, () => {
       expect(encodedTransaction.length).toBeGreaterThan(0);
 
       // check transaction was not submitted
-      expect(JSON.stringify(aliceUtxos)).toBe(
-        JSON.stringify(await aliceWallet.getAddressUtxos())
-      );
+      expect(json(aliceUtxos)).toBe(json(await aliceWallet.getAddressUtxos()));
 
       const decoded = decodeTransaction(encodedTransaction);
       if (typeof decoded === "string") {

package/src/wallet/Wif.ts

@@ -774,9 +774,9 @@ export class Wallet extends BaseWallet {
   // can be cancelled by calling the function returned from this one
   public watchTokenBalance(
     tokenId: string,
-    callback: (balance: number) => void
+    callback: (balance: bigint) => void
   ): CancelWatchFn {
-    let previous: number | undefined = undefined;
+    let previous: bigint | undefined = undefined;
     return (this.provider! as ElectrumNetworkProvider).watchAddressStatus(
       this.getDepositAddress(),
       async (_status: string) => {
@@ -793,12 +793,12 @@ export class Wallet extends BaseWallet {
   // this call halts the execution
   public async waitForTokenBalance(
     tokenId: string,
-    amount: number
-  ): Promise<number> {
+    amount: bigint
+  ): Promise<bigint> {
     return new Promise(async (resolve) => {
       const watchCancel = this.watchTokenBalance(
         tokenId,
-        async (balance: number) => {
+        async (balance: bigint) => {
           if (balance >= amount) {
             await watchCancel();
             resolve(balance);
@@ -1107,7 +1107,7 @@ export class Wallet extends BaseWallet {
       inputs: UtxoI[],
       outputs: SendRequestType[]
     ) => {
-      // Do NOT allow for implicit token burn if the total amount sent is less than user had
+      // Allow for implicit token burn if the total amount sent is less than user had
       // allow for token genesis, creating more tokens than we had before (0)
       if (!checkTokenQuantities) {
         return;
@@ -1125,14 +1125,14 @@ export class Wallet extends BaseWallet {
         );
         const inputAmountSum = tokenInputs.reduce(
           (prev, cur) => prev + cur.token!.amount,
-          0
+          0n
         );
         const tokenOutputs = allTokenOutputs.filter(
           (val) => val.tokenId === tokenId
         );
         const outputAmountSum = tokenOutputs.reduce(
           (prev, cur) => prev + cur.amount,
-          0
+          0n
         );
 
         const diff = inputAmountSum - outputAmountSum;
@@ -1140,8 +1140,8 @@ export class Wallet extends BaseWallet {
           throw new Error("Not enough token amount to send");
         }
         if (diff >= 0) {
-          let available = 0;
-          let change = 0;
+          let available = 0n;
+          let change = 0n;
           const ensureUtxos: UtxoI[] = [];
           for (const token of tokenInputs.filter((val) => val.token?.amount)) {
             ensureUtxos.push(token);
@@ -1552,9 +1552,9 @@ export class Wallet extends BaseWallet {
     }
     const newAmount =
       deductTokenAmount && nftUtxos[0].token!.amount > 0
-        ? nftUtxos[0].token!.amount - mintRequests.length
+        ? nftUtxos[0].token!.amount - BigInt(mintRequests.length)
         : nftUtxos[0].token!.amount;
-    const safeNewAmount = Math.max(0, newAmount);
+    const safeNewAmount = newAmount < 0n ? 0n : newAmount;
     const mintingInput = new TokenSendRequest({
       cashaddr: this.tokenaddr!,
       tokenId: tokenId,
@@ -1626,23 +1626,24 @@ export class Wallet extends BaseWallet {
     }
 
     const totalFungibleAmount = tokenUtxos.reduce(
-      (prev, cur) => prev + (cur.token?.amount || 0),
-      0
+      (prev, cur) => prev + (cur.token?.amount || 0n),
+      0n
     );
-    const fungibleBurnAmount =
-      burnRequest.amount && burnRequest.amount > 0 ? burnRequest.amount! : 0;
+    let fungibleBurnAmount =
+      burnRequest.amount && burnRequest.amount > 0 ? burnRequest.amount! : 0n;
+    fungibleBurnAmount = BigInt(fungibleBurnAmount);
     const hasNFT = burnRequest.capability || burnRequest.commitment;
 
     let utxoIds: UtxoI[] = [];
     let changeSendRequests: TokenSendRequest[];
     if (hasNFT) {
       // does not have FT tokens, let us destroy the token completely
-      if (totalFungibleAmount === 0) {
+      if (totalFungibleAmount === 0n) {
         changeSendRequests = [];
         utxoIds.push(tokenUtxos[0]);
       } else {
         // add utxos to spend from
-        let available = 0;
+        let available = 0n;
         for (const token of tokenUtxos.filter((val) => val.token?.amount)) {
           utxoIds.push(token);
           available += token.token?.amount!;
@@ -1653,7 +1654,7 @@ export class Wallet extends BaseWallet {
 
         // if there are FT, reduce their amount
         const newAmount = totalFungibleAmount - fungibleBurnAmount;
-        const safeNewAmount = Math.max(0, newAmount);
+        const safeNewAmount = newAmount < 0n ? 0n : newAmount;
         changeSendRequests = [
           new TokenSendRequest({
             cashaddr: burnRequest.cashaddr || this.tokenaddr!,
@@ -1666,13 +1667,13 @@ export class Wallet extends BaseWallet {
         ];
       }
     } else {
-      // if we are burning last fughible tokens, let us destroy the token completely
+      // if we are burning last fungible tokens, let us destroy the token completely
       if (totalFungibleAmount === fungibleBurnAmount) {
         changeSendRequests = [];
         utxoIds.push(tokenUtxos[0]);
       } else {
         // add utxos to spend from
-        let available = 0;
+        let available = 0n;
         for (const token of tokenUtxos.filter((val) => val.token?.amount)) {
           utxoIds.push(token);
           available += token.token?.amount!;
@@ -1683,7 +1684,7 @@ export class Wallet extends BaseWallet {
 
         // reduce the FT amount
         const newAmount = totalFungibleAmount - fungibleBurnAmount;
-        const safeNewAmount = Math.max(0, newAmount);
+        const safeNewAmount = newAmount < 0n ? 0n : newAmount;
         changeSendRequests = [
           new TokenSendRequest({
             cashaddr: burnRequest.cashaddr || this.tokenaddr!,
@@ -1722,9 +1723,9 @@ export class Wallet extends BaseWallet {
    * getTokenBalance Gets fungible token balance
    * for NFT token balance see @ref getNftTokenBalance
    * @param  {string} tokenId tokenId to get balance for
-   * @returns  {number} fungible token balance
+   * @returns  {bigint} fungible token balance
    */
-  public async getTokenBalance(tokenId: string): Promise<number> {
+  public async getTokenBalance(tokenId: string): Promise<bigint> {
     const utxos = (await this.getTokenUtxos(tokenId)).filter(
       (val) => val.token?.amount
     );
@@ -1732,7 +1733,7 @@ export class Wallet extends BaseWallet {
   }
 
   /**
-   * getNftTokenBalance Gets non-fungible token (NFT) balance for a particula tokenId
+   * getNftTokenBalance Gets non-fungible token (NFT) balance for a particular tokenId
    * disregards fungible token balances
    * for fungible token balance see @ref getTokenBalance
    * @param  {string} tokenId tokenId to get balance for
@@ -1749,14 +1750,14 @@ export class Wallet extends BaseWallet {
    * getAllTokenBalances Gets all fungible token balances in this wallet
    * @returns  {Object} a map [tokenId => balance] for all tokens in this wallet
    */
-  public async getAllTokenBalances(): Promise<{ [tokenId: string]: number }> {
+  public async getAllTokenBalances(): Promise<{ [tokenId: string]: bigint }> {
     const result = {};
     const utxos = (await this.getTokenUtxos()).filter(
       (val) => val.token?.amount
     );
     for (const utxo of utxos) {
       if (!result[utxo.token!.tokenId]) {
-        result[utxo.token!.tokenId] = 0;
+        result[utxo.token!.tokenId] = 0n;
       }
       result[utxo.token!.tokenId] += utxo.token!.amount;
     }

package/src/wallet/model.ts

@@ -47,7 +47,7 @@ export class SendRequest {
 }
 
 export class TokenGenesisRequest {
-  amount?: number; // fungible token amount
+  amount?: bigint; // fungible token amount
   capability?: NFTCapability;
   commitment?: string;
   cashaddr?: string;
@@ -60,7 +60,7 @@ export class TokenGenesisRequest {
     cashaddr,
     value,
   }: {
-    amount?: number;
+    amount?: bigint;
     capability?: NFTCapability;
     commitment?: string;
     cashaddr?: string;
@@ -78,7 +78,7 @@ export class TokenBurnRequest {
   tokenId: string;
   capability?: NFTCapability;
   commitment?: string;
-  amount?: number; // fungible token amount
+  amount?: bigint; // fungible token amount
   cashaddr?: string;
 
   constructor({
@@ -91,13 +91,13 @@ export class TokenBurnRequest {
     tokenId: string;
     capability?: NFTCapability;
     commitment?: string;
-    amount?: number;
+    amount?: number | bigint;
     cashaddr?: string;
   }) {
     this.tokenId = tokenId;
     this.capability = capability;
     this.commitment = commitment;
-    this.amount = amount;
+    this.amount = amount ? BigInt(amount) : 0n;
     this.cashaddr = cashaddr;
   }
 }
@@ -105,7 +105,7 @@ export class TokenBurnRequest {
 export class TokenSendRequest {
   cashaddr: string; // cashaddr or tokenaddr to send tokens to
   value?: number; // satoshi value
-  amount: number; // fungible token amount
+  amount: bigint; // fungible token amount
   tokenId: string;
   capability?: NFTCapability;
   commitment?: string;
@@ -120,7 +120,7 @@ export class TokenSendRequest {
   }: {
     cashaddr: string;
     value?: number;
-    amount?: number;
+    amount?: number | bigint;
     tokenId: string;
     capability?: NFTCapability;
     commitment?: string;
@@ -129,7 +129,7 @@ export class TokenSendRequest {
 
     this.cashaddr = cashaddr;
     this.value = value;
-    this.amount = amount || 0;
+    this.amount = amount ? BigInt(amount) : 0n;
     this.tokenId = tokenId;
     this.capability = capability;
     this.commitment = commitment;
@@ -371,7 +371,7 @@ export const fromUtxoId = (utxoId: string): UtxoI => {
     token: tokenId
       ? {
           tokenId,
-          amount: parseInt(amount),
+          amount: BigInt(amount),
           capability: capability || undefined,
           commitment: commitment || undefined,
         }