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? pythAddress? pythAllowedConfidenceInterval pythConfigs? switchboardAddress?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new OracleTask(properties?): OracleTask

  • Constructs a new OracleTask.

    Parameters

    Returns OracleTask

Properties

Optional AggregatorAddress

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

OracleTask AggregatorAddress.

Optional chainlinkAddress

chainlinkAddress?: string

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

Optional chainlinkConfigs

chainlinkConfigs?: IChainlinkConfigs

OracleTask chainlinkConfigs.

Optional pythAddress

pythAddress?: 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.

Optional pythConfigs

pythConfigs?: IPythConfigs

OracleTask pythConfigs.

Optional switchboardAddress

switchboardAddress?: string

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

Methods

toJSON

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

  • Converts this OracleTask to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • create(properties?): OracleTask

  • Creates a new OracleTask instance using the specified properties.

    Parameters

    Returns OracleTask

    OracleTask instance

Static decode

  • decode(reader, length?): OracleTask

  • Decodes an OracleTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns OracleTask

    OracleTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): OracleTask

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns OracleTask

    OracleTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static encode

  • encode(message, writer?): Writer

  • Encodes the specified OracleTask message. Does not implicitly verify messages.

    Parameters

    • message: IOracleTask

      OracleTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message, writer?): Writer

  • Encodes the specified OracleTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IOracleTask

      OracleTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): OracleTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns OracleTask

    OracleTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for OracleTask

    Parameters

    • Optional typeUrlPrefix: string

      your custom typeUrlPrefix(default "type.googleapis.com")

    Returns string

    The default type url

Static toObject

  • toObject(message, options?): {
        [k: string]: any;
    }

  • Creates a plain object from an OracleTask message. Also converts values to other types if specified.

    Parameters

    • message: OracleTask

      OracleTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

  • Verifies an OracleTask message.

    Parameters

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

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc