Class LpTokenPriceTask

Fetch LP token price info from a number of supported exchanges.

See our blog post on Fair LP Token Oracles

NOTE*: This is not the swap price but the price of the underlying LP token.

Input: None

Returns: The price of an LP token for a given AMM pool.

Example: Fetch the Orca LP token price of the SOL/USDC pool

{ "lpTokenPriceTask": { "orcaPoolAddress": "APDFRM3HMr8CAGXwKHiu2f5ePSpaiEJhaURwhsRrUUt9" } }

Example: Fetch the fair price Orca LP token price of the SOL/USDC pool

{ "lpTokenPriceTask": { "orcaPoolAddress": "APDFRM3HMr8CAGXwKHiu2f5ePSpaiEJhaURwhsRrUUt9", "useFairPrice": true, "priceFeedAddresses": [ "GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR", "BjUgj6YCnFBZ49wF54ddBVA9qu8TeqkFtkbqmZcee8uW" ] } }

Example: Fetch the fair price Raydium LP token price of the SOL/USDC pool

{ "lpTokenPriceTask": { "raydiumPoolAddress": "58oQChx4yWmvKdwLLZzBi4ChoCc2fqCUWBkwMihLYQo2", "useFairPrice": true,"priceFeedAddresses": ["GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR","BjUgj6YCnFBZ49wF54ddBVA9qu8TeqkFtkbqmZcee8uW" ] } }

Implements

ILpTokenPriceTask

Index

Constructors

constructor

new LpTokenPriceTask(properties?: ILpTokenPriceTask): LpTokenPriceTask
Constructs a new LpTokenPriceTask.
Parameters
- Optionalproperties: ILpTokenPriceTask
  Properties to set
Returns LpTokenPriceTask
- Defined in protos/index.d.ts:2166

Properties

`Optional`mercurialPoolAddress

mercurialPoolAddress?: null | string

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

`Optional`orcaPoolAddress

orcaPoolAddress?: null | string

Orca pool address. A full list can be found here: https://www.orca.so/pools

`Optional`PoolAddress

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

LpTokenPriceTask PoolAddress.

priceFeedAddresses

priceFeedAddresses: string[]

A list of Switchboard aggregator accounts used to calculate the fair LP price. This ensures the price is based on the previous round to mitigate flash loan price manipulation.

priceFeedJobs

priceFeedJobs: IOracleJob[]

A list of OracleJobs to execute in order to yield the price feed jobs to use for the fair price formula.

`Optional`raydiumPoolAddress

raydiumPoolAddress?: null | string

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

`Optional`saberPoolAddress

saberPoolAddress?: null | string

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

useFairPrice

useFairPrice: boolean

If enabled and price_feed_addresses provided, the oracle will calculate the fair LP price based on the liquidity pool reserves. See our blog post for more information: https://switchboardxyz.medium.com/fair-lp-token-oracles-94a457c50239

Methods

toJSON

toJSON(): { [k: string]: any }
Converts this LpTokenPriceTask to JSON.

Returns { [k: string]: any }
JSON object
- Defined in protos/index.d.ts:2260

`Static`create

create(properties?: ILpTokenPriceTask): LpTokenPriceTask
Creates a new LpTokenPriceTask instance using the specified properties.
Parameters
- Optionalproperties: ILpTokenPriceTask
  Properties to set
Returns LpTokenPriceTask
LpTokenPriceTask instance
- Defined in protos/index.d.ts:2197

`Static`decode

decode(
reader: Uint8Array<ArrayBufferLike> | Reader,
length?: number,
): LpTokenPriceTask
Decodes a LpTokenPriceTask 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 LpTokenPriceTask
LpTokenPriceTask

Throws
If the payload is not a reader or valid buffer

Throws
If required fields are missing
- Defined in protos/index.d.ts:2223

`Static`decodeDelimited

decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): LpTokenPriceTask
Decodes a LpTokenPriceTask message from the specified reader or buffer, length delimited.
Parameters
- reader: Uint8Array<ArrayBufferLike> | Reader
  Reader or buffer to decode from
