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

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

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

Optional RoutesFilters

RoutesFilters?: "allowList" | "denyList"

JupiterSwapTask RoutesFilters.

Optional SwapAmount

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

JupiterSwapTask SwapAmount.

Optional allowList

allowList?: IFilterList

A list of AMM markets to allow.

Optional baseAmount

baseAmount?: number

The amount of in_token_address tokens to swap.

Optional baseAmountString

baseAmountString?: string

The amount of in_token_address tokens to swap.

Optional denyList

denyList?: IFilterList

A list of AMM markets to deny.

inTokenAddress

inTokenAddress: string

The input token address.

outTokenAddress

outTokenAddress: string

The output token address.

Optional quoteAmount

quoteAmount?: number

The amount of out_token_address tokens to swap.

Optional quoteAmountString

quoteAmountString?: string

The amount of out_token_address tokens to swap.

slippage

slippage: number

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

Methods

toJSON

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

  • Converts this JupiterSwapTask to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • create(properties?): JupiterSwapTask

  • Creates a new JupiterSwapTask instance using the specified properties.

    Parameters

    Returns JupiterSwapTask

    JupiterSwapTask instance

Static decode

  • decode(reader, length?): JupiterSwapTask

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

    JupiterSwapTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): JupiterSwapTask

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns JupiterSwapTask

    JupiterSwapTask

    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 JupiterSwapTask message. Does not implicitly verify messages.

    Parameters

    • message: IJupiterSwapTask

      JupiterSwapTask 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 JupiterSwapTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IJupiterSwapTask

      JupiterSwapTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): JupiterSwapTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns JupiterSwapTask

    JupiterSwapTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for JupiterSwapTask

    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 a JupiterSwapTask message. Also converts values to other types if specified.

    Parameters

    • message: JupiterSwapTask

      JupiterSwapTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

  • Verifies a JupiterSwapTask 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

constructorRoutesFiltersSwapAmountallowListbaseAmountbaseAmountStringdenyListinTokenAddressoutTokenAddressquoteAmountquoteAmountStringslippagetoJSONcreatedecodedecodeDelimitedencodeencodeDelimitedfromObjectgetTypeUrltoObjectverify