fix getBlockHash & add chain_getHead alias (#441)

* add chain_getHead alias * support multiple hash fetch * handle null
AcalaNetwork · Oct 14, 2023 · 6962e7b · 6962e7b
1 parent d319a35
commit 6962e7b
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 10 deletions.
diff --git a/packages/chopsticks/src/rpc/substrate/chain.ts b/packages/chopsticks/src/rpc/substrate/chain.ts
@@ -11,16 +11,19 @@ const processHeader = (header: Header) => {
 
 /**
  * @param context
- * @param params - [`blockNumber`]
+ * @param params - [`blockNumber` | `blockNumber[]` | null]
  *
- * @return Block hash
+ * @return Block hash | hash[] | null
  */
-export const chain_getBlockHash: Handler<[number], HexString> = async (context, [blockNumber]) => {
-  const block = await context.chain.getBlockAt(blockNumber)
-  if (!block) {
-    throw new ResponseError(1, `Block #${blockNumber} not found`)
-  }
-  return block.hash
+export const chain_getBlockHash: Handler<[number | number[] | null], HexString | (HexString | null)[] | null> = async (
+  context,
+  [blockNumber],
+) => {
+  const numbers = Array.isArray(blockNumber) ? blockNumber : [blockNumber]
+  const hashes = await Promise.all(numbers.map((n) => context.chain.getBlockAt(n))).then((blocks) =>
+    blocks.map((b) => b?.hash || null),
+  )
+  return Array.isArray(blockNumber) ? hashes : hashes[0]
 }
 
 /**
@@ -103,6 +106,7 @@ export const chain_unsubscribeNewHead: Handler<[string], void> = async (_context
   unsubscribe(subid)
 }
 
+export const chain_getHead = chain_getBlockHash
 export const chain_subscribeNewHeads = chain_subscribeNewHead
 export const chain_unsubscribeNewHeads = chain_unsubscribeNewHead
 export const chain_unsubscribeFinalizedHeads = chain_unsubscribeNewHead
diff --git a/packages/core/src/blockchain/index.ts b/packages/core/src/blockchain/index.ts
@@ -216,8 +216,8 @@ export class Blockchain {
   /**
    * Get block by number.
    */
-  async getBlockAt(number?: number): Promise<Block | undefined> {
-    if (number === undefined) {
+  async getBlockAt(number?: number | null): Promise<Block | undefined> {
+    if (number === null || number === undefined) {
       return this.head
     }
     if (number > this.#head.number) {

diff --git a/packages/e2e/src/chain.test.ts b/packages/e2e/src/chain.test.ts
@@ -14,6 +14,16 @@ describe('chain rpc', () => {
     expectHex(await api.rpc.chain.getBlockHash(0)).toMatch(hash0)
     expectHex(await api.rpc.chain.getBlockHash(1000)).toMatch(hash1000)
 
+    expect(await api.rpc('chain_getHead')).toEqual(hashHead)
+    expect(await api.rpc('chain_getBlockHash', null)).toEqual(hashHead)
+    expect(await api.rpc('chain_getBlockHash', undefined)).toEqual(hashHead)
+    expect(await api.rpc('chain_getBlockHash', [null])).toEqual(expect.arrayContaining([hashHead]))
+    expect(await api.rpc('chain_getBlockHash', [undefined])).toEqual(expect.arrayContaining([hashHead]))
+    expect(await api.rpc('chain_getBlockHash', [0, 1000])).toEqual(expect.arrayContaining([hash0, hash1000]))
+    expect(await api.rpc('chain_getBlockHash', [0, undefined, null])).toEqual(
+      expect.arrayContaining([hash0, hashHead, hashHead]),
+    )
+
     expectJson(await api.rpc.chain.getHeader()).toMatchSnapshot()
     expectJson(await api.rpc.chain.getHeader(hashHead)).toMatchSnapshot()
     expectJson(await api.rpc.chain.getHeader(hash0)).toMatchSnapshot()