feat(rpc): support withCycle for getBlock

ckb-js · Sep 25, 2023 · dea17ab · dea17ab
1 parent 1e8389b
commit dea17ab
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 12 deletions.
diff --git a/packages/rpc/src/Base/index.ts b/packages/rpc/src/Base/index.ts
@@ -21,6 +21,22 @@ export const rpcProperties: RpcPropertes = {
   // skip subscription
 };
 
+/**
+ * - `0x0`: without verbosity, returns the raw serialized block bytes
+ * - `0x2`: with verbosity, returns the serialized block JSON object
+ * - `null`: default value, the same with `0x2`
+ */
+export type GetBlockVerbosityOptions = "0x0" | "0x2" | null;
+export type GetBlockWithCycleOptions = boolean | null;
+export type VerbosityBlock<Verbosity extends GetBlockVerbosityOptions> =
+  Verbosity extends "0x0" ? string : CKBComponents.BlockView;
+export type BlockResponse<
+  Verbosity extends GetBlockVerbosityOptions,
+  WithCycle extends GetBlockWithCycleOptions
+> = WithCycle extends true
+  ? { block: VerbosityBlock<Verbosity>; cycles: CKBComponents.UInt64 }
+  : VerbosityBlock<Verbosity>;
+
 // prettier-ignore
 export interface GetTransaction {
   (hash: CKBComponents.Hash): Promise<CKBComponents.TransactionWithStatus>;
@@ -86,10 +102,19 @@ export interface Base {
    * @method getBlock
    * @memberof DefaultRPC
    * @description rpc to get block by its hash
-   * @param {string} hash - the block hash of the target block
-   * @returns {Promise<object>} block object
+   * @param {string} hash
+   * @param {string} verbosity
+   * @param {boolean} withCycle
+   * @return {Promise<BlockResponse | null>}
    */
-  getBlock: (hash: CKBComponents.Hash) => Promise<CKBComponents.Block>;
+  getBlock<
+    V extends GetBlockVerbosityOptions = null,
+    C extends GetBlockWithCycleOptions = null
+  >(
+    hash: CKBComponents.Hash,
+    verbosity?: V,
+    withCycle?: C
+  ): Promise<BlockResponse<V, C> | null>;
 
   /**
    * @method getHeader
@@ -191,13 +216,20 @@ export interface Base {
   /**
    * @method getBlockByNumber
    * @memberof DefaultRPC
-   * @description rpc to get block by its number
-   * @param {string} number - the block number of the target block
-   * @returns {Promise<object>} block object
-   */
-  getBlockByNumber: (
-    number: CKBComponents.BlockNumber | bigint
-  ) => Promise<CKBComponents.Block>;
+   * @description rpc to get block by its hash
+   * @param {CKBComponents.BlockNumber | bigint} number
+   * @param {string} verbosity
+   * @param {boolean} withCycle
+   * @return {Promise<BlockResponse | null>}
+   */
+  getBlockByNumber<
+    V extends GetBlockVerbosityOptions = null,
+    C extends GetBlockWithCycleOptions = null
+  >(
+    number: CKBComponents.BlockNumber | bigint,
+    verbosity?: V,
+    withCycle?: C
+  ): Promise<BlockResponse<V, C> | null>;
 
   /* Experimental */
 

diff --git a/packages/rpc/src/resultFormatter.ts b/packages/rpc/src/resultFormatter.ts
@@ -138,7 +138,10 @@ const toTip = (tip: RPC.Tip): CKBComponents.Tip => ({
   blockNumber: tip.block_number,
 });
 
-const toBlock = (block: RPC.Block): CKBComponents.Block => {
+function toBlock(block: string): string;
+function toBlock(block: RPC.Block): CKBComponents.Block;
+function toBlock(block: string | RPC.Block): CKBComponents.Block | string {
+  if (typeof block === "string") return block;
   if (!block) return block;
   const { header, uncles = [], transactions = [], ...rest } = block;
   return {
@@ -147,7 +150,8 @@ const toBlock = (block: RPC.Block): CKBComponents.Block => {
     transactions: transactions.map(toTransaction),
     ...rest,
   };
-};
+}
+
 const toAlertMessage = (
   alertMessage: RPC.AlertMessage
 ): CKBComponents.AlertMessage => {