@xyo-network/xl1-rpc 1.18.3 → 1.18.4

package/src/provider/viewer/JsonRpcBlockViewer/JsonRpcBlockViewerMethods.ts

@@ -3,7 +3,9 @@ import {
   asAnyPayload,
   asHashMeta, type Payload, type WithHashMeta,
 } from '@xyo-network/payload-model'
-import type { SignedHydratedBlockWithHashMeta, XL1BlockNumber } from '@xyo-network/xl1-protocol'
+import type {
+  BlockRate, Count, SignedHydratedBlockWithHashMeta, StepIndex, TimeDurations, XL1BlockNumber, XL1BlockRange,
+} from '@xyo-network/xl1-protocol'
 import { type BlockViewerMethods, BlockViewerMoniker } from '@xyo-network/xl1-protocol-sdk'
 
 import { BlockViewerRpcSchemas } from '../../../types/index.ts'
@@ -43,6 +45,20 @@ export class JsonRpcBlockViewerMethods extends AbstractJsonRpcViewer<BlockViewer
     return result.map(p => asHashMeta(p, true)).map(p => asAnyPayload(p, { required: true }))
   }
 
+  async rate(range: XL1BlockRange, timeUnit?: keyof TimeDurations): Promise<BlockRate> {
+    return await this.transport.sendRequest(
+      'blockViewer_rate',
+      [range, timeUnit],
+    )
+  }
+
+  async stepSizeRate(start: XL1BlockNumber, stepSizeIndex: StepIndex, count?: Count, timeUnit?: keyof TimeDurations): Promise<BlockRate> {
+    return await this.transport.sendRequest(
+      'blockViewer_stepSizeRate',
+      [start, stepSizeIndex, count, timeUnit],
+    )
+  }
+
   protected schemas() {
     return BlockViewerRpcSchemas
   }

package/src/provider/viewer/JsonRpcXyoViewer.ts

@@ -1,15 +1,20 @@
-import type { Address, Hash } from '@xylabs/sdk-js'
+import type {
+  Address, Hash, Promisable,
+} from '@xylabs/sdk-js'
 import { Signed } from '@xyo-network/boundwitness-model'
 import type {
   AttoXL1,
   BlockBoundWitnessWithHashMeta,
+  BlockRate,
   ChainId,
   HydratedBlock,
   SignedHydratedBlockWithHashMeta,
   SignedHydratedTransaction,
   StepIdentity,
   StepIdentityString,
+  TimeDurations,
   XL1BlockNumber,
+  XL1BlockRange,
 } from '@xyo-network/xl1-protocol'
 import {
   isSignedHydratedBlock, isSignedHydratedBlockWithHashMeta,
@@ -248,6 +253,10 @@ export class JsonRpcXyoViewer extends AbstractJsonRpcViewer<XyoViewerRpcSchemas,
     )).map(p => toWithHashMeta(p, true)))
   }
 
+  async rate(range: XL1BlockRange, timeUnit?: keyof TimeDurations): Promise<BlockRate> {
+    return await this.block.rate(range, timeUnit)
+  }
+
   async stakeById(id: number): Promise<Position> {
     return (await this.transport.sendRequest('xyoViewer_stakeById', [id]))
   }
@@ -264,6 +273,10 @@ export class JsonRpcXyoViewer extends AbstractJsonRpcViewer<XyoViewerRpcSchemas,
     return (await this.transport.sendRequest('xyoViewer_stakesByStaker', [staker]))
   }
 
+  async stepSizeRate(start: XL1BlockNumber, stepIndex: number, count?: number, timeUnit?: keyof TimeDurations): Promise<BlockRate> {
+    return await this.block.stepSizeRate(start, stepIndex, count, timeUnit)
+  }
+
   async transactionByBlockHashAndIndex(blockHash: Hash, transactionIndex: number): Promise<SignedHydratedTransaction | null> {
     return (await this.transport.sendRequest('xyoViewer_transactionByBlockHashAndIndex', [blockHash, transactionIndex])) as SignedHydratedTransaction | null
   }

package/src/types/schema/BlockViewerRpcSchemas.ts

@@ -1,6 +1,9 @@
 import { HashZod } from '@xylabs/sdk-js'
 import { PayloadZodLoose } from '@xyo-network/payload-model'
-import { SignedHydratedBlockWithHashMetaZod, XL1BlockNumberZod } from '@xyo-network/xl1-protocol'
+import {
+  BlockRangeZod,
+  BlockRateZod, CountZod, SignedHydratedBlockWithHashMetaZod, StepIndexZod, TimeDurationsZod, XL1BlockNumberZod,
+} from '@xyo-network/xl1-protocol'
 import { z } from 'zod'
 
 import type { BlockViewerRpcMethodName } from '../BlockViewerRpc.ts'
@@ -47,6 +50,26 @@ export const BlockViewerRpcSchemas = {
       from: z.array(PayloadZodLoose),
     },
   },
+  blockViewer_rate: {
+    params: {
+      to: z.tuple([BlockRangeZod, TimeDurationsZod.keyof().optional()]),
+      from: z.tuple([BlockRangeZod, TimeDurationsZod.keyof().optional()]),
+    },
+    result: {
+      to: BlockRateZod,
+      from: BlockRateZod,
+    },
+  },
+  blockViewer_stepSizeRate: {
+    params: {
+      to: z.tuple([XL1BlockNumberZod, StepIndexZod, CountZod.optional(), TimeDurationsZod.keyof().optional()]),
+      from: z.tuple([BlockRateZod]),
+    },
+    result: {
+      to: BlockRateZod,
+      from: BlockRateZod,
+    },
+  },
 } satisfies RpcSchemaMap<BlockViewerRpcMethodName>
 
 export type BlockViewerRpcSchemas = typeof BlockViewerRpcSchemas

package/src/types/schema/XyoViewerRpcSchemas.ts

@@ -4,8 +4,13 @@ import {
 } from '@xylabs/sdk-js'
 import { PayloadZodLoose } from '@xyo-network/payload-model'
 import {
+  BlockRangeZod,
+  BlockRateZod,
+  CountZod,
   JsonToStakeZod, SignedHydratedBlockWithHashMetaZod,
   SignedHydratedTransactionZod, StakeToJsonZod, StepIdentityZod,
+  StepIndexZod,
+  TimeDurationsZod,
   XL1BlockNumberZod, XL1BlockRangeZod,
 } from '@xyo-network/xl1-protocol'
 import { AccountBalanceHistoryItemZod } from '@xyo-network/xl1-protocol-sdk'
@@ -335,6 +340,26 @@ export const XyoViewerRpcSchemas = {
       from: z.array(PayloadZodLoose),
     },
   },
+  xyoViewer_rate: {
+    params: {
+      to: z.tuple([BlockRangeZod, TimeDurationsZod.keyof().optional()]),
+      from: z.tuple([BlockRangeZod, TimeDurationsZod.keyof().optional()]),
+    },
+    result: {
+      to: BlockRateZod,
+      from: BlockRateZod,
+    },
+  },
+  xyoViewer_stepSizeRate: {
+    params: {
+      to: z.tuple([XL1BlockNumberZod, StepIndexZod, CountZod.optional(), TimeDurationsZod.keyof().optional()]),
+      from: z.tuple([BlockRateZod]),
+    },
+    result: {
+      to: BlockRateZod,
+      from: BlockRateZod,
+    },
+  },
 } satisfies RpcSchemaMap<XyoViewerRpcMethodName>
 
 export type XyoViewerRpcSchemas = typeof XyoViewerRpcSchemas