Merge pull request #200 from ckb-cell/feat/batch-queries

feat(btc): batch queries to improve transaction build time

.changeset/smart-pigs-compete.md

@@ -0,0 +1,5 @@
+---
+"@rgbpp-sdk/btc": minor
+---
+
+Add p-limit and batch queries in the sendRgbppUtxos() and TxBuilder.validateInputs() to improve construction time

packages/btc/package.json

@@ -24,7 +24,8 @@
     "bip32": "^4.0.0",
     "bitcoinjs-lib": "^6.1.5",
     "ecpair": "^2.1.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "p-limit": "^3.1.0"
   },
   "devDependencies": {
     "@types/lodash": "^4.17.0",

packages/btc/src/api/sendRgbppUtxos.ts

@@ -9,6 +9,7 @@ import { InitOutput, TxAddressOutput, TxBuilder } from '../transaction/build';
 import { networkTypeToConfig } from '../preset/config';
 import { unpackRgbppLockArgs } from '../ckb/molecule';
 import { createSendUtxosBuilder } from './sendUtxos';
+import { limitPromiseBatchSize } from '../utils';
 
 export interface SendRgbppUtxosProps {
   ckbVirtualTx: CKBComponents.RawTransaction;
@@ -47,21 +48,45 @@ export async function createSendRgbppUtxosBuilder(props: SendRgbppUtxosProps): P
   const config = networkTypeToConfig(props.source.networkType);
   const isCkbMainnet = props.source.networkType === NetworkType.MAINNET;
 
+  // Batch querying live cells from CkbCollector
+  const ckbLiveCells = await Promise.all(
+    ckbVirtualTx.inputs.map((ckbInput) => {
+      return limitPromiseBatchSize(async () => {
+        const ckbLiveCell = await props.ckbCollector.getLiveCell(ckbInput.previousOutput!);
+        const isRgbppLock = isRgbppLockCell(ckbLiveCell.output, isCkbMainnet);
+        const lockArgs = isRgbppLock ? unpackRgbppLockArgs(ckbLiveCell.output.lock.args) : undefined;
+        return {
+          ckbLiveCell,
+          isRgbppLock,
+          lockArgs,
+        };
+      });
+    }),
+  );
+
+  // Batch querying UTXO from BtcAssetsApi
+  const btcUtxos = await Promise.all(
+    ckbLiveCells.map(({ ckbLiveCell, isRgbppLock }) => {
+      if (isRgbppLock) {
+        const args = unpackRgbppLockArgs(ckbLiveCell.output.lock.args);
+        return limitPromiseBatchSize(() => props.source.getUtxo(args.btcTxid, args.outIndex, props.onlyConfirmedUtxos));
+      }
+      return undefined;
+    }),
+  );
+
   // Handle and check inputs
   for (let i = 0; i < ckbVirtualTx.inputs.length; i++) {
-    const ckbInput = ckbVirtualTx.inputs[i];
-
-    const ckbLiveCell = await props.ckbCollector.getLiveCell(ckbInput.previousOutput!);
-    const isRgbppLock = isRgbppLockCell(ckbLiveCell.output, isCkbMainnet);
+    const { lockArgs, isRgbppLock } = ckbLiveCells[i];
 
     // If input.lock == RgbppLock, add to inputs if:
     // 1. input.lock.args can be unpacked to RgbppLockArgs
     // 2. utxo can be found via the DataSource.getUtxo() API
     // 3. utxo.scriptPk == addressToScriptPk(props.from)
     // 4. utxo is not duplicated in the inputs
     if (isRgbppLock) {
-      const args = unpackRgbppLockArgs(ckbLiveCell.output.lock.args);
-      const utxo = await props.source.getUtxo(args.btcTxid, args.outIndex, props.onlyConfirmedUtxos);
+      const args = lockArgs!;
+      const utxo = btcUtxos[i];
       if (!utxo) {
         throw TxBuildError.withComment(ErrorCodes.CANNOT_FIND_UTXO, `hash: ${args.btcTxid}, index: ${args.outIndex}`);
       }

packages/btc/src/transaction/build.ts

@@ -6,6 +6,7 @@ import { NetworkType, RgbppBtcConfig } from '../preset/types';
 import { AddressType, addressToScriptPublicKeyHex, getAddressType, isSupportedFromAddress } from '../address';
 import { dataToOpReturnScriptPubkey, isOpReturnScriptPubkey } from './embed';
 import { networkTypeToConfig } from '../preset/config';
+import { limitPromiseBatchSize } from '../utils';
 import { Utxo, utxoToInput } from './utxo';
 import { FeeEstimator } from './fee';
 
@@ -86,15 +87,19 @@ export class TxBuilder {
   }
 
   async validateInputs() {
-    for (const input of this.inputs) {
-      const transactionConfirmed = await this.source.isTransactionConfirmed(input.data.hash);
-      if (!transactionConfirmed) {
-        throw TxBuildError.withComment(
-          ErrorCodes.UNCONFIRMED_UTXO,
-          `hash: ${input.data.hash}, index: ${input.data.index}`,
-        );
-      }
-    }
+    await Promise.all(
+      this.inputs.map(async (input) => {
+        return limitPromiseBatchSize(async () => {
+          const transactionConfirmed = await this.source.isTransactionConfirmed(input.data.hash);
+          if (!transactionConfirmed) {
+            throw TxBuildError.withComment(
+              ErrorCodes.UNCONFIRMED_UTXO,
+              `hash: ${input.data.hash}, index: ${input.data.index}`,
+            );
+          }
+        });
+      }),
+    );
   }
 
   addOutput(output: InitOutput) {

packages/btc/src/utils.ts

@@ -1,3 +1,4 @@
+import limitPromiseConcurrency from 'p-limit';
 import { bitcoin, ecc, ECPair } from './bitcoin';
 import { bytes } from '@ckb-lumos/codec';
 
@@ -75,3 +76,15 @@ export function transactionToHex(tx: bitcoin.Transaction, withWitness?: boolean)
   const buffer: Buffer = tx['__toBuffer'](undefined, undefined, withWitness ?? false);
   return buffer.toString('hex');
 }
+
+/**
+ * Limits the batch size of promises when querying with Promise.all().
+ * @example
+ * await Promise.all([
+ *   limitPromiseBatchSize(() => asyncDoSomething()),
+ *   limitPromiseBatchSize(() => asyncDoSomething()),
+ *   limitPromiseBatchSize(() => asyncDoSomething()),
+ *   ...
+ * ]);
+ */
+export const limitPromiseBatchSize = limitPromiseConcurrency(10);