Returns LpTokenPriceTask
LpTokenPriceTask

Throws
If the payload is not a reader or valid buffer

Throws
If required fields are missing
- Defined in protos/index.d.ts:2232

`Static`encode

encode(message: ILpTokenPriceTask, writer?: Writer): Writer
Encodes the specified LpTokenPriceTask message. Does not implicitly {@apilink oracle_job.OracleJob.LpTokenPriceTask.verify|verify} messages.
Parameters
- message: ILpTokenPriceTask
  LpTokenPriceTask message or plain object to encode
- Optionalwriter: Writer
  Writer to encode to
Returns Writer
Writer
- Defined in protos/index.d.ts:2205

`Static`encodeDelimited

encodeDelimited(message: ILpTokenPriceTask, writer?: Writer): Writer
Encodes the specified LpTokenPriceTask message, length delimited. Does not implicitly {@apilink oracle_job.OracleJob.LpTokenPriceTask.verify|verify} messages.
Parameters
- message: ILpTokenPriceTask
  LpTokenPriceTask message or plain object to encode
- Optionalwriter: Writer
  Writer to encode to
Returns Writer
Writer
- Defined in protos/index.d.ts:2213

`Static`fromObject

fromObject(object: { [k: string]: any }): LpTokenPriceTask
Creates a LpTokenPriceTask message from a plain object. Also converts values to their respective internal types.
Parameters
- object: { [k: string]: any }
  Plain object
Returns LpTokenPriceTask
LpTokenPriceTask
- Defined in protos/index.d.ts:2246

`Static`getTypeUrl

getTypeUrl(typeUrlPrefix?: string): string
Gets the default type url for LpTokenPriceTask
Parameters
- OptionaltypeUrlPrefix: string
  your custom typeUrlPrefix(default "type.googleapis.com")
Returns string
The default type url
- Defined in protos/index.d.ts:2267

`Static`toObject

toObject(
message: LpTokenPriceTask,
options?: IConversionOptions,
): { [k: string]: any }
Creates a plain object from a LpTokenPriceTask message. Also converts values to other types if specified.
Parameters
- message: LpTokenPriceTask
  LpTokenPriceTask
- Optionaloptions: IConversionOptions
  Conversion options
Returns { [k: string]: any }
Plain object
- Defined in protos/index.d.ts:2254

`Static`verify

verify(message: { [k: string]: any }): null | string
Verifies a LpTokenPriceTask message.
Parameters
- message: { [k: string]: any }
  Plain object to verify
Returns null | string
null if valid, otherwise the reason why it is not
- Defined in protos/index.d.ts:2239

Class LpTokenPriceTask

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LpTokenPriceTask

Properties

OptionalmercurialPoolAddress

OptionalorcaPoolAddress

OptionalPoolAddress

priceFeedAddresses

priceFeedJobs

OptionalraydiumPoolAddress

OptionalsaberPoolAddress

useFairPrice

Methods

toJSON

Returns { [k: string]: any }

Staticcreate

Parameters

Returns LpTokenPriceTask

Staticdecode

Parameters

Returns LpTokenPriceTask

Throws

Throws

StaticdecodeDelimited

Parameters

Returns LpTokenPriceTask

Throws

Throws

Staticencode

Parameters

Returns Writer

StaticencodeDelimited

Parameters

Returns Writer

StaticfromObject

Parameters

Returns LpTokenPriceTask

StaticgetTypeUrl

Parameters

Returns string

StatictoObject

Parameters

Returns { [k: string]: any }

Staticverify

Parameters

Returns null | string

Settings

On This Page

`Optional`mercurialPoolAddress

`Optional`orcaPoolAddress

`Optional`PoolAddress

`Optional`raydiumPoolAddress

`Optional`saberPoolAddress

`Static`create

`Static`decode

`Static`decodeDelimited

`Static`encode

`Static`encodeDelimited

`Static`fromObject

`Static`getTypeUrl

`Static`toObject

`Static`verify