@xyo-network/xl1-protocol-sdk 1.16.26 → 1.17.0

package/src/simple/block/SimpleBlockViewer.ts

@@ -0,0 +1,133 @@
+import type { CreatableParams, Hash } from '@xylabs/sdk-js'
+import {
+  AbstractCreatable,
+  assertEx,
+  spanRootAsync,
+} from '@xylabs/sdk-js'
+import type { ReadArchivist } from '@xyo-network/archivist-model'
+import {
+  asSignedHydratedBlockWithHashMeta,
+  asXL1BlockNumber,
+  type SignedHydratedBlockWithHashMeta, type XL1BlockNumber,
+} from '@xyo-network/xl1-protocol'
+
+import { hydrateBlock } from '../../block/index.ts'
+import type { ChainStoreRead, StakedChainContextRead } from '../../model/index.ts'
+import { findMostRecentBlock, hydratedBlockByNumber } from '../../primitives/index.ts'
+import { HydratedCache } from '../../utils/index.ts'
+import type { BlockViewer } from '../../viewers/index.ts'
+
+export interface SimpleBlockViewerParams extends CreatableParams {
+  context: StakedChainContextRead
+  finalizedArchivist?: ReadArchivist
+}
+
+export class SimpleBlockViewer extends AbstractCreatable<SimpleBlockViewerParams> implements BlockViewer {
+  private _signedHydratedBlockCache: HydratedCache<SignedHydratedBlockWithHashMeta> | undefined
+
+  get context(): StakedChainContextRead {
+    return this.params.context!
+  }
+
+  get finalizedArchivist(): ReadArchivist {
+    return this.params.finalizedArchivist!
+  }
+
+  static override async paramsHandler(params: Partial<SimpleBlockViewerParams>) {
+    assertEx(params.context, () => 'context is required')
+    assertEx(params.finalizedArchivist, () => 'finalizedArchivist is required')
+
+    return { ...await super.paramsHandler(params) }
+  }
+
+  async blockByHash(hash: Hash): Promise<SignedHydratedBlockWithHashMeta | null> {
+    return await spanRootAsync('blockByHash', async () => {
+      const cache = this.getHydratedBlockCache()
+      return await cache.get(hash)
+    }, this.tracer)
+  }
+
+  async blockByNumber(blockNumber: XL1BlockNumber): Promise<SignedHydratedBlockWithHashMeta | null> {
+    return await spanRootAsync('blockByNumber', async () => {
+      return asSignedHydratedBlockWithHashMeta(await hydratedBlockByNumber(this.context, blockNumber)) ?? null
+    }, this.tracer)
+  }
+
+  async blocksByHash(hash: Hash, limit = 50): Promise<SignedHydratedBlockWithHashMeta[]> {
+    return await spanRootAsync('blocksByHash', async () => {
+      assertEx(limit > 0, () => 'limit must be greater than 0')
+      assertEx(limit <= 100, () => 'limit must be less than 100')
+      const blocks: SignedHydratedBlockWithHashMeta[] = []
+      let current = await this.blockByHash(hash)
+      while (current && blocks.length < limit) {
+        blocks.push(current)
+        const previousHash = current[0].previous
+        if (previousHash === null) break
+        current = await this.blockByHash(previousHash)
+      }
+      return blocks.map(b => asSignedHydratedBlockWithHashMeta(b, true))
+    }, this.tracer)
+  }
+
+  async blocksByNumber(blockNumber: XL1BlockNumber, limit = 50): Promise<SignedHydratedBlockWithHashMeta[]> {
+    return await spanRootAsync('blocksByHash', async () => {
+      assertEx(limit > 0, () => 'limit must be greater than 0')
+      assertEx(limit <= 100, () => 'limit must be less than 100')
+      const blocks: SignedHydratedBlockWithHashMeta[] = []
+      let current = await this.blockByNumber(blockNumber)
+      while (current && blocks.length < limit) {
+        blocks.push(current)
+        if (current[0].block === 0) break
+        const previousNumber = asXL1BlockNumber(current[0].block - 1, true)
+        current = await this.blockByNumber(previousNumber)
+      }
+      return blocks.map(b => asSignedHydratedBlockWithHashMeta(b, true))
+    }, this.tracer)
+  }
+
+  async currentBlock(): Promise<SignedHydratedBlockWithHashMeta> {
+    return await spanRootAsync('currentBlock', async () => {
+      const currentHead = assertEx(await this.getCurrentHead(), () => 'Could not find most recent block')
+      const cache = this.getHydratedBlockCache()
+      const block = await cache.get(currentHead._hash)
+      if (!block) {
+        console.log(`Could not find current block with hash ${currentHead!._hash}`)
+      }
+      return assertEx(block, () => 'Could not find current block')
+    }, this.tracer)
+  }
+
+  async currentBlockHash(): Promise<Hash> {
+    return await spanRootAsync('currentBlockHash', async () => {
+      const currentHead = assertEx(await this.getCurrentHead(), () => 'Could not find most recent block')
+      return currentHead._hash
+    }, this.tracer)
+  }
+
+  async currentBlockNumber(): Promise<XL1BlockNumber> {
+    return await spanRootAsync('currentBlockNumber', async () => {
+      const currentHead = assertEx(await this.getCurrentHead(), () => 'Could not find most recent block')
+      return asXL1BlockNumber(currentHead.block, { name: 'currentBlockNumber' })
+    }, this.tracer)
+  }
+
+  protected async getCurrentHead() {
+    const chainArchivist = this.finalizedArchivist
+    return await findMostRecentBlock(chainArchivist)
+  }
+
+  protected getHydratedBlockCache(): HydratedCache<SignedHydratedBlockWithHashMeta> {
+    if (this._signedHydratedBlockCache) return this._signedHydratedBlockCache
+    const chainMap = this.context.store.chainMap
+    this._signedHydratedBlockCache = new HydratedCache<SignedHydratedBlockWithHashMeta>(chainMap, async (
+      { chainMap }: ChainStoreRead,
+      hash: Hash,
+      maxDepth?: number,
+      minDepth?: number,
+    ) => {
+      const result = await hydrateBlock({ chainMap }, hash, maxDepth, minDepth)
+      return asSignedHydratedBlockWithHashMeta(result, true)
+    }, 200)
+    return this._signedHydratedBlockCache
+  }
+}

