docs: Fix typo

utxostack · Jun 18, 2024 · be8132c · be8132c
1 parent bdf5d87
commit be8132c
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 37 deletions.
diff --git a/packages/ckb/README.md b/packages/ckb/README.md
@@ -46,7 +46,7 @@ export interface BtcTransferVirtualTxResult {
  * @param xudtTypeBytes The serialized hex string of the XUDT type script
  * @param rgbppLockArgsList The rgbpp assets cell lock script args array whose data structure is: out_index | bitcoin_tx_id
  * @param transferAmount The XUDT amount to be transferred, if the noMergeOutputCells is true, the transferAmount will be ignored
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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 noMergeOutputCells(Optional) The noMergeOutputCells indicates whether the CKB outputs need to be merged. By default, the outputs will be merged.
  * @param ckbFeeRate(Optional) The CKB transaction fee rate, default value is 1100
@@ -150,7 +150,7 @@ export interface SporeCreateVirtualTxResult {
  * @param collector The collector that collects CKB live cells and transactions
  * @param clusterRgbppLockArgs The cluster rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeDataList The spore's data list, including name and description.
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
  */
 export const genCreateSporeCkbVirtualTx = async ({
@@ -185,7 +185,7 @@ export interface SporeTransferVirtualTxResult {
  * @param collector The collector that collects CKB live cells and transactions
  * @param sporeRgbppLockArgs The spore rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeTypeBytes The spore type script serialized bytes
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
@@ -225,7 +225,7 @@ export interface SporeLeapVirtualTxResult {
  * @param sporeRgbppLockArgs The spore rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeTypeBytes The spore type script serialized bytes
  * @param toCkbAddress The receiver ckb address
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
@@ -253,7 +253,7 @@ The method `genLeapSporeFromCkbToBtcRawTx` can generate a CKB transaction for RG
  * @param sporeRgbppLockArgs The spore rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeTypeBytes The spore type script serialized bytes
  * @param toCkbAddress The receiver ckb address
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB 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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet

diff --git a/packages/ckb/src/rgbpp/btc-time.ts b/packages/ckb/src/rgbpp/btc-time.ts
@@ -39,7 +39,7 @@ export const buildBtcTimeUnlockWitness = (btcTxProof: Hex): Hex => {
  * The btc time lock args data structure is: lock_script | after | new_bitcoin_tx_id
  * @param btcTimeCells The BTC time cells of xUDT
  * @param btcAssetsApi BTC Assets Api
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
  */
 export const buildBtcTimeCellsSpentTx = async ({
@@ -116,7 +116,7 @@ export const buildBtcTimeCellsSpentTx = async ({
  * @param masterCkbAddress The master CKB address
  * @param outputCapacityRange(Optional) [u64; 2], filter cells by output capacity range, [inclusive, exclusive]
  * @param ckbFeeRate(Optional) The CKB transaction fee rate, default value is 1100
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
  */
 export const signBtcTimeCellSpentTx = async ({
   secp256k1PrivateKey,

diff --git a/packages/ckb/src/rgbpp/btc-transfer.ts b/packages/ckb/src/rgbpp/btc-transfer.ts
@@ -52,7 +52,7 @@ import signWitnesses from '@nervosnetwork/ckb-sdk-core/lib/signWitnesses';
  * @param xudtTypeBytes The serialized hex string of the XUDT type script
  * @param rgbppLockArgsList The rgbpp assets cell lock script args array whose data structure is: out_index | bitcoin_tx_id
  * @param transferAmount The XUDT amount to be transferred, if the noMergeOutputCells is true, the transferAmount will be ignored
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param noMergeOutputCells(Optional) The noMergeOutputCells indicates whether the CKB outputs need to be merged. By default, the outputs will be merged.
  * @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
@@ -226,7 +226,7 @@ export const genBtcTransferCkbVirtualTx = async ({
  * @param xudtTypeBytes The serialized hex string of the XUDT type script
  * @param rgbppLockArgsList The rgbpp assets cell lock script args array whose data structure is: out_index | bitcoin_tx_id
  * @param rgbppReceivers The rgbpp receiver list which include toBtcAddress and transferAmount
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
  */
 export const genBtcBatchTransferCkbVirtualTx = async ({
@@ -334,7 +334,7 @@ export const genBtcBatchTransferCkbVirtualTx = async ({
  * @param collector The collector that collects CKB live cells and transactions
  * @param ckbRawTx CKB raw transaction
  * @param sumInputsCapacity The sum capacity of ckb inputs which is to be used to calculate ckb tx fee
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
  * @param ckbFeeRate The CKB transaction fee rate, default value is 1100
  */
 export const appendIssuerCellToBtcBatchTransfer = async ({

diff --git a/packages/ckb/src/rgbpp/ckb-builder.ts b/packages/ckb/src/rgbpp/ckb-builder.ts
@@ -154,7 +154,7 @@ export const sendCkbTx = async ({ collector, signedTx }: SendCkbTxParams) => {
  * Replace the RGBPP_TX_ID_PLACEHOLDER with the real btc tx id of the rgbpp lock args and BTC time lock args
  * @param ckbRawTx CKB raw transaction
  * @param btcTxId The BTC transaction id
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
  */
 export const updateCkbTxWithRealBtcTxId = ({
   ckbRawTx,

diff --git a/packages/ckb/src/rgbpp/launch.ts b/packages/ckb/src/rgbpp/launch.ts
@@ -32,7 +32,7 @@ import { getTransactionSize, scriptToHash } from '@nervosnetwork/ckb-sdk-utils';
  * @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 isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3

diff --git a/packages/ckb/src/spore/cluster.ts b/packages/ckb/src/spore/cluster.ts
@@ -18,7 +18,7 @@ import { bytesToHex, getTransactionSize } from '@nervosnetwork/ckb-sdk-utils';
  * @param collector The collector that collects CKB live cells and transactions
  * @param rgbppLockArgs The rgbpp assets cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param clusterData The cluster's data, including name and description.
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3

diff --git a/packages/ckb/src/spore/leap.ts b/packages/ckb/src/spore/leap.ts
@@ -39,7 +39,7 @@ import { buildBtcTimeUnlockWitness } from '../rgbpp';
  * @param sporeRgbppLockArgs The spore rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeTypeBytes The spore type script serialized bytes
  * @param toCkbAddress The receiver ckb address
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
@@ -122,7 +122,7 @@ export const genLeapSporeFromBtcToCkbVirtualTx = async ({
  * The btc time lock args data structure is: lock_script | after | new_bitcoin_tx_id
  * @param btcTimeCells The BTC time cells of spore
  * @param btcAssetsApi BTC Assets Api
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
  */
 export const buildSporeBtcTimeCellsSpentTx = async ({
@@ -199,7 +199,7 @@ export const buildSporeBtcTimeCellsSpentTx = async ({
  * @param sporeRgbppLockArgs The spore rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeTypeBytes The spore type script serialized bytes
  * @param toCkbAddress The receiver ckb address
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB 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
  */

diff --git a/packages/ckb/src/spore/spore.ts b/packages/ckb/src/spore/spore.ts
@@ -56,7 +56,7 @@ import signWitnesses from '@nervosnetwork/ckb-sdk-core/lib/signWitnesses';
  * @param collector The collector that collects CKB live cells and transactions
  * @param clusterRgbppLockArgs The cluster rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeDataList The spore's data list, including name and description.
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
  */
 export const genCreateSporeCkbVirtualTx = async ({
@@ -217,7 +217,7 @@ export const buildAppendingIssuerCellToSporesCreateTx = async ({
  * @param collector The collector that collects CKB live cells and transactions
  * @param ckbRawTx CKB raw transaction
  * @param sumInputsCapacity The sum capacity of ckb inputs which is to be used to calculate ckb tx fee
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @param isMainnet True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
  * @param ckbFeeRate(Optional) The CKB transaction fee rate, default value is 1100
  */
 export const appendIssuerCellToSporesCreate = async ({
@@ -285,7 +285,7 @@ export const appendIssuerCellToSporesCreate = async ({
  * @param collector The collector that collects CKB live cells and transactions
  * @param sporeRgbppLockArgs The spore rgbpp cell lock script args whose data structure is: out_index | bitcoin_tx_id
  * @param sporeTypeBytes The spore type script serialized bytes
- * @param isMainnet True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+ * @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
  * @param btcTestnetType(Optional) The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3

diff --git a/packages/ckb/src/types/index.ts b/packages/ckb/src/types/index.ts
@@ -2,5 +2,4 @@ export * from './common';
 export * from './collector';
 export * from './rgbpp';
 export * from './spv';
-export * from './queue';
 export * from './spore';
diff --git a/packages/ckb/src/types/rgbpp.ts b/packages/ckb/src/types/rgbpp.ts
@@ -25,7 +25,7 @@ export interface BtcTransferVirtualTxParams {
   rgbppLockArgsList: Hex[];
   // The XUDT amount to be transferred, if the noMergeOutputCells is true, the transferAmount will be ignored
   transferAmount: bigint;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
   isMainnet: boolean;
   // The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
   btcTestnetType?: BTCTestnetType;
@@ -53,7 +53,7 @@ export interface BtcBatchTransferVirtualTxParams {
   rgbppLockArgsList: Hex[];
   // The rgbpp receiver list which include toRgbppLockArgs and transferAmount
   rgbppReceivers: RgbppBtcAddressReceiver[];
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
   isMainnet: boolean;
   // The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
   btcTestnetType?: BTCTestnetType;
@@ -112,7 +112,7 @@ export interface AppendPaymasterCellAndSignTxParams {
   sumInputsCapacity: Hex;
   // The paymaster cell to be inserted into CKB transaction to pay an extra output cell
   paymasterCell: IndexerCell;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
   isMainnet: boolean;
   // The CKB transaction fee rate, default value is 1100
   ckbFeeRate?: bigint;
@@ -137,7 +137,7 @@ export interface BtcTimeCellsParams {
   btcTimeCells: IndexerCell[];
   // BTC Assets Api
   btcAssetsApi: BtcAssetsApi;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
   isMainnet: boolean;
   // The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
   btcTestnetType?: BTCTestnetType;
@@ -152,7 +152,7 @@ export interface SignBtcTimeCellsTxParams {
   collector: Collector;
   // The master CKB address to pay the time cells spent tx fee
   masterCkbAddress: Address;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
   isMainnet: boolean;
   // [u64; 2], filter cells by output capacity range, [inclusive, exclusive]
   outputCapacityRange?: Hex[];
@@ -184,7 +184,7 @@ export interface UpdateCkbTxWithRealBtcTxIdParams {
   ckbRawTx: CKBComponents.RawTransaction;
   // The BTC transaction id
   btcTxId: Hex;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
   isMainnet: boolean;
 }
 
@@ -234,7 +234,7 @@ export interface AppendIssuerCellToBtcBatchTransfer {
   ckbRawTx: CKBComponents.RawTransaction;
   // The sum capacity of the ckb inputs
   sumInputsCapacity: Hex;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet
   isMainnet: boolean;
   // The CKB transaction fee rate, default value is 1100
   ckbFeeRate?: bigint;
@@ -261,7 +261,7 @@ export interface RgbppLaunchCkbVirtualTxParams {
   launchAmount: bigint;
   // The RGBPP token info https://github.com/ckb-cell/unique-cell?tab=readme-ov-file#xudt-information
   rgbppTokenInfo: RgbppTokenInfo;
-  // True is for BTC and CKB Mainnet, flase is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
+  // True is for BTC and CKB Mainnet, false is for BTC and CKB Testnet(see btcTestnetType for details about BTC Testnet)
   isMainnet: boolean;
   // The Bitcoin Testnet type including Testnet3 and Signet, default value is Testnet3
   btcTestnetType?: BTCTestnetType;