feat(rpc): support get_header with verbosity

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

Hide file tree

Showing 3 changed files with 18 additions and 9 deletions.
diff --git a/packages/rpc/src/Base/index.ts b/packages/rpc/src/Base/index.ts
@@ -29,6 +29,12 @@ export interface GetTransaction {
   (hash: CKBComponents.Hash, verbosity: "0x2", onlyCommitted?: boolean): Promise<CKBComponents.TransactionWithStatus>;
 }
 
+// prettier-ignore
+export interface GetHeader<Q> {
+  (query: Q, verbosity?: "0x1"): Promise<CKBComponents.BlockHeader>;
+  (query: Q, verbosity: "0x0"): Promise<string>;
+}
+
 export interface Base {
   /* Chain */
 
@@ -91,19 +97,15 @@ export interface Base {
    * @description Returns the information about a block header by hash.
    * @params {Promise<string>} block hash
    */
-  getHeader: (
-    blockHash: CKBComponents.Hash
-  ) => Promise<CKBComponents.BlockHeader>;
+  getHeader: GetHeader<CKBComponents.Hash>;
 
   /**
    * @method getHeaderByNumber
    * @memberof DefaultRPC
    * @description Returns the information about a block header by block number
    * @params {Promise<string>} block number
    */
-  getHeaderByNumber: (
-    blockNumber: CKBComponents.BlockNumber | bigint
-  ) => Promise<CKBComponents.BlockHeader>;
+  getHeaderByNumber: GetHeader<CKBComponents.BlockNumber | bigint>;
 
   /**
    * @method getLiveCell

diff --git a/packages/rpc/src/resultFormatter.ts b/packages/rpc/src/resultFormatter.ts
@@ -24,7 +24,13 @@ const toNullable =
 const toNumber = (number: RPC.BlockNumber): CKBComponents.BlockNumber =>
   number.toString();
 const toHash = (hash: RPC.Hash256): CKBComponents.Hash256 => hash;
-const toHeader = (header: RPC.Header): CKBComponents.BlockHeader => {
+
+function toHeader(header: RPC.Header): CKBComponents.BlockHeader;
+function toHeader(header: string): string;
+function toHeader(
+  header: string | RPC.Header
+): string | CKBComponents.BlockHeader {
+  if (typeof header === "string") return header;
   if (!header) return header;
   const {
     compact_target: compactTarget,
@@ -42,7 +48,8 @@ const toHeader = (header: RPC.Header): CKBComponents.BlockHeader => {
     extraHash,
     ...rest,
   };
-};
+}
+
 const toScript = (script: RPC.Script): CKBComponents.Script => {
   if (!script) return script;
   const { code_hash: codeHash, hash_type: hashType, ...rest } = script;

diff --git a/packages/rpc/src/types/api.ts b/packages/rpc/src/types/api.ts
@@ -74,7 +74,7 @@ export namespace CKBComponents {
   export type Transaction = Required<api.Transaction>;
   export type TransactionWithStatus<Tx = Transaction> =
     api.TransactionWithStatus<Tx>;
-  export type BlockHeader = api.Header;
+  export type BlockHeader<T = api.Header> = T;
   export type Block = api.Block;
   export type UncleBlock = api.UncleBlock;
   export type LiveCell = api.LiveCell;