feat(service): support BtcAssetsApi.getRgbppApiBalanceByAddress()

.changeset/silly-rules-collect.md

@@ -0,0 +1,5 @@
+---
+"@rgbpp-sdk/service": minor
+---
+
+Add BtcAssetsApi.getRgbppApiBalanceByAddress() API for querying RGBPP XUDT balances by a BTC address

packages/service/src/service/service.ts

@@ -24,6 +24,8 @@ import {
   RgbppApiSendCkbTransactionPayload,
   RgbppApiCkbTransactionHash,
   RgbppApiAssetsByAddressParams,
+  RgbppApiBalanceByAddressParams,
+  RgbppApiBalance,
   RgbppApiRetryCkbTransactionPayload,
   RgbppApiTransactionStateParams,
   RgbppApiTransactionRetry,
@@ -128,6 +130,12 @@ export class BtcAssetsApi extends BtcAssetsApiBase implements BtcApis, RgbppApis
     });
   }
 
+  getRgbppBalanceByBtcAddress(btcAddress: string, params?: RgbppApiBalanceByAddressParams) {
+    return this.request<RgbppApiBalance>(`/rgbpp/v1/address/${btcAddress}/balance`, {
+      params,
+    });
+  }
+
   getRgbppSpvProof(btcTxId: string, confirmations: number) {
     return this.request<RgbppApiSpvProof>('/rgbpp/v1/btc-spv/proof', {
       params: {

packages/service/src/types/rgbpp.ts

@@ -7,6 +7,7 @@ export interface RgbppApis {
   getRgbppAssetsByBtcTxId(btcTxId: string): Promise<Cell[]>;
   getRgbppAssetsByBtcUtxo(btcTxId: string, vout: number): Promise<Cell[]>;
   getRgbppAssetsByBtcAddress(btcAddress: string, params?: RgbppApiAssetsByAddressParams): Promise<Cell[]>;
+  getRgbppBalanceByBtcAddress(btcAddress: string, params?: RgbppApiBalanceByAddressParams): Promise<RgbppApiBalance>;
   getRgbppSpvProof(btcTxId: string, confirmations: number): Promise<RgbppApiSpvProof>;
   sendRgbppCkbTransaction(payload: RgbppApiSendCkbTransactionPayload): Promise<RgbppApiTransactionState>;
   retryRgbppCkbTransaction(payload: RgbppApiRetryCkbTransactionPayload): Promise<RgbppApiTransactionRetry>;
@@ -47,6 +48,24 @@ export interface RgbppApiAssetsByAddressParams {
   no_cache?: boolean;
 }
 
+export interface RgbppApiBalanceByAddressParams {
+  type_script?: string;
+  no_cache?: boolean;
+}
+export interface RgbppApiBalance {
+  address: string;
+  xudt: RgbppApiXudtBalance[];
+}
+export interface RgbppApiXudtBalance {
+  name: string;
+  decimal: number;
+  symbol: string;
+  total_amount: string;
+  available_amount: string;
+  pending_amount: string;
+  type_hash: string;
+}
+
 export interface RgbppApiSpvProof {
   proof: string;
   spv_client: {

packages/service/tests/Service.test.ts

@@ -261,12 +261,20 @@ describe(
           expectCell(cell);
         }
       });
-      it('getRgbppAssetsByBtcAddress() with no_cache', async () => {
-        const res = await service.getRgbppAssetsByBtcAddress(rgbppBtcAddress, {
-          no_cache: true,
-        });
+      it('getRgbppBalanceByBtcAddress()', async () => {
+        const res = await service.getRgbppBalanceByBtcAddress(rgbppBtcAddress);
         expect(res).toBeDefined();
-        expect(res.length).toBeGreaterThan(0);
+        expect(res.address).toBeTypeOf('string');
+        expect(res.xudt.length).toBeGreaterThan(0);
+        for (const xudt of res.xudt) {
+          expect(xudt.name).toBeTypeOf('string');
+          expect(xudt.decimal).toBeTypeOf('number');
+          expect(xudt.symbol).toBeTypeOf('string');
+          expect(xudt.total_amount).toBeTypeOf('string');
+          expect(xudt.available_amount).toBeTypeOf('string');
+          expect(xudt.pending_amount).toBeTypeOf('string');
+          expect(xudt.type_hash).toBeTypeOf('string');
+        }
       });
       it('getRgbppSpvProof()', async () => {
         const res = await service.getRgbppSpvProof(rgbppBtcTxId, 6);