Merge pull request #12 from RGBPlusPlus/develop

Merge branch `develop` into `main`

Author: Hanssen0

.github/workflows/test.yaml

@@ -48,15 +48,15 @@ jobs:
 
       - name: Lint packages
         run: pnpm run lint
-        
+
       - name: Run unit tests for the packages
         run: pnpm run test:packages
         env:
           VITE_CKB_NODE_URL: https://testnet.ckb.dev/rpc
           VITE_CKB_INDEXER_URL: https://testnet.ckb.dev/indexer
-          VITE_BTC_SERVICE_URL: https://btc-assets-api.testnet.mibao.pro
+          VITE_BTC_SERVICE_URL: https://api.testnet.rgbpp.io
           VITE_BTC_SERVICE_TOKEN: ${{ secrets.TESTNET_SERVICE_TOKEN }}
-          VITE_BTC_SERVICE_ORIGIN: https://btc-assets-api.testnet.mibao.pro
+          VITE_BTC_SERVICE_ORIGIN: https://api.testnet.rgbpp.io
 
       - name: Run unit tests for the rgbpp-sdk-service
         run: pnpm run test:service

README.md

@@ -69,8 +69,8 @@ This repository offers utilities for Bitcoin and RGB++ asset integration.
 
 ## FAQ
 
-### How to get an access token of Bitcoin/RGB++ Assets Service?
-See [Generate a JSON Web Token (JWT) for Bitcoin/RGB++ Assets Service](./packages/service/README.md#get-an-access-token)
+### How to access the Bitcoin/RGB++ Assets Service?
+See [Get a service URL](./packages/service/README.md#get-a-service-url)
 
 ### Where is the error code description for the RgbppLockScript?
 See [RGB++ Lock Script Error Codes](https://github.com/nervosnetwork/ckb-script-error-codes/blob/main/by-type-hash/bc6c568a1a0d0a09f6844dc9d74ddb4343c32143ff25f727c59edf4fb72d6936.md)

packages/ckb/src/constants/index.ts

@@ -27,12 +27,12 @@ const TestnetInfo = {
   } as CKBComponents.Script,
 
   RgbppLockDep: {
-    outPoint: { txHash: '0xf1de59e973b85791ec32debbba08dff80c63197e895eb95d67fc1e9f6b413e00', index: '0x0' },
+    outPoint: { txHash: '0x0d1567da0979f78b297d5311442669fbd1bd853c8be324c5ab6da41e7a1ed6e5', index: '0x0' },
     depType: 'code',
   } as CKBComponents.CellDep,
 
   RgbppLockConfigDep: {
-    outPoint: { txHash: '0xf1de59e973b85791ec32debbba08dff80c63197e895eb95d67fc1e9f6b413e00', index: '0x1' },
+    outPoint: { txHash: '0x0d1567da0979f78b297d5311442669fbd1bd853c8be324c5ab6da41e7a1ed6e5', index: '0x1' },
     depType: 'code',
   } as CKBComponents.CellDep,
 
@@ -43,12 +43,12 @@ const TestnetInfo = {
   } as CKBComponents.Script,
 
   BtcTimeLockDep: {
-    outPoint: { txHash: '0xde0f87878a97500f549418e5d46d2f7704c565a262aa17036c9c1c13ad638529', index: '0x0' },
+    outPoint: { txHash: '0x8fb747ff0416a43e135c583b028f98c7b81d3770551b196eb7ba1062dd9acc94', index: '0x0' },
     depType: 'code',
   } as CKBComponents.CellDep,
 
   BtcTimeLockConfigDep: {
-    outPoint: { txHash: '0xde0f87878a97500f549418e5d46d2f7704c565a262aa17036c9c1c13ad638529', index: '0x1' },
+    outPoint: { txHash: '0x8fb747ff0416a43e135c583b028f98c7b81d3770551b196eb7ba1062dd9acc94', index: '0x1' },
     depType: 'code',
   } as CKBComponents.CellDep,
 

packages/ckb/src/rgbpp/btc-jump-ckb.ts

@@ -2,9 +2,7 @@ import { RgbppCkbVirtualTx, BtcJumpCkbVirtualTxParams, BtcJumpCkbVirtualTxResult
 import { TypeAssetNotSupportedError } from '../error';
 import {
   append0x,
-  calculateCellOccupiedCapacity,
   calculateRgbppCellCapacity,
-  calculateTransactionFee,
   deduplicateList,
   fetchTypeIdCellDeps,
   isLockArgsSizeExceeded,
@@ -22,11 +20,12 @@ import {
   isRgbppCapacitySufficientForChange,
   isStandardUDTTypeSupported,
   isOfflineMode,
+  adjustVirtualTxForTxFee,
 } from '../utils';
 import { Hex, IndexerCell } from '../types';
 import { RGBPP_WITNESS_PLACEHOLDER, getSecp256k1CellDep } from '../constants';
 import { blockchain } from '@ckb-lumos/base';
-import { addressToScript, getTransactionSize } from '@nervosnetwork/ckb-sdk-utils';
+import { addressToScript } from '@nervosnetwork/ckb-sdk-utils';
 
 /**
  * Generate the virtual ckb transaction for the jumping tx from BTC to CKB
@@ -99,31 +98,28 @@ export const genBtcJumpCkbVirtualTx = async ({
 
   let needPaymasterCell = false;
   const needRgbppChange = sumAmount > transferAmount;
-  // To simplify, when the xUDT does not need change, all the capacity of the inputs will be given to the receiver
-  const candidateCapacity = needRgbppChange ? BigInt(rgbppTargetCells[0].output.capacity) : sumInputsCapacity;
-
-  const receiverLock = genBtcTimeLockScript(toLock, isMainnet, btcTestnetType, btcConfirmationBlocks);
-  const receiverData = append0x(u128ToLe(transferAmount));
 
-  const minRequiredCapacity = calculateCellOccupiedCapacity({
-    output: { lock: receiverLock, type: xudtType, capacity: '0x0' },
-    outputData: receiverData,
-  } as IndexerCell);
+  // To simplify, when the xUDT does not need change, all the capacity of the inputs will be given to the receiver
+  const candidateReceiverOutputCapacity = needRgbppChange
+    ? BigInt(rgbppTargetCells[0].output.capacity)
+    : sumInputsCapacity;
+  const receiverOutputCapacity =
+    candidateReceiverOutputCapacity >= rgbppCellCapacity ? candidateReceiverOutputCapacity : rgbppCellCapacity;
 
-  const receiverOutputCapacity = candidateCapacity > minRequiredCapacity ? candidateCapacity : minRequiredCapacity;
   // The BTC time cell does not need to be bound to the BTC UTXO
   const outputs: CKBComponents.CellOutput[] = [
     {
-      lock: receiverLock,
+      lock: genBtcTimeLockScript(toLock, isMainnet, btcTestnetType, btcConfirmationBlocks),
       type: xudtType,
       capacity: append0x(receiverOutputCapacity.toString(16)),
     },
   ];
-  const outputsData = [receiverData];
+  const outputsData = [append0x(u128ToLe(transferAmount))];
+
+  const isCapacitySufficient = isRgbppCapacitySufficientForChange(sumInputsCapacity, receiverOutputCapacity);
+  needPaymasterCell = !isCapacitySufficient;
 
   if (needRgbppChange) {
-    const isCapacitySufficient = isRgbppCapacitySufficientForChange(sumInputsCapacity, receiverOutputCapacity);
-    needPaymasterCell = !isCapacitySufficient;
     // When the capacity of inputs is enough for the outputs, the sender needs to recover the excess capacity.
     const udtChangeCapacity = isCapacitySufficient ? sumInputsCapacity - receiverOutputCapacity : rgbppCellCapacity;
     outputs.push({
@@ -188,11 +184,15 @@ export const genBtcJumpCkbVirtualTx = async ({
   };
 
   if (!needPaymasterCell) {
-    const txSize =
-      getTransactionSize(ckbRawTx) + (witnessLockPlaceholderSize ?? estimateWitnessSize(deduplicatedLockArgsList));
-    const estimatedTxFee = calculateTransactionFee(txSize, ckbFeeRate);
-    const changeCapacity = BigInt(outputs[outputs.length - 1].capacity) - estimatedTxFee;
-    ckbRawTx.outputs[ckbRawTx.outputs.length - 1].capacity = append0x(changeCapacity.toString(16));
+    const txFeeAdjustedResult = adjustVirtualTxForTxFee(
+      ckbRawTx,
+      isMainnet,
+      witnessLockPlaceholderSize ?? estimateWitnessSize(deduplicatedLockArgsList),
+      ckbFeeRate,
+    );
+    needPaymasterCell = txFeeAdjustedResult.needPaymasterCell;
+    ckbRawTx.outputs = txFeeAdjustedResult.outputs;
+    ckbRawTx.cellDeps = txFeeAdjustedResult.cellDeps;
   }
 
   const virtualTx: RgbppCkbVirtualTx = {

packages/ckb/src/rgbpp/btc-transfer.ts

@@ -28,6 +28,7 @@ import {
   signCkbTransaction,
   addressToScriptHash,
   isOfflineMode,
+  adjustVirtualTxForTxFee,
 } from '../utils';
 import { Hex, IndexerCell } from '../types';
 import {
@@ -143,7 +144,12 @@ export const genBtcTransferCkbVirtualTx = async ({
 
     const needRgbppChange = collectResult.sumAmount > transferAmount;
     // To simplify, when the xUDT does not need change, all the capacity of the inputs will be given to the receiver
-    const receiverOutputCapacity = needRgbppChange ? BigInt(rgbppTargetCells[0].output.capacity) : sumInputsCapacity;
+    const candidateReceiverOutputCapacity = needRgbppChange
+      ? BigInt(rgbppTargetCells[0].output.capacity)
+      : sumInputsCapacity;
+    const receiverOutputCapacity =
+      candidateReceiverOutputCapacity >= rgbppCellCapacity ? candidateReceiverOutputCapacity : rgbppCellCapacity;
+
     // The Vouts[0] for OP_RETURN and Vouts[1] for target transfer RGBPP assets
     outputs.push({
       lock: genRgbppLockScript(buildPreLockArgs(1), isMainnet, btcTestnetType),
@@ -152,9 +158,9 @@ export const genBtcTransferCkbVirtualTx = async ({
     });
     outputsData.push(append0x(u128ToLe(transferAmount)));
 
+    const isCapacitySufficient = isRgbppCapacitySufficientForChange(sumInputsCapacity, receiverOutputCapacity);
+    needPaymasterCell = !isCapacitySufficient;
     if (needRgbppChange) {
-      const isCapacitySufficient = isRgbppCapacitySufficientForChange(sumInputsCapacity, receiverOutputCapacity);
-      needPaymasterCell = !isCapacitySufficient;
       // When the capacity of inputs is enough for the outputs, the sender needs to recover the excess capacity.
       const udtChangeCapacity = isCapacitySufficient ? sumInputsCapacity - receiverOutputCapacity : rgbppCellCapacity;
       // The Vouts[2] for target change RGBPP assets
@@ -206,12 +212,15 @@ export const genBtcTransferCkbVirtualTx = async ({
   };
 
   if (!needPaymasterCell) {
-    const txSize =
-      getTransactionSize(ckbRawTx) + (witnessLockPlaceholderSize ?? estimateWitnessSize(deduplicatedLockArgsList));
-    const estimatedTxFee = calculateTransactionFee(txSize, ckbFeeRate);
-
-    const changeCapacity = BigInt(outputs[outputs.length - 1].capacity) - estimatedTxFee;
-    ckbRawTx.outputs[ckbRawTx.outputs.length - 1].capacity = append0x(changeCapacity.toString(16));
+    const txFeeAdjustedResult = adjustVirtualTxForTxFee(
+      ckbRawTx,
+      isMainnet,
+      witnessLockPlaceholderSize ?? estimateWitnessSize(deduplicatedLockArgsList),
+      ckbFeeRate,
+    );
+    needPaymasterCell = txFeeAdjustedResult.needPaymasterCell;
+    ckbRawTx.outputs = txFeeAdjustedResult.outputs;
+    ckbRawTx.cellDeps = txFeeAdjustedResult.cellDeps;
   }
 
   const virtualTx: RgbppCkbVirtualTx = {

packages/ckb/src/rgbpp/ckb-builder.ts

@@ -87,6 +87,7 @@ export const appendPaymasterCellAndSignCkbTx = async ({
   ckbFeeRate,
 }: AppendPaymasterCellAndSignTxParams): Promise<CKBComponents.RawTransaction> => {
   const rawTx = ckbRawTx as CKBComponents.RawTransactionToSign;
+  const numOriginalInputs = rawTx.inputs.length;
   const paymasterInput = { previousOutput: paymasterCell.outPoint, since: '0x0' };
   rawTx.inputs = [...rawTx.inputs, paymasterInput];
   const inputsCapacity = BigInt(sumInputsCapacity) + BigInt(paymasterCell.output.capacity);
@@ -123,7 +124,11 @@ export const appendPaymasterCellAndSignCkbTx = async ({
   }));
 
   const emptyWitness = { lock: '', inputType: '', outputType: '' };
-  rawTx.witnesses = [...rawTx.witnesses, emptyWitness];
+  rawTx.witnesses = [
+    ...rawTx.witnesses.slice(0, numOriginalInputs),
+    emptyWitness,
+    ...rawTx.witnesses.slice(numOriginalInputs),
+  ];
 
   const transactionHash = rawTransactionToHash(rawTx);
   const signedWitnesses = signWitnesses(keyMap)({

packages/ckb/src/rgbpp/launch.ts

@@ -29,7 +29,7 @@ import { getTransactionSize, scriptToHash } from '@nervosnetwork/ckb-sdk-utils';
  * @param collector The collector that collects CKB live cells and transactions
  * @param ownerRgbppLockArgs The owner RGBPP lock args whose data structure is: out_index | bitcoin_tx_id
  * @param launchAmount The total amount of RGBPP assets issued
- * @param rgbppTokenInfo The RGBPP token info https://github.com/ckb-cell/unique-cell?tab=readme-ov-file#xudt-information
+ * @param rgbppTokenInfo The RGBPP token info https://github.com/RGBPlusPlus/unique-cell?tab=readme-ov-file#xudt-information
  * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param witnessLockPlaceholderSize(Optional) The WitnessArgs.lock placeholder bytes array size and the default value is 5000
  * @param ckbFeeRate(Optional) The CKB transaction fee rate, default value is 1100

packages/ckb/src/spore/leap.ts

@@ -12,8 +12,12 @@ import {
   append0x,
   fetchTypeIdCellDeps,
   calculateTransactionFee,
+  adjustVirtualTxForTxFee,
+  calculateRgbppSporeCellCapacity,
+  calculateCellOccupiedCapacity,
 } from '../utils';
 import {
+  IndexerCell,
   Hex,
   LeapSporeFromBtcToCkbVirtualTxParams,
   LeapSporeFromCkbToBtcVirtualTxParams,
@@ -23,6 +27,7 @@ import {
   RGBPP_TX_WITNESS_MAX_SIZE,
   RGBPP_WITNESS_PLACEHOLDER,
   getRgbppLockScript,
+  getSecp256k1CellDep,
   getSporeTypeDep,
 } from '../constants';
 import { NoRgbppLiveCellError } from '../error';
@@ -34,6 +39,7 @@ import {
   serializeOutPoint,
   serializeWitnessArgs,
 } from '@nervosnetwork/ckb-sdk-utils';
+import { unpackToRawSporeData } from '@spore-sdk/core';
 
 /**
  * Generate the virtual ckb transaction for leaping spore from BTC to CKB
@@ -75,16 +81,31 @@ export const genLeapSporeFromBtcToCkbVirtualTx = async ({
   ];
 
   const toLock = addressToScript(toCkbAddress);
-  const outputs: CKBComponents.CellOutput[] = [
-    {
-      ...sporeCell.output,
-      lock: genBtcTimeLockScript(toLock, isMainnet, btcTestnetType),
-    },
-  ];
+  const sporeOutput = {
+    ...sporeCell.output,
+    lock: genBtcTimeLockScript(toLock, isMainnet, btcTestnetType),
+  };
+
+  let needPaymasterCell = false;
+  let cellDeps: CKBComponents.CellDep[] = [];
+  if (
+    BigInt(sporeOutput.capacity) <=
+    calculateCellOccupiedCapacity({ output: sporeOutput, outputData: sporeCell.outputData } as IndexerCell)
+  ) {
+    needPaymasterCell = true;
+    // restore the capacity to be consistent (with margin)
+    sporeOutput.capacity = append0x(
+      calculateRgbppSporeCellCapacity(unpackToRawSporeData(sporeCell.outputData)).toString(16),
+    );
+    cellDeps.push(getSecp256k1CellDep(isMainnet));
+  }
+
+  const outputs: CKBComponents.CellOutput[] = [sporeOutput];
   const outputsData: Hex[] = [sporeCell.outputData];
-  const cellDeps = [
+  cellDeps = [
     ...(await fetchTypeIdCellDeps(isMainnet, { rgbpp: true }, btcTestnetType, vendorCellDeps)),
     getSporeTypeDep(isMainnet),
+    ...cellDeps,
   ];
   const sporeCoBuild = generateSporeTransferCoBuild([sporeCell], outputs);
   const witnesses = [RGBPP_WITNESS_PLACEHOLDER, sporeCoBuild];
@@ -99,12 +120,17 @@ export const genLeapSporeFromBtcToCkbVirtualTx = async ({
     witnesses,
   };
 
-  let changeCapacity = BigInt(sporeCell.output.capacity);
-  const txSize = getTransactionSize(ckbRawTx) + (witnessLockPlaceholderSize ?? RGBPP_TX_WITNESS_MAX_SIZE);
-  const estimatedTxFee = calculateTransactionFee(txSize, ckbFeeRate);
-  changeCapacity -= estimatedTxFee;
-
-  ckbRawTx.outputs[ckbRawTx.outputs.length - 1].capacity = append0x(changeCapacity.toString(16));
+  if (!needPaymasterCell) {
+    const txFeeAdjustedResult = adjustVirtualTxForTxFee(
+      ckbRawTx,
+      isMainnet,
+      witnessLockPlaceholderSize ?? RGBPP_TX_WITNESS_MAX_SIZE,
+      ckbFeeRate,
+    );
+    ckbRawTx.outputs = txFeeAdjustedResult.outputs;
+    ckbRawTx.cellDeps = txFeeAdjustedResult.cellDeps;
+    needPaymasterCell = txFeeAdjustedResult.needPaymasterCell;
+  }
 
   const virtualTx: RgbppCkbVirtualTx = {
     ...ckbRawTx,
@@ -115,7 +141,7 @@ export const genLeapSporeFromBtcToCkbVirtualTx = async ({
     ckbRawTx,
     commitment,
     sporeCell,
-    needPaymasterCell: false,
+    needPaymasterCell,
     sumInputsCapacity: sporeCell.output.capacity,
   };
 };