BREAKING CHANGE: update tx_pool_info and get_transaction response (#696)

.changeset/chilly-lies-punch.md

@@ -0,0 +1,5 @@
+---
+"@ckb-lumos/base": minor
+---
+
+feat: update `TxPoolInfo` structure nervosnetwork/ckb#3894

.changeset/funny-foxes-fetch.md

@@ -0,0 +1,5 @@
+---
+"@ckb-lumos/base": minor
+---
+
+feat: update `TransactionWithStatus` structure nervosnetwork/ckb#4108

.changeset/good-donkeys-speak.md

@@ -0,0 +1,5 @@
+---
+"@ckb-lumos/rpc": minor
+---
+
+**BREAKING CHANGE**: update `txPoolInfo` response nervosnetwork/ckb#3894

.changeset/lucky-pillows-argue.md

@@ -0,0 +1,5 @@
+---
+"@ckb-lumos/rpc": minor
+---
+
+**BREAKING CHANGE**: update `get_transaction` response nervosnetwork/ckb#4108

packages/base/src/api.ts

@@ -97,6 +97,8 @@ export interface TransactionWithStatus<Tx = Transaction> {
   txStatus: TxStatus;
   timeAddedToPool: Uint64 | null;
   cycles: Uint64 | null;
+  fee: Uint64 | null;
+  minReplaceFee: Uint64 | null;
 }
 
 export interface Cell {
@@ -321,6 +323,9 @@ export interface TxPoolInfo {
   totalTxCycles: HexNumber;
   minFeeRate: HexNumber;
   lastTxsUpdatedAt: HexNumber;
+  minRbfRate: HexNumber;
+  maxTxPoolSize: HexNumber;
+  txSizeLimit: HexNumber;
 }
 
 export interface TxPoolIds {

packages/ckb-indexer/src/transaction_collector.ts

@@ -179,6 +179,8 @@ export class CKBIndexerTransactionCollector extends BaseIndexerModule.Transactio
         txStatus: tx.txStatus,
         cycles: tx.cycles,
         timeAddedToPool: tx.timeAddedToPool,
+        minReplaceFee: tx.minReplaceFee,
+        fee: tx.fee,
       })
     );
     return objects;

packages/ckb-indexer/tests/test_cases.js

