Class LstHistoricalYieldTask

Query historical yield data for a given Liquid Staking Token (LST) and perform a statistical reduction operation over the dataset.

Input: LST mint address, reduction operation type, and number of epochs to sample.

Returns: The computed yield value based on the specified operation.

Example: Compute the median APY for an LST over the last 100 epochs

{
"lstHistoricalYieldTask": {
"lstMint": "J1toso1uCk3RLmjorhTtrVwY9HJ7X8V9yYac6Y7kGCPn",
"operation": "OPERATION_MEDIAN",
"epochs": 100
}

Implements

Constructors

constructor

Properties

epochs lstMint operation

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

epochs

epochs: number

Optional. The number of epochs to sample for the computation.

  • If epochs = 0, all available historical data will be used.
  • If epochs > 0, only the last epochs entries will be included.

lstMint

lstMint: string

Required. The LST mint address for which historical yield data is queried.

operation

operation: OracleJob.LstHistoricalYieldTask.Operation

Required. The statistical operation to apply to the historical yield dataset.

Methods

toJSON

  • toJSON(): { [k: string]: any }

    Converts this LstHistoricalYieldTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

Staticdecode

  • decode(
        reader: Uint8Array<ArrayBufferLike> | Reader,
        length?: number,
    ): OracleJob.LstHistoricalYieldTask

    Decodes a LstHistoricalYieldTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    • Optionallength: number

      Message length if known beforehand

    Returns OracleJob.LstHistoricalYieldTask

    LstHistoricalYieldTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(
        reader: Uint8Array<ArrayBufferLike> | Reader,
    ): OracleJob.LstHistoricalYieldTask

    Decodes a LstHistoricalYieldTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.LstHistoricalYieldTask

    LstHistoricalYieldTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

  • encode(message: ILstHistoricalYieldTask, writer?: Writer): Writer

    Encodes the specified LstHistoricalYieldTask message. Does not implicitly {@apilink oracle_job.OracleJob.LstHistoricalYieldTask.verify|verify} messages.

    Parameters

    • message: ILstHistoricalYieldTask

      LstHistoricalYieldTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

  • encodeDelimited(message: ILstHistoricalYieldTask, writer?: Writer): Writer

    Encodes the specified LstHistoricalYieldTask message, length delimited. Does not implicitly {@apilink oracle_job.OracleJob.LstHistoricalYieldTask.verify|verify} messages.

    Parameters

    • message: ILstHistoricalYieldTask

      LstHistoricalYieldTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): OracleJob.LstHistoricalYieldTask

    Creates a LstHistoricalYieldTask message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: { [k: string]: any }

      Plain object

    Returns OracleJob.LstHistoricalYieldTask

    LstHistoricalYieldTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for LstHistoricalYieldTask

    Parameters

    Returns string

    The default type url

StatictoObject

  • toObject(
        message: OracleJob.LstHistoricalYieldTask,
        options?: IConversionOptions,
    ): { [k: string]: any }

    Creates a plain object from a LstHistoricalYieldTask message. Also converts values to other types if specified.

    Parameters

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): null | string

    Verifies a LstHistoricalYieldTask message.

    Parameters

    • message: { [k: string]: any }

      Plain object to verify

    Returns null | string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods