Class PumpAmmLpTokenPriceTask

Derive the fair LP token price for a given Pump AMM liquidity pool.

Input: Pool address, X token price job, Y token price job. Returns: The fair LP token price for the given Pump AMM liquidity pool. Example: Derive the fair LP token price for a given Pump AMM liquidity pool.

{
"pumpAmmLpTokenPriceTask": {
"pool_address": "Gf7sXMoP8iRw4iiXmJ1nq4vxcRycbGXy5RL8a8LnTd3v", // USDC/SOL
"x_price_job": {
"oracleTask": {
"switchboardAddress": "..." // USDC/USD
}
},
"y_price_job": {
"oracleTask": {
"switchboardAddress": "..." // SOL/USD
}
}
}

Implements

Constructors

constructor

Properties

poolAddress xPriceJob? yPriceJob?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

poolAddress

poolAddress: string

Required. The address of the liquidity pool in the Pump AMM.

OptionalxPriceJob

xPriceJob?: null | IOracleJob

Required. The job to execute to fetch the price of the pool x token

OptionalyPriceJob

yPriceJob?: null | IOracleJob

Required. The job to execute

Methods

toJSON

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

    Converts this PumpAmmLpTokenPriceTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

Staticdecode

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

    Decodes a PumpAmmLpTokenPriceTask 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 PumpAmmLpTokenPriceTask

    PumpAmmLpTokenPriceTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(
        reader: Uint8Array<ArrayBufferLike> | Reader,
    ): PumpAmmLpTokenPriceTask

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns PumpAmmLpTokenPriceTask

    PumpAmmLpTokenPriceTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IPumpAmmLpTokenPriceTask

      PumpAmmLpTokenPriceTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IPumpAmmLpTokenPriceTask

      PumpAmmLpTokenPriceTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): PumpAmmLpTokenPriceTask

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

    Parameters

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

      Plain object

    Returns PumpAmmLpTokenPriceTask

    PumpAmmLpTokenPriceTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for PumpAmmLpTokenPriceTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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