package/src/simple/block/index.ts

@@ -0,0 +1 @@
+export * from './SimpleBlockViewer.ts'

package/src/simple/index.ts

@@ -1,4 +1,5 @@
 export * from './accountBalance/index.ts'
+export * from './block/index.ts'
 export * from './chainStake/index.ts'
 export * from './client/index.ts'
 export * from './datalake/index.ts'

package/src/utils/HydratedCache.ts

@@ -0,0 +1,38 @@
+import type { Hash } from '@xylabs/sdk-js'
+import type { Payload, WithStorageMeta } from '@xyo-network/payload-model'
+import { LRUCache } from 'lru-cache'
+
+import type { PayloadMapRead } from '../model/index.ts'
+
+export type HydrateFunction<T> = (
+  context: { chainMap: PayloadMapRead<WithStorageMeta<Payload>> },
+  hash: Hash,
+) => Promise<T | undefined>
+
+export class HydratedCache<T extends {}> {
+  protected readonly cache: LRUCache<Hash, T>
+  protected readonly chainMap: PayloadMapRead<WithStorageMeta<Payload>>
+  protected readonly hydrateFunction: HydrateFunction<T>
+
+  constructor(
+    chainMap: PayloadMapRead<WithStorageMeta<Payload>>,
+    hydrateFunction: HydrateFunction<T>,
+    maxSize: number = 200,
+  ) {
+    this.chainMap = chainMap
+    this.hydrateFunction = hydrateFunction
+    this.cache = new LRUCache<Hash, T>({ max: maxSize })
+  }
+
+  async get(hash: Hash): Promise<T | null> {
+    const existing = this.cache.get(hash)
+    if (existing !== undefined) return existing
+    const block = (await this.hydrateFunction({ chainMap: this.chainMap }, hash)) ?? null
+    if (block !== null) this.cache.set(hash, block)
+    return block
+  }
+
+  has(hash: Hash): boolean {
+    return this.cache.has(hash)
+  }
+}

