Class JupiterSwapTask

Fetch the simulated price for a swap on JupiterSwap.

Input: None

Returns: The swap price on Jupiter for a given input and output token mint address.

Example: Fetch the JupiterSwap price for exchanging 1 SOL into USDC.

{ "jupiterSwapTask": { "inTokenAddress": "So11111111111111111111111111111111111111112", "outTokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" } }

Example: Fetch the JupiterSwap price for exchanging 1000 SOL into USDC.

{ "jupiterSwapTask": { "inTokenAddress": "So11111111111111111111111111111111111111112", "outTokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "baseAmount": "1000" } }

Implements

Constructors

constructor

Properties

allowList? baseAmount? baseAmountString? denyList? inTokenAddress outTokenAddress quoteAmount? quoteAmountString? RoutesFilters? slippage SwapAmount? version

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

OptionalallowList

allowList?: IFilterList

A list of AMM markets to allow.

OptionalbaseAmount

baseAmount?: number

The amount of in_token_address tokens to swap.

OptionalbaseAmountString

baseAmountString?: string

The amount of in_token_address tokens to swap.

OptionaldenyList

denyList?: IFilterList

A list of AMM markets to deny.

inTokenAddress

inTokenAddress: string

The input token address.

outTokenAddress

outTokenAddress: string

The output token address.

OptionalquoteAmount

quoteAmount?: number

The amount of out_token_address tokens to swap.

OptionalquoteAmountString

quoteAmountString?: string

The amount of out_token_address tokens to swap.

OptionalRoutesFilters

RoutesFilters?: "allowList" | "denyList"

JupiterSwapTask RoutesFilters.

slippage

slippage: number

The allowable slippage on the swap in decimal form (e.g. 0.5 is 0.5% slippage)

OptionalSwapAmount

SwapAmount?:
    | "baseAmount"
    | "quoteAmount"
    | "baseAmountString"
    | "quoteAmountString"

JupiterSwapTask SwapAmount.

version

version: OracleJob.JupiterSwapTask.Version

JupiterSwapTask version.

Methods

toJSON

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

    Converts this JupiterSwapTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IJupiterSwapTask): OracleJob.JupiterSwapTask

    Creates a new JupiterSwapTask instance using the specified properties.

    Parameters

    Returns OracleJob.JupiterSwapTask

    JupiterSwapTask instance

Staticdecode

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

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

    JupiterSwapTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.JupiterSwapTask

    JupiterSwapTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IJupiterSwapTask

      JupiterSwapTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IJupiterSwapTask

      JupiterSwapTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns OracleJob.JupiterSwapTask

    JupiterSwapTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for JupiterSwapTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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