Merge pull request #252 from bitcoin-computer/feat/unconfirmedBalance2

Block reorgs and confirmed/unconfirmed balance

Author: ClemensLey

packages/chat/src/StartChat.js

@@ -12,7 +12,7 @@ function StartChat({ computer }) {
       console.log('creating chat')
       let chat
       try {
-        if (await computer.getBalance() < 100) {
+        if ((await computer.getBalance()).balance < 100) {
           await computer.faucet(1e7)
         }
         chat = await computer.new(ChatSc, [publicKey])

packages/chat/src/Wallet.js

@@ -7,7 +7,7 @@ function Wallet({ computer, chain }) {
 
   useInterval(() => {
     const getBalance = async () => {
-      if (computer) setBalance(await computer.getBalance())
+      if (computer) setBalance((await computer.getBalance()).balance)
     }
     getBalance()
   }, 3000)

packages/components/built/Wallet.js

@@ -86,7 +86,7 @@ var Balance = function (_a) {
                     return [4 /*yield*/, computer.getBalance()];
                 case 5:
                     availableWalletBalance = _b.sent();
-                    setBalance(availableWalletBalance + amountsInPaymentToken);
+                    setBalance(availableWalletBalance.balance + amountsInPaymentToken);
                     setChain(computer.getChain());
                     _b.label = 6;
                 case 6:
@@ -111,7 +111,7 @@ var Balance = function (_a) {
                     _a = setBalance;
                     return [4 /*yield*/, computer.getBalance()];
                 case 2:
-                    _a.apply(void 0, [_b.sent()]);
+                    _a.apply(void 0, [(_b.sent()).balance]);
                     return [2 /*return*/];
             }
         });

packages/components/src/Wallet.tsx

@@ -30,7 +30,7 @@ const Balance = ({
           : 0
 
         const availableWalletBalance = await computer.getBalance()
-        setBalance(availableWalletBalance + amountsInPaymentToken)
+        setBalance(availableWalletBalance.balance + amountsInPaymentToken)
         setChain(computer.getChain())
       }
       showLoader(false)
@@ -42,7 +42,7 @@ const Balance = ({
 
   const fund = async () => {
     await computer.faucet(1e8)
-    setBalance(await computer.getBalance())
+    setBalance((await computer.getBalance()).balance)
   }
 
   useEffect(() => {

packages/docs/Lib/getBalance.md

@@ -1,10 +1,10 @@
 # getBalance
 
-Returns the current balance in satoshi.
+Returns an object with the current balance in Satoshi, the confirmed balance in Satoshi (at least 1 confirmation), and the unconfirmed balance in Satoshi.
 
 ### Type
 ```ts
-() => Promise<string>
+() => Promise<{balance: number, confirmed: number, unconfirmed: number}>
 ```
 
 ### Syntax

packages/docs/Lib/lib.md

@@ -57,7 +57,7 @@ The wallet functionality within a `Computer` instance can be accessed using the
 | [send](./send.md)                   | Sends satoshis to an address                       |
 | [rpcCall](./rpcCall.md)             | Access Bitcoin's RPC interface                     |
 | [getAddress](./getAddress.md)       | Returns the Bitcoin address of the computer wallet |
-| [getBalance](./getBalance.md)       | Returns the balance in satoshi                     |
+| [getBalance](./getBalance.md)       | Confirmed, unconfirmed and total balance in sats   |
 | [getChain](./getChain.md)           | Returns the blockchain                             |
 | [getNetwork](./getNetwork.md)       | Returns the network                                |
 | [getMnemonic](./getMnemonic.md)     | Returns a BIP39 mnemonic sentence                  |

packages/docs/node.md

@@ -133,7 +133,7 @@ const { txId, vout } = await computer.faucet(1e4)
 expect(await new Computer(conf).getUtxos(address)).deep.eq([`${txId}:${vout}`])
 
 // Return the balance
-expect(await new Computer(conf).getBalance(address)).eq(1e4)
+expect(await new Computer(conf).getBalance(address).balance).eq(1e4)
 
 // Return the transactions
 expect(await new Computer(conf).listTxs(address)).deep.eq({

packages/ft/src/MintToken.tsx

@@ -36,7 +36,7 @@ const MintToken: React.FC<IMintTokenProps> = ({ computer }) => {
 
   const clicked = () => {
     setVisible(true)
-    if (computer.getBalance() === 0) {
+    if (computer.getBalance().balance === 0) {
       alert('Wallet has zero balance, please fund the wallet first.')
     }
   }

packages/ft/src/Wallet.tsx

@@ -16,7 +16,7 @@ const Wallet: React.FC<IWalletProps> = ({ computer, chain }) => {
 
   const refresh = async () => {
     try {
-      if (computer) setBalance(await computer.getBalance())
+      if (computer) setBalance((await computer.getBalance()).balance)
     } catch (err) {
       console.log(err)
       console.log("error occurred while fetching wallet details: ", err)

packages/lib/computer.d.ts

@@ -46,7 +46,7 @@ declare class Wallet {
   readonly restClient: RestClient;
   constructor(params?: ComputerOptions);
   derive(subpath?: string): Wallet;
-  getBalance(address?: string): Promise<number>;
+  getBalance(address?: string): Promise<{balance: number, confirmed: number, unconfirmed: number}>;
   getUtxos(address?: string): Promise<_Unspent[]>;
   getDustThreshold(isWitnessProgram: boolean, script?: Buffer): number;
   getAmountThreshold(isWitnessProgram: boolean, script: Buffer): number;
@@ -109,7 +109,7 @@ declare class RestClient {
   constructor({ chain, network, mnemonic, path, passphrase, addressType, url, satPerByte, dustRelayFee }?: ComputerOptions);
   rpc(method: string, params: string): Promise<any>;
   broadcast(txHex: string): Promise<string>;
-  getBalance(address: string): Promise<number>;
+  getBalance(address: string): Promise<{balance: number, confirmed: number, unconfirmed: number}>;
   listTxs(address: string): Promise<_Transaction>;
   getUtxos(address: string): Promise<_Unspent[]>;
   getFormattedUtxos(address: string): Promise<_Unspent[]>;
@@ -332,7 +332,7 @@ declare class Computer {
   load(rev: string): Promise<ModuleExportsNamespace>;
   listTxs(address?: string): Promise<import("./types")._Transaction>;
   getUtxos(address?: string): Promise<string[]>;
-  getBalance(address?: string): Promise<number>;
+  getBalance(address?: string): Promise<{balance: number, confirmed: number, unconfirmed: number}>;
   sign(transaction: Transaction, opts?: SigOptions): Promise<void>;
   fund(tx: Transaction, opts?: Fee & FundOptions): Promise<void>;
   send(satoshis: number, address: string): Promise<string>;