package/src/utils/index.ts

@@ -1 +1,2 @@
+export * from './HydratedCache.ts'
 export * from './isZodError.ts'

package/src/viewers/Block.ts

@@ -1,14 +1,15 @@
 import type { Hash, Promisable } from '@xylabs/sdk-js'
 import type { SignedHydratedBlockWithHashMeta, XL1BlockNumber } from '@xyo-network/xl1-protocol'
 
-export interface BlockViewierMethods {
-  blockByHash(hash: Hash): Promisable<SignedHydratedBlockWithHashMeta | null>
-  blockByNumber(block: XL1BlockNumber): Promisable<SignedHydratedBlockWithHashMeta | null>
+export interface BlockViewerMethods {
   blocksByHash(hash: Hash, limit?: number): Promisable<SignedHydratedBlockWithHashMeta[]>
-
+  blocksByNumber(block: XL1BlockNumber, limit?: number): Promisable<SignedHydratedBlockWithHashMeta[]>
   currentBlock(): Promisable<SignedHydratedBlockWithHashMeta>
+}
+
+export interface BlockViewer extends BlockViewerMethods {
+  blockByHash(hash: Hash): Promisable<SignedHydratedBlockWithHashMeta | null>
+  blockByNumber(block: XL1BlockNumber): Promisable<SignedHydratedBlockWithHashMeta | null>
   currentBlockHash(): Promisable<Hash>
   currentBlockNumber(): Promisable<XL1BlockNumber>
 }
-
-export interface BlockViewer extends BlockViewierMethods {}

package/src/viewers/Chain.ts

@@ -4,3 +4,5 @@ import type { ChainId } from '@xyo-network/xl1-protocol'
 export interface ChainViewerMethods {
   chainId(): Promisable<ChainId>
 }
+
+export interface ChainViewer extends ChainViewerMethods {}

package/src/{provider/viewer → viewers}/StepViewer.ts

@@ -1,8 +1,8 @@
 import type { Address, Promisable } from '@xylabs/sdk-js'
 import type { PositionId, StepIdentity } from '@xyo-network/xl1-protocol'
 
-import type { Position } from '../../model/index.ts'
-import type { NetworkStakeStepRewardsViewer } from './NetworkStake/index.ts'
+import type { Position } from '../model/index.ts'
+import type { NetworkStakeStepRewardsViewer } from '../provider/index.ts'
 
 export interface PagedPositionsOptions {
   cursor?: PositionId

package/src/viewers/index.ts

@@ -9,6 +9,7 @@ export * from './Stake.ts'
 export * from './StakeEvents.ts'
 export * from './StakeTotals.ts'
 export * from './StepStake.ts'
+export * from './StepViewer.ts'
 export * from './TimeSync.ts'
 export * from './Transaction.ts'
 export * from './TransferBalance.ts'

package/dist/neutral/provider/viewer/StepViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StepViewer.d.ts","sourceRoot":"","sources":["../../../../src/provider/viewer/StepViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAEzE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAA;AAE5E,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAGhC,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAErD,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;IAGtF,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAGlD,KAAK,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAG7C,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;IAEnD,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IAGjF,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;CACxE;AAED,MAAM,WAAW,UAAW,SAAQ,iBAAiB;IACnD,OAAO,CAAC,EAAE,6BAA6B,CAAA;CACxC"}