Class LpExchangeRateTask

Fetch the current swap price for a given liquidity pool

Input: None

Returns: The swap price for a given AMM pool.

Example: Fetch the exchange rate from the Orca SOL/USDC pool

{ "lpExchangeRateTask": { "orcaPoolAddress": "APDFRM3HMr8CAGXwKHiu2f5ePSpaiEJhaURwhsRrUUt9" } }

Example: Fetch the exchange rate from the Raydium SOL/USDC pool

{ "lpExchangeRateTask": { "raydiumPoolAddress": "58oQChx4yWmvKdwLLZzBi4ChoCc2fqCUWBkwMihLYQo2" } }

Implements

Constructors

constructor

Properties

chain inTokenAddress mercurialPoolAddress? orcaPoolAddress? orcaPoolTokenMintAddress? outTokenAddress PoolAddress? portReserveAddress? raydiumPoolAddress? saberPoolAddress?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

chain

chain: OracleJob.LpExchangeRateTask.Chain

LpExchangeRateTask chain.

inTokenAddress

inTokenAddress: string

Used alongside mercurial_pool_address to specify the input token for a swap.

OptionalmercurialPoolAddress

mercurialPoolAddress?: string

Mercurial finance pool address. A full list can be found here: https://github.com/mercurial-finance/stable-swap-n-pool-js

OptionalorcaPoolAddress

orcaPoolAddress?: string

Pool address for an Orca LP pool or whirlpool. A full list of Orca LP pools can be found here: https://www.orca.so/pools

OptionalorcaPoolTokenMintAddress

orcaPoolTokenMintAddress?: string

@deprecated Use orcaPoolAddress

outTokenAddress

outTokenAddress: string

Used alongside mercurial_pool_address to specify the output token for a swap.

OptionalPoolAddress

PoolAddress?:
    | "mercurialPoolAddress"
    | "saberPoolAddress"
    | "orcaPoolAddress"
    | "raydiumPoolAddress"
    | "orcaPoolTokenMintAddress"
    | "portReserveAddress"

LpExchangeRateTask PoolAddress.

OptionalportReserveAddress

portReserveAddress?: string

The Port reserve pubkey. A full list can be found here: https://api-v1.port.finance/reserves

OptionalraydiumPoolAddress

raydiumPoolAddress?: string

The Raydium liquidity pool ammId. A full list can be found here: https://raydium.io/pools

OptionalsaberPoolAddress

saberPoolAddress?: string

Saber pool address. A full list can be found here: https://github.com/saber-hq/saber-registry-dist

Methods

toJSON

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

    Converts this LpExchangeRateTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

Staticdecode

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

    Decodes a LpExchangeRateTask 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.LpExchangeRateTask

    LpExchangeRateTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.LpExchangeRateTask

    LpExchangeRateTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

    Encodes the specified LpExchangeRateTask message. Does not implicitly verify messages.

    Parameters

    • message: ILpExchangeRateTask

      LpExchangeRateTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: ILpExchangeRateTask

      LpExchangeRateTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns OracleJob.LpExchangeRateTask

    LpExchangeRateTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for LpExchangeRateTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a LpExchangeRateTask message.

    Parameters

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

      Plain object to verify

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods