Implement ObservableQueryBitcoinBalance

packages/stores-bitcoin/src/index.ts

@@ -1 +1,2 @@
 export * from "./account";
+export * from "./queries";

packages/stores-bitcoin/src/queries/balance.ts

@@ -0,0 +1,142 @@
+import {
+  ChainGetter,
+  IObservableQueryBalanceImpl,
+  QuerySharedContext,
+} from "@keplr-wallet/stores";
+import { computed, makeObservable } from "mobx";
+import { AppCurrency } from "@keplr-wallet/types";
+import { DenomHelper } from "@keplr-wallet/common";
+import { CoinPretty, Int } from "@keplr-wallet/unit";
+import { ObservableBitcoinIndexerQuery } from "./bitcoin-indexer";
+import { AddressDetails } from "./types";
+
+export class ObservableQueryBitcoinBalanceImpl
+  extends ObservableBitcoinIndexerQuery<AddressDetails>
+  implements IObservableQueryBalanceImpl
+{
+  constructor(
+    sharedContext: QuerySharedContext,
+    chainId: string,
+    chainGetter: ChainGetter,
+    protected readonly denomHelper: DenomHelper,
+    protected readonly address: string
+  ) {
+    super(sharedContext, chainId, chainGetter, `address/${address}`);
+
+    makeObservable(this);
+  }
+
+  /**
+   * Confirmed balance is the sum of all the confirmed transactions in the chain.
+   */
+  @computed
+  get confirmedBalance(): CoinPretty {
+    if (!this.response || !this.response.data) {
+      return new CoinPretty(this.currency, new Int(0));
+    }
+
+    const data = this.response.data;
+
+    return new CoinPretty(
+      this.currency,
+      new Int(data.chain_stats.funded_txo_sum - data.chain_stats.spent_txo_sum)
+    );
+  }
+
+  /**
+   * Unconfirmed balance is the sum of all the unconfirmed transactions in the mempool.
+   */
+  @computed
+  get unconfirmedBalance(): CoinPretty {
+    if (!this.response || !this.response.data) {
+      return new CoinPretty(this.currency, new Int(0));
+    }
+
+    const data = this.response.data;
+    return new CoinPretty(
+      this.currency,
+      new Int(
+        data.mempool_stats.funded_txo_sum - data.mempool_stats.spent_txo_sum
+      )
+    );
+  }
+
+  /**
+   * balance is the sum of confirmed and unconfirmed balances.
+   */
+  @computed
+  get balance(): CoinPretty {
+    if (!this.response || !this.response.data) {
+      return new CoinPretty(this.currency, new Int(0));
+    }
+
+    const data = this.response.data;
+    return new CoinPretty(
+      this.currency,
+      new Int(
+        data.chain_stats.funded_txo_sum -
+          data.chain_stats.spent_txo_sum +
+          data.mempool_stats.funded_txo_sum -
+          data.mempool_stats.spent_txo_sum
+      )
+    );
+  }
+
+  @computed
+  get currency(): AppCurrency {
+    const denom = this.denomHelper.denom;
+
+    const modularChainInfo = this.chainGetter.getModularChain(this.chainId);
+    if (!("bitcoin" in modularChainInfo)) {
+      throw new Error(`${this.chainId} is not bitcoin chain`);
+    }
+
+    const modularChainInfoImpl = this.chainGetter.getModularChainInfoImpl(
+      this.chainId
+    );
+
+    const currencies = modularChainInfoImpl.getCurrencies("bitcoin");
+    const currency = currencies.find((cur) => cur.coinMinimalDenom === denom);
+
+    if (!currency) {
+      throw new Error(`Unknown currency: ${denom}`);
+    }
+
+    return currency;
+  }
+}
+
+export class ObservableQueryBitcoinBalance {
+  protected map: Map<string, ObservableQueryBitcoinBalanceImpl> = new Map();
+
+  constructor(protected readonly sharedContext: QuerySharedContext) {}
+
+  getBalance(
+    chainId: string,
+    chainGetter: ChainGetter,
+    address: string,
+    minimalDenom: string
+  ): IObservableQueryBalanceImpl | undefined {
+    const key = `${chainId}/${address}/${minimalDenom}`;
+    const prior = this.map.get(key);
+    if (prior) {
+      return prior;
+    }
+
+    const denomHelper = new DenomHelper(minimalDenom);
+    const modularChainInfo = chainGetter.getModularChain(chainId);
+    if (!("bitcoin" in modularChainInfo)) {
+      return;
+    }
+
+    const impl = new ObservableQueryBitcoinBalanceImpl(
+      this.sharedContext,
+      chainId,
+      chainGetter,
+      denomHelper,
+      address
+    );
+    this.map.set(key, impl);
+    return impl;
+  }
+}

packages/stores-bitcoin/src/queries/index.ts

@@ -1,5 +1,6 @@
 import { ChainGetter, QuerySharedContext } from "@keplr-wallet/stores";
 import { DeepReadonly } from "utility-types";
+import { ObservableQueryBitcoinBalance } from "./balance";
 export class BitcoinQueriesStore {
   protected map: Map<string, BitcoinQueriesStoreImpl> = new Map();
 
@@ -28,10 +29,14 @@ export class BitcoinQueriesStore {
 }
 
 class BitcoinQueriesStoreImpl {
+  public readonly queryBitcoinBalance: DeepReadonly<ObservableQueryBitcoinBalance>;
+
   constructor(
     protected readonly sharedContext: QuerySharedContext,
     protected readonly chainId: string,
     protected readonly chainGetter: ChainGetter,
     protected readonly tokenContractListURL: string
-  ) {}
+  ) {
+    this.queryBitcoinBalance = new ObservableQueryBitcoinBalance(sharedContext);
+  }
 }

packages/stores-bitcoin/src/queries/types.ts

@@ -0,0 +1,13 @@
+export interface TxoStats {
+  funded_txo_count: number;
+  funded_txo_sum: number;
+  spent_txo_count: number;
+  spent_txo_sum: number;
+  tx_count: number;
+}
+
+export interface AddressDetails {
+  address: string;
+  chain_stats: TxoStats;
+  mempool_stats: TxoStats;
+}