This repository was archived by the owner on May 27, 2025. It is now read-only.
This repository was archived by the owner on May 27, 2025. It is now read-only.
Improve documentation/example of the BTC Builder APIs #240
Open
Description
Currently, we provide several BTC Builder APIs:
sendBtc
: Send BTC to one or more targets with easesendUtxos
: Specify inputs and outputs of the transaction as you likesendRgbppUtxos
: Construct an isomorphic RGBPP transaction from a RGBPP_CKB_VIRTUAL_TXsendRbf
: Resend a BTC transaction, providing higher fee rate and total fee to replace the original transaction
These APIs are designed to construct BTC transactions for various purposes, and each one is unique. However, the documentation for each API is still missing, and the examples shown in the README are not sufficiently detailed.
To improve this, we can possibly make the following changes:
- Write
.md
documentation for each BTC Builder API, describing each property's purpose, default value, and more. - Rewrite the examples provided in the btc README to improve the readability of the example code.