feat: add minimumValidityBlocks to chainstate response (#1194)

* feat: add minimumValidityBlocks to chainstate response

* test: cover with spec

---------

Co-authored-by: Gergely Békési <gergely.bekesi@ethswarm.org>

Author: slapec93

package-lock.json

@@ -69,7 +69,8 @@
     "debug": "^4.4.1",
     "isomorphic-ws": "^4.0.1",
     "semver": "^7.3.5",
-    "ws": "^8.20.1"
+    "ws": "^8.20.1",
+    "zod": "^4.4.3"
   },
   "devDependencies": {
     "@babel/cli": "^7.19.3",

package.json

@@ -1,5 +1,6 @@
 import { Types } from 'cafe-utility'
 import { BeeRequestOptions, ChainState, ReserveState, WalletBalance } from '../../types'
+import { GetChainStateResponse } from '../../types/schema'
 import { http } from '../../utils/http'
 import { BZZ, DAI } from '../../utils/tokens'
 import { asNumberString } from '../../utils/type'
@@ -44,13 +45,14 @@ export async function getChainState(requestOptions: BeeRequestOptions): Promise<
     responseType: 'json',
   })
 
-  const body = Types.asObject(response.data, { name: 'response.data' })
+  const body = GetChainStateResponse.parse(response.data)
 
   return {
-    block: Types.asNumber(body.block, { name: 'block' }),
-    chainTip: Types.asNumber(body.chainTip, { name: 'chainTip' }),
-    totalAmount: asNumberString(body.totalAmount, { name: 'totalAmount' }),
-    currentPrice: normalizeCurrentPrice(Types.asNumber(body.currentPrice, { name: 'currentPrice' })),
+    block: body.block,
+    chainTip: body.chainTip,
+    totalAmount: body.totalAmount,
+    currentPrice: normalizeCurrentPrice(body.currentPrice),
+    minimumValidityBlocks: body.minimumValidityBlocks,
   }
 }
 

src/modules/debug/states.ts

@@ -264,6 +264,7 @@ export interface ChainState {
   block: number
   totalAmount: NumberString
   currentPrice: number
+  minimumValidityBlocks?: number
 }
 
 export interface WalletBalance {

src/types/debug.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod'
+import { asNumberString } from '../utils/type'
+
+export const GetChainStateResponse = z.object({
+  chainTip: z.number(),
+  block: z.number(),
+  totalAmount: z.string().transform(s => asNumberString(s, { name: 'totalAmount' })),
+  currentPrice: z.string().transform(Number),
+  minimumValidityBlocks: z.number().optional(),
+})

src/types/schema.ts

@@ -31,6 +31,7 @@ test('GET chain state', async () => {
   expect(chainState.block).toBeGreaterThan(300)
   expect(parseInt(chainState.totalAmount)).not.toBeNaN()
   expect(chainState.currentPrice).toBe(24000)
+  expect(chainState.minimumValidityBlocks).toBeGreaterThan(0)
 })
 
 test('GET redistribution state', async () => {