@xyo-network/xl1-providers 1.26.12 → 1.26.13

package/src/SimpleStepRewards/primitives/networkStakeStepRewardEarnedForStaker.ts

@@ -1,45 +0,0 @@
-import type { Address } from '@xylabs/sdk-js'
-import type {
-  BlockViewer,
-  CachingContext,
-  StakeViewer,
-  StepIdentity,
-  XL1RangeMultipliers,
-} from '@xyo-network/xl1-protocol-lib'
-import { XYO_NETWORK_STAKING_ADDRESS } from '@xyo-network/xl1-protocol-lib'
-import {
-  toStepIdentityString,
-  withContextCacheResponse,
-} from '@xyo-network/xl1-protocol-sdk'
-
-import { networkStakeStepRewardEarnedForPosition } from './networkStakeStepRewardEarnedForPosition.ts'
-
-/** Calculates the total step reward earned by a specific staker across all their network staking positions. */
-export async function networkStakeStepRewardEarnedForStaker(
-  context: CachingContext,
-  blockViewer: BlockViewer,
-  stakeViewer: StakeViewer,
-  stepIdentity: StepIdentity,
-  staker: Address,
-  rewardMultipliers: XL1RangeMultipliers = {},
-): Promise<[bigint, bigint]> {
-  const stepId = toStepIdentityString(stepIdentity)
-  return await withContextCacheResponse(context, 'networkStakeStepRewardEarnedForStaker', `${stepId}-${staker}`, async () => {
-    const positions = (await stakeViewer.stakesByStaker(staker)).filter(pos => pos.staked === XYO_NETWORK_STAKING_ADDRESS)
-    const results = await Promise.all(positions.map((pos) => {
-      return networkStakeStepRewardEarnedForPosition(
-        context,
-        blockViewer,
-        stakeViewer.stakeEvents,
-        stepIdentity,
-        pos,
-        rewardMultipliers,
-      )
-    }))
-
-    const numerator = results.reduce((acc, [positionReward]) => acc + positionReward, 0n)
-
-    const result: [bigint, bigint] = results.length > 0 ? [numerator, results[0][1]] : [0n, 0n]
-    return result
-  })
-}

package/src/SimpleStepViewer.ts

@@ -1,104 +0,0 @@
-import {
-  type Address,
-  type Promisable,
-} from '@xylabs/sdk-js'
-import {
-  BlockViewer,
-  BlockViewerMoniker,
-  NetworkStakeStepRewardsViewer,
-  NetworkStakeStepRewardsViewerMoniker,
-  PagedPositionsOptions,
-  PagedStakersOptions,
-  Position,
-  type PositionId, StakeEventsViewer, StakeEventsViewerMoniker, StakeViewer, StakeViewerMoniker, type StepIdentity, StepViewer, StepViewerMoniker,
-} from '@xyo-network/xl1-protocol-lib'
-import {
-  AbstractCreatableProvider,
-  creatableProvider,
-  CreatableProviderParams,
-  externalBlockRangeFromStep,
-} from '@xyo-network/xl1-protocol-sdk'
-
-/** Configuration params for SimpleStepViewer. */
-export interface SimpleStepViewerParams extends CreatableProviderParams {
-
-}
-
-/** Provider for viewing step-level staking data including positions, rewards, and stake weights. */
-@creatableProvider()
-export class SimpleStepViewer extends AbstractCreatableProvider<SimpleStepViewerParams> implements StepViewer {
-  static readonly defaultMoniker = StepViewerMoniker
-
-  static readonly dependencies = [
-    BlockViewerMoniker,
-    NetworkStakeStepRewardsViewerMoniker,
-    StakeViewerMoniker,
-    StakeEventsViewerMoniker,
-  ]
-
-  static readonly monikers = [StepViewerMoniker]
-  moniker = SimpleStepViewer.defaultMoniker
-
-  private _blockViewer?: BlockViewer
-  private _networkStakeStepRewardsViewer?: NetworkStakeStepRewardsViewer
-  private _stakeEventsViewer?: StakeEventsViewer
-  private _stakeViewer?: StakeViewer
-
-  get rewards() {
-    return this._networkStakeStepRewardsViewer!
-  }
-
-  protected get blockViewer() {
-    return this._blockViewer!
-  }
-
-  protected get stakeEventsViewer() {
-    return this._stakeEventsViewer!
-  }
-
-  protected get stakeViewer() {
-    return this._stakeViewer!
-  }
-
-  override async createHandler() {
-    await super.createHandler()
-    this._blockViewer = await this.locator.getInstance<BlockViewer>(BlockViewerMoniker)
-    this._networkStakeStepRewardsViewer = await this.locator.getInstance<NetworkStakeStepRewardsViewer>(NetworkStakeStepRewardsViewerMoniker)
-    this._stakeViewer = await this.locator.getInstance<StakeViewer>(StakeViewerMoniker)
-    this._stakeEventsViewer = await this.locator.getInstance<StakeEventsViewer>(StakeEventsViewerMoniker)
-  }
-
-  async positionCount(step: StepIdentity): Promise<number> {
-    const externalRange = await externalBlockRangeFromStep(this.context, this.blockViewer, step)
-    const positionCount = await this.stakeEventsViewer.positionCount(externalRange)
-    return positionCount
-  }
-
-  // TODO: Implement paging
-  async positions(step: StepIdentity, _options?: PagedPositionsOptions): Promise<Position[]> {
-    const count = await this.positionCount(step)
-    const externalRange = await externalBlockRangeFromStep(this.context, this.blockViewer, step)
-    const allPositions = await Promise.all(Array.from({ length: count + 1 }, (_, i) => i).map(id => this.stakeViewer.stakeById(id)))
-    return allPositions.filter(pos => pos.addBlock <= externalRange[1] && (pos.removeBlock === 0 || pos.removeBlock > externalRange[0]))
-  }
-
-  randomizer(_step: StepIdentity): Promisable<bigint> {
-    throw new Error('Method [randomizer] not implemented.')
-  }
-
-  stake(_step: StepIdentity): Promisable<bigint> {
-    throw new Error('Method [stake] not implemented.')
-  }
-
-  stakerCount(_step: StepIdentity): Promisable<number> {
-    throw new Error('Method [stakerCount] not implemented.')
-  }
-
-  stakers(_step: StepIdentity, _options?: PagedStakersOptions): Promisable<Address[]> {
-    throw new Error('Method [stakers] not implemented.')
-  }
-
-  weight(_step: StepIdentity, _positionId?: PositionId): Promisable<bigint> {
-    throw new Error('Method [weight] not implemented.')
-  }
-}

package/src/SimpleXyoConnectionRunner.ts

@@ -1,54 +0,0 @@
-import { XyoViewer, XyoViewerMoniker } from '@xyo-network/xl1-protocol-lib'
-import {
-  type DataLakeRunner, DataLakeRunnerMoniker, type DataLakeViewer, DataLakeViewerMoniker,
-  type XyoConnection, XyoConnectionMoniker, type XyoNetwork, type XyoRunner, XyoRunnerMoniker,
-} from '@xyo-network/xl1-protocol-lib'
-import {
-  AbstractCreatableProvider, creatableProvider,
-  CreatableProviderParams,
-} from '@xyo-network/xl1-protocol-sdk'
-
-/** Configuration params for SimpleXyoConnectionRunner. */
-export interface SimpleXyoConnectionRunnerParams extends CreatableProviderParams {
-
-}
-
-/** XYO connection provider with both runner (write) and viewer (read) capabilities. */
-@creatableProvider()
-export class SimpleXyoConnectionRunner<TParams extends SimpleXyoConnectionRunnerParams = SimpleXyoConnectionRunnerParams> extends
-  AbstractCreatableProvider<TParams> implements XyoConnection {
-  static readonly defaultMoniker = XyoConnectionMoniker
-  static readonly dependencies = [XyoRunnerMoniker, XyoViewerMoniker]
-  static readonly monikers = [XyoConnectionMoniker]
-  moniker = SimpleXyoConnectionRunner.defaultMoniker
-
-  protected _network?: XyoNetwork
-  protected _runner?: XyoRunner
-  protected _storage?: DataLakeRunner | DataLakeViewer
-  protected _viewer?: XyoViewer
-
-  get network(): XyoNetwork | undefined {
-    return this._network
-  }
-
-  get runner(): XyoRunner | undefined {
-    return this._runner
-  }
-
-  get storage(): DataLakeRunner | DataLakeViewer | undefined {
-    return this._storage
-  }
-
-  get viewer(): XyoViewer | undefined {
-    return this._viewer
-  }
-
-  override async createHandler() {
-    await super.createHandler()
-    this._runner = await this.locator.getInstance<XyoRunner>(XyoRunnerMoniker)
-    this._viewer = await this.locator.getInstance<XyoViewer>(XyoViewerMoniker)
-    const dataLakeRunner = await this.locator.tryGetInstance<DataLakeRunner>(DataLakeRunnerMoniker)
-    const dataLakeViewer = await this.locator.tryGetInstance<DataLakeViewer>(DataLakeViewerMoniker)
-    this._storage = dataLakeRunner ?? dataLakeViewer
-  }
-}

package/src/SimpleXyoConnectionViewer.ts

@@ -1,47 +0,0 @@
-import { XyoViewer, XyoViewerMoniker } from '@xyo-network/xl1-protocol-lib'
-import {
-  type DataLakeViewer, DataLakeViewerMoniker,
-  type XyoConnection, XyoConnectionMoniker, type XyoNetwork,
-} from '@xyo-network/xl1-protocol-lib'
-import {
-  AbstractCreatableProvider, creatableProvider,
-  CreatableProviderParams,
-} from '@xyo-network/xl1-protocol-sdk'
-
-/** Configuration params for SimpleXyoConnectionViewer. */
-export interface SimpleXyoConnectionViewerParams extends CreatableProviderParams {
-
-}
-
-/** Read-only XYO connection provider with viewer and optional data lake capabilities. */
-@creatableProvider()
-export class SimpleXyoConnectionViewer<TParams extends SimpleXyoConnectionViewerParams = SimpleXyoConnectionViewerParams> extends
-  AbstractCreatableProvider<TParams> implements XyoConnection {
-  static readonly defaultMoniker = XyoConnectionMoniker
-  static readonly dependencies = [XyoViewerMoniker]
-  static readonly monikers = [XyoConnectionMoniker]
-  moniker = SimpleXyoConnectionViewer.defaultMoniker
-
-  protected _network?: XyoNetwork
-  protected _storage?: DataLakeViewer
-  protected _viewer?: XyoViewer
-
-  get network(): XyoNetwork | undefined {
-    return this._network
-  }
-
-  get storage(): DataLakeViewer | undefined {
-    return this._storage
-  }
-
-  get viewer(): XyoViewer | undefined {
-    return this._viewer
-  }
-
-  override async createHandler() {
-    await super.createHandler()
-    this._viewer = await this.locator.getInstance<XyoViewer>(XyoViewerMoniker)
-    const dataLakeViewer = await this.locator.tryGetInstance<DataLakeViewer>(DataLakeViewerMoniker)
-    this._storage = dataLakeViewer
-  }
-}