feat(service): adapt btc-assets-api#184 and #186

.changeset/clean-snails-admire.md

@@ -0,0 +1,5 @@
+---
+"@rgbpp-sdk/service": minor
+---
+
+Add "type_script" in the return type of /rgbpp/v1/address/{btc_address}/balance API, and add "typeHash" in the return type of rgbpp asset APIs

packages/service/src/service/service.ts

@@ -1,4 +1,3 @@
-import { Cell } from '@ckb-lumos/base';
 import { BtcAssetsApiBase } from './base';
 import {
   BtcApis,
@@ -18,6 +17,7 @@ import {
 } from '../types';
 import {
   RgbppApis,
+  RgbppCell,
   RgbppApiSpvProof,
   RgbppApiPaymasterInfo,
   RgbppApiTransactionState,
@@ -117,15 +117,15 @@ export class BtcAssetsApi extends BtcAssetsApiBase implements BtcApis, RgbppApis
   }
 
   getRgbppAssetsByBtcTxId(btcTxId: string) {
-    return this.request<Cell[]>(`/rgbpp/v1/assets/${btcTxId}`);
+    return this.request<RgbppCell[]>(`/rgbpp/v1/assets/${btcTxId}`);
   }
 
   getRgbppAssetsByBtcUtxo(btcTxId: string, vout: number) {
-    return this.request<Cell[]>(`/rgbpp/v1/assets/${btcTxId}/${vout}`);
+    return this.request<RgbppCell[]>(`/rgbpp/v1/assets/${btcTxId}/${vout}`);
   }
 
   getRgbppAssetsByBtcAddress(btcAddress: string, params?: RgbppApiAssetsByAddressParams) {
-    return this.request<Cell[]>(`/rgbpp/v1/address/${btcAddress}/assets`, {
+    return this.request<RgbppCell[]>(`/rgbpp/v1/address/${btcAddress}/assets`, {
       params,
     });
   }

packages/service/src/types/rgbpp.ts

@@ -1,12 +1,12 @@
-import { Cell } from '@ckb-lumos/base';
+import { Cell, Hash, Script } from '@ckb-lumos/base';
 
 export interface RgbppApis {
   getRgbppPaymasterInfo(): Promise<RgbppApiPaymasterInfo>;
   getRgbppTransactionHash(btcTxId: string): Promise<RgbppApiCkbTransactionHash>;
   getRgbppTransactionState(btcTxId: string): Promise<RgbppApiTransactionState>;
-  getRgbppAssetsByBtcTxId(btcTxId: string): Promise<Cell[]>;
-  getRgbppAssetsByBtcUtxo(btcTxId: string, vout: number): Promise<Cell[]>;
-  getRgbppAssetsByBtcAddress(btcAddress: string, params?: RgbppApiAssetsByAddressParams): Promise<Cell[]>;
+  getRgbppAssetsByBtcTxId(btcTxId: string): Promise<RgbppCell[]>;
+  getRgbppAssetsByBtcUtxo(btcTxId: string, vout: number): Promise<RgbppCell[]>;
+  getRgbppAssetsByBtcAddress(btcAddress: string, params?: RgbppApiAssetsByAddressParams): Promise<RgbppCell[]>;
   getRgbppBalanceByBtcAddress(btcAddress: string, params?: RgbppApiBalanceByAddressParams): Promise<RgbppApiBalance>;
   getRgbppSpvProof(btcTxId: string, confirmations: number): Promise<RgbppApiSpvProof>;
   sendRgbppCkbTransaction(payload: RgbppApiSendCkbTransactionPayload): Promise<RgbppApiTransactionState>;
@@ -43,6 +43,10 @@ export interface RgbppApiTransactionState {
   };
 }
 
+export interface RgbppCell extends Cell {
+  typeHash?: Hash;
+}
+
 export interface RgbppApiAssetsByAddressParams {
   type_script?: string;
   no_cache?: boolean;
@@ -64,6 +68,7 @@ export interface RgbppApiXudtBalance {
   available_amount: string;
   pending_amount: string;
   type_hash: string;
+  type_script: Script;
 }
 
 export interface RgbppApiSpvProof {

packages/service/tests/Service.test.ts

@@ -1,7 +1,7 @@
-import { Cell, blockchain } from '@ckb-lumos/base';
+import { Cell, blockchain, Script } from '@ckb-lumos/base';
 import { bytes } from '@ckb-lumos/codec';
 import { describe, expect, it } from 'vitest';
-import { BtcAssetsApiError, BtcAssetsApi, ErrorCodes, ErrorMessages } from '../src';
+import { BtcAssetsApiError, BtcAssetsApi, ErrorCodes, ErrorMessages, RgbppCell } from '../src';
 
 describe(
   'BtcServiceApi',
@@ -240,15 +240,15 @@ describe(
         expect(res).toBeDefined();
         expect(res.length).toBeGreaterThan(0);
         for (const cell of res) {
-          expectCell(cell);
+          expectRgbppCell(cell);
         }
       });
       it('getRgbppAssetsByBtcUtxo()', async () => {
         const res = await service.getRgbppAssetsByBtcUtxo(rgbppBtcTxId, rgbppBtcVout);
         expect(res).toBeDefined();
         expect(res.length).toBeGreaterThan(0);
         for (const cell of res) {
-          expectCell(cell);
+          expectRgbppCell(cell);
         }
       });
       it('getRgbppAssetsByBtcAddress()', async () => {
@@ -258,7 +258,7 @@ describe(
         expect(res).toBeDefined();
         expect(res.length).toBeGreaterThan(0);
         for (const cell of res) {
-          expectCell(cell);
+          expectRgbppCell(cell);
         }
       });
       it('getRgbppBalanceByBtcAddress()', async () => {
@@ -274,6 +274,7 @@ describe(
           expect(xudt.available_amount).toBeTypeOf('string');
           expect(xudt.pending_amount).toBeTypeOf('string');
           expect(xudt.type_hash).toBeTypeOf('string');
+          expectScript(xudt.type_script);
         }
       });
       it('getRgbppSpvProof()', async () => {
@@ -316,3 +317,18 @@ function expectCell(cell: Cell) {
 
   expect(cell.data).toBeTypeOf('string');
 }
+
+function expectRgbppCell(cell: RgbppCell) {
+  expectCell(cell);
+
+  if (cell.typeHash) {
+    expect(cell.typeHash).toBeTypeOf('string');
+  }
+}
+
+function expectScript(script: Script) {
+  expect(script).toBeDefined();
+  expect(script.codeHash).toBeTypeOf('string');
+  expect(script.hashType).toBeTypeOf('string');
+  expect(script.args).toBeTypeOf('string');
+}