@@ -7082,7 +7082,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction:  {
@@ -7120,7 +7122,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction:  {
@@ -7158,7 +7162,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction:  {
@@ -7196,7 +7202,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction:  {
@@ -7234,7 +7242,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction:  {
@@ -7272,7 +7282,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction: {
@@ -7310,7 +7322,9 @@ const transactionByLock = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
 ]
 
@@ -7398,7 +7412,9 @@ const transactionsByType = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   },
   {
     transaction:       {
@@ -7464,7 +7480,9 @@ const transactionsByType = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   }
 ];
 
@@ -7533,7 +7551,9 @@ const transactionsByLockAndType = [
       status: 'committed',
     },
     cycles: null,
-    timeAddedToPool: null
+    timeAddedToPool: null,
+    fee: null,
+    minReplaceFee: null
   }
 ];
 

packages/ckb-indexer/tests/transaction_collector.unit.test.ts

@@ -310,5 +310,7 @@ function mockTxWithStatus({
     txStatus: { status: "committed" },
     timeAddedToPool: null,
     cycles: null,
+    fee: null,
+    minReplaceFee: null,
   };
 }

packages/ckb-indexer/tests/transaction_collector_unit_test_case.ts

@@ -166,6 +166,8 @@ export const unresolvedTransaction: TransactionWithStatus = {
   },
   cycles: null,
   timeAddedToPool: null,
+  fee: null,
+  minReplaceFee: null,
 };
 export const unresolvedTransactionList: TransactionWithStatus[] = [
   unresolvedTransaction,
@@ -253,6 +255,8 @@ export const resolvedTransaction: TransactionWithStatus = {
   },
   cycles: null,
   timeAddedToPool: null,
+  fee: null,
+  minReplaceFee: null,
 };
 
 export const batchRequestTransaction = [

packages/hd-cache/tests/cache.test.ts

@@ -58,6 +58,8 @@ const mockTxs: TransactionWithStatus[] = [
     },
     timeAddedToPool: null,
     cycles: null,
+    fee: null,
+    minReplaceFee: null,
   },
   {
     transaction: {
@@ -124,6 +126,8 @@ const mockTxs: TransactionWithStatus[] = [
     },
     timeAddedToPool: null,
     cycles: null,
+    fee: null,
+    minReplaceFee: null,
   },
 ];
 const headerData = {

packages/rpc/src/resultFormatter.ts

@@ -243,6 +243,9 @@ const toTxPoolInfo = (info: RPC.TxPoolInfo): CKBComponents.TxPoolInfo => {
     total_tx_cycles: totalTxCycles,
     total_tx_size: totalTxSize,
     min_fee_rate: minFeeRate,
+    min_rbf_rate: minRbfRate,
+    tx_size_limit: txSizeLimit,
+    max_tx_pool_size: maxTxPoolSize,
     ...rest
   } = info;
   return {
@@ -252,6 +255,9 @@ const toTxPoolInfo = (info: RPC.TxPoolInfo): CKBComponents.TxPoolInfo => {
     totalTxCycles,
     totalTxSize,
     minFeeRate,
+    minRbfRate,
+    txSizeLimit,
+    maxTxPoolSize,
     ...rest,
   };
 };
@@ -326,6 +332,8 @@ const toTransactionWithStatus = <Tx>(
     transaction,
     tx_status: { block_hash: blockHash, status },
     time_added_to_pool,
+    min_replace_fee,
+    fee,
     ...rest
   } = txWithStatus;
   return {
@@ -338,6 +346,8 @@ const toTransactionWithStatus = <Tx>(
         : {}),
     },
     timeAddedToPool: time_added_to_pool,
+    minReplaceFee: min_replace_fee,
+    fee,
     ...rest,
   };
 };

packages/rpc/src/types/rpc.ts

@@ -129,6 +129,8 @@ export namespace RPC {
         };
     time_added_to_pool: Uint64 | null;
     cycles: Uint64 | null;
+    fee: Capacity | null;
+    min_replace_fee: Capacity | null;
   }
 
   export interface TransactionPoint {
@@ -236,6 +238,9 @@ export namespace RPC {
     tip_number: BlockNumber;
     total_tx_cycles: Cycles;
     total_tx_size: Size;
+    min_rbf_rate: Uint64;
+    tx_size_limit: Uint64;
+    max_tx_pool_size: Uint64;
   }
 
   export interface Epoch {

packages/testkit/src/mock-ckb-jsonrpc.ts

@@ -105,6 +105,8 @@ export function createCKBMockRPC(options: Options): Express {
         },
         time_added_to_pool: null,
         cycles: null,
+        min_replace_fee: null,
+        fee: null,
       };
     }
   );
@@ -140,7 +142,8 @@ export function createCKBMockRPC(options: Options): Express {
         if (jsonRPCResponse) {
           res.json(jsonRPCResponse);
         } else {
-          res.sendStatus(204);
+          const HTTP_NO_CONTENT = 204;
+          res.sendStatus(HTTP_NO_CONTENT);
         }
       });
     }

website/docs/migrations/migrate-to-v0.23.md

@@ -28,6 +28,24 @@ Please migrate to `loadFromKeystoreJson`
 + JSON.parse(fs.readFileSync(path).toString())
 ```
 
+### RPC `getTransaction`'s Response Has Been Updated
+
+```diff
+-min_replace_fee
++minReplaceFee
+```
+
+### RPC `get_`'s Response Has Been Updated
+
+```diff
+-min_rbf_rate
+-tx_size_limit
+-max_tx_pool_size
++minRbfRate
++txSizeLimit
++MaxTxPoolSize
+```
+
 ---
 
 ## Common Methods For CKB-Related Objects