PriceOracle.ts

This module provides a service for determining USD pricing of a given chain’s gas denomination.

Added in v2.0.0

errors

PriceError (class)

Signature

export declare class PriceError

Added in v2.0.0

Source: src/PriceOracle.ts:31

models

PriceResult

Signature

export declare const PriceResult: S.Struct<{
  price: S.refine<BigDecimal.BigDecimal, typeof S.BigDecimalFromNumber>
  source: S.Struct<{ url: typeof S.URL }>
}>

Source: src/PriceOracle.ts:55

Added in v2.0.0

PriceResult (type alias)

Signature

export type PriceResult = typeof PriceResult.Type

Source: src/PriceOracle.ts:69

Added in v2.0.0

PriceSource

Details about the source of pricing data.

Signature

export declare const PriceSource: S.Struct<{ url: typeof S.URL }>

Source: src/PriceOracle.ts:42

Added in v2.0.0

PriceSource (type alias)

Signature

export type PriceSource = typeof PriceSource.Type

Source: src/PriceOracle.ts:49

Added in v2.0.0

utils

LivePlan

Signature

export declare const LivePlan: ExecutionPlan.ExecutionPlan<{
  provides: PriceOracle
  input: unknown
  error: PriceError
  requirements: never
}>

Source: src/PriceOracle.ts:399

Added in v2.0.0

PriceOracle (class)

Signature

export declare class PriceOracle

Added in v2.0.0

Source: src/PriceOracle.ts:92

PriceOracle (namespace)

Added in v2.0.0

Service (interface)

Signature

export interface Service {
  readonly of: (id: UniversalChainId) => Effect.Effect<PriceResult, PriceError>
  readonly ratio: (
    from: UniversalChainId,
    to: UniversalChainId
  ) => Effect.Effect<
    {
      ratio: BigDecimal.BigDecimal
      source: PriceSource
      destination: PriceSource
    },
    PriceError
  >
  readonly stream: (id: UniversalChainId) => Stream.Stream<PriceResult, PriceError>
}

Source: src/PriceOracle.ts:78

Added in v2.0.0

PriceOracleExecutor (class)

Signature

export declare class PriceOracleExecutor

Added in v2.0.0

Source: src/PriceOracle.ts:416