Class OracleTask

Fetch the current price of a Solana oracle protocol.

Input: None

Returns: The current price of an on-chain oracle.

Example: The Switchboard SOL/USD oracle price.

{ "oracleTask": { "switchboardAddress": "GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR" } }

Example: The Pyth SOL/USD oracle price.

{ "oracleTask": { "pythAddress": "H6ARHf6YXhGYeQfUzQNGk6rDNnLBQKrenN712K4AQJEG" } }

Example: The Chainlink SOL/USD oracle price.

{ "oracleTask": { "chainlinkAddress": "CcPVS9bqyXbD9cLnTbhhHazLsrua8QMFUHTutPtjyDzq" } }

Implements

Constructors

constructor

Properties

AggregatorAddress? chainlinkAddress? chainlinkConfigs? edgeConfigs? edgeId? pythAddress? pythAllowedConfidenceInterval pythConfigs? redstoneConfigs? redstoneId? switchboardAddress? switchboardConfigs?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

OptionalAggregatorAddress

AggregatorAddress?:
    | "switchboardAddress"
    | "pythAddress"
    | "chainlinkAddress"
    | "edgeId"
    | "redstoneId"

OracleTask AggregatorAddress.

OptionalchainlinkAddress

chainlinkAddress?: null | string

Mainnet address for a Chainlink feed. A full list can be found here: https://docs.chain.link/docs/solana/data-feeds-solana

OptionalchainlinkConfigs

chainlinkConfigs?: null | IChainlinkConfigs

OracleTask chainlinkConfigs.

OptionaledgeConfigs

edgeConfigs?: null | IEdgeConfigs

OracleTask edgeConfigs.

OptionaledgeId

edgeId?: null | string

OracleTask edgeId.

OptionalpythAddress

pythAddress?: null | string

Mainnet address for a Pyth feed. A full list can be found here: https://pyth.network/price-feeds/

pythAllowedConfidenceInterval

pythAllowedConfidenceInterval: number

Value (as a percentage) that the lower bound confidence interval is of the actual value. Confidence intervals that are larger that this treshold are rejected.

The confidence interval should be provided as a raw percentage value. For example, to represent 10%, enter the value as 10, not 0.1.

OptionalpythConfigs

pythConfigs?: null | IPythConfigs

OracleTask pythConfigs.

OptionalredstoneConfigs

redstoneConfigs?: null | IRedstoneConfigs

OracleTask redstoneConfigs.

OptionalredstoneId

redstoneId?: null | string

OracleTask redstoneId.

OptionalswitchboardAddress

switchboardAddress?: null | string

Mainnet address of a Switchboard feed. Switchboard is decentralized and allows anyone to build their own feed.

OptionalswitchboardConfigs

switchboardConfigs?: null | ISwitchboardConfigs

OracleTask switchboardConfigs.

Methods

toJSON

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

    Converts this OracleTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

Staticdecode

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

    Decodes an OracleTask 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.OracleTask

    OracleTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

    Decodes an OracleTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.OracleTask

    OracleTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IOracleTask

      OracleTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IOracleTask

      OracleTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns OracleJob.OracleTask

    OracleTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for OracleTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

    Creates a plain object from an OracleTask 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 an OracleTask 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