feat: Add generating btc time cell example (#259)

Author: duanyytop

examples/rgbpp/xudt/4-unlock-btc-time-cell.ts

@@ -38,5 +38,5 @@ const unlockBtcTimeCell = async ({ btcTimeCellArgs }: { btcTimeCellArgs: string
 // The btcTimeCellArgs is from the outputs[0].lock.args(BTC Time lock args) of the 3-btc-leap-ckb.ts CKB transaction
 unlockBtcTimeCell({
   btcTimeCellArgs:
-    '0x7d00000010000000590000005d000000490000001000000030000000310000009bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce80114000000f9a9ad51ed14936d33f7bb854aaefa5f47a3ccbd14000000b83a6014c458544360730d97e0ae5f36ecf6335f73afadf8eb10f84487392a27',
+    '0x7d00000010000000590000005d000000490000001000000030000000310000009bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce80114000000f9a9ad51ed14936d33f7bb854aaefa5f47a3ccbd880d0100ffc34d3d23f86df84a23a3b2cf72b45c8a309fec417ab196bee8e7a74483e05f',
 });

examples/xudt-on-ckb/2-transfer-xudt.ts

@@ -12,6 +12,7 @@ import {
   calculateTransactionFee,
   NoXudtLiveCellError,
   fetchTypeIdCellDeps,
+  getXudtTypeScript,
 } from 'rgbpp/ckb';
 import { CKB_PRIVATE_KEY, ckbAddress, collector, isMainnet } from './env';
 
@@ -139,8 +140,7 @@ const XUDT_TOKEN_INFO: RgbppTokenInfo = {
 transferXudt({
   // The xudtType comes from 1-issue-xudt
   xudtType: {
-    codeHash: '0x25c29dc317811a6f6f3985a7a9ebc4838bd388d19d0feeecf0bcd60f6c0975bb',
-    hashType: 'type',
+    ...getXudtTypeScript(isMainnet),
     args: '0x562e4e8a2f64a3e9c24beb4b7dd002d0ad3b842d0cc77924328e36ad114e3ebe',
   },
   receivers: [

examples/xudt-on-ckb/3-generate-btc-time-cell.ts

@@ -0,0 +1,151 @@
+import { addressToScript, getTransactionSize } from '@nervosnetwork/ckb-sdk-utils';
+import {
+  getSecp256k1CellDep,
+  NoLiveCellError,
+  calculateUdtCellCapacity,
+  MAX_FEE,
+  MIN_CAPACITY,
+  append0x,
+  u128ToLe,
+  SECP256K1_WITNESS_LOCK_SIZE,
+  calculateTransactionFee,
+  NoXudtLiveCellError,
+  fetchTypeIdCellDeps,
+  calculateRgbppCellCapacity,
+  getBtcTimeLockScript,
+  genBtcTimeLockArgs,
+  getXudtTypeScript,
+} from 'rgbpp/ckb';
+import { CKB_PRIVATE_KEY, ckbAddress, collector, isMainnet } from './env';
+
+interface BtcTimeCellParams {
+  xudtType: CKBComponents.Script;
+  toCkbAddress: string;
+  xudtAmount: bigint;
+  btcTxId: string;
+  after: number;
+}
+
+/**
+ * Generate btc time cell with custom btc txid, after and target lock script
+ * @param xudtType The xUDT type script that comes from 1-issue-xudt or 2-transfer-xudt
+ * BTC time lock args:
+ * table BTCTimeLock {
+    to_lock_script: Script,
+    after: Uint32,
+    btc_txid: Byte32,
+  }
+ */
+const generateBtcTimeCell = async ({ xudtType, toCkbAddress, xudtAmount, btcTxId, after }: BtcTimeCellParams) => {
+  const fromLock = addressToScript(ckbAddress);
+
+  const xudtCells = await collector.getCells({
+    lock: fromLock,
+    type: xudtType,
+  });
+  if (!xudtCells || xudtCells.length === 0) {
+    throw new NoXudtLiveCellError('The address has no xudt cells');
+  }
+
+  const btcTimeOutputCapacity = calculateRgbppCellCapacity(xudtType);
+  let sumXudtOutputCapacity = btcTimeOutputCapacity;
+
+  const {
+    inputs: udtInputs,
+    sumInputsCapacity: sumXudtInputsCapacity,
+    sumAmount,
+  } = collector.collectUdtInputs({
+    liveCells: xudtCells,
+    needAmount: xudtAmount,
+  });
+  let actualInputsCapacity = sumXudtInputsCapacity;
+  let inputs = udtInputs;
+
+  const outputs: CKBComponents.CellOutput[] = [
+    {
+      lock: {
+        ...getBtcTimeLockScript(isMainnet),
+        args: genBtcTimeLockArgs(addressToScript(toCkbAddress), btcTxId, after),
+      },
+      type: xudtType,
+      capacity: append0x(btcTimeOutputCapacity.toString(16)),
+    },
+  ];
+  const outputsData = [append0x(u128ToLe(xudtAmount))];
+
+  if (sumAmount > xudtAmount) {
+    const xudtChangeCapacity = calculateUdtCellCapacity(fromLock);
+    outputs.push({
+      lock: fromLock,
+      type: xudtType,
+      capacity: append0x(xudtChangeCapacity.toString(16)),
+    });
+    outputsData.push(append0x(u128ToLe(sumAmount - xudtAmount)));
+    sumXudtOutputCapacity += xudtChangeCapacity;
+  }
+
+  const txFee = MAX_FEE;
+  if (sumXudtInputsCapacity <= sumXudtOutputCapacity) {
+    let emptyCells = await collector.getCells({
+      lock: fromLock,
+    });
+    if (!emptyCells || emptyCells.length === 0) {
+      throw new NoLiveCellError('The address has no empty cells');
+    }
+    emptyCells = emptyCells.filter((cell) => !cell.output.type);
+    const needCapacity = sumXudtOutputCapacity - sumXudtInputsCapacity;
+    const { inputs: emptyInputs, sumInputsCapacity: sumEmptyCapacity } = collector.collectInputs(
+      emptyCells,
+      needCapacity,
+      txFee,
+      { minCapacity: MIN_CAPACITY },
+    );
+    inputs = [...inputs, ...emptyInputs];
+    actualInputsCapacity += sumEmptyCapacity;
+  }
+
+  let changeCapacity = actualInputsCapacity - sumXudtOutputCapacity;
+  outputs.push({
+    lock: fromLock,
+    capacity: append0x(changeCapacity.toString(16)),
+  });
+  outputsData.push('0x');
+
+  const emptyWitness = { lock: '', inputType: '', outputType: '' };
+  const witnesses = inputs.map((_, index) => (index === 0 ? emptyWitness : '0x'));
+
+  const cellDeps = [getSecp256k1CellDep(isMainnet), ...(await fetchTypeIdCellDeps(isMainnet, { xudt: true }))];
+
+  const unsignedTx = {
+    version: '0x0',
+    cellDeps,
+    headerDeps: [],
+    inputs,
+    outputs,
+    outputsData,
+    witnesses,
+  };
+
+  if (txFee === MAX_FEE) {
+    const txSize = getTransactionSize(unsignedTx) + SECP256K1_WITNESS_LOCK_SIZE;
+    const estimatedTxFee = calculateTransactionFee(txSize);
+    changeCapacity -= estimatedTxFee;
+    unsignedTx.outputs[unsignedTx.outputs.length - 1].capacity = append0x(changeCapacity.toString(16));
+  }
+
+  const signedTx = collector.getCkb().signTransaction(CKB_PRIVATE_KEY)(unsignedTx);
+  const txHash = await collector.getCkb().rpc.sendTransaction(signedTx, 'passthrough');
+
+  console.info(`xUDT asset has been transferred to BTC time lock and CKB tx hash is ${txHash}`);
+};
+
+generateBtcTimeCell({
+  xudtType: {
+    ...getXudtTypeScript(isMainnet),
+    args: '0x562e4e8a2f64a3e9c24beb4b7dd002d0ad3b842d0cc77924328e36ad114e3ebe',
+  },
+  toCkbAddress: 'ckt1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsq0e4xk4rmg5jdkn8aams492a7jlg73ue0gc0ddfj',
+  xudtAmount: BigInt(1000) * BigInt(10 ** 8),
+  btcTxId: '5fe08344a7e7e8be96b17a41ec9f308a5cb472cfb2a3234af86df8233d4dc3ff',
+  after: 69000,
+});