Class JupiterIntegration

Jupiter Aggregator V6 Integration Real Jupiter API integration for best swap routes across Solana DEXes

Example

const jupiter = new JupiterIntegration(client);

const quote = await jupiter.getQuote({
  inputMint: 'So11111111111111111111111111111111111111112',
  outputMint: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
  amount: 1_000_000_000,
  slippageBps: 50,
});

Hierarchy

  • EventEmitter
    • JupiterIntegration

Constructors

constructor

Properties

prefixed

Methods

addListener emit eventNames executeSwap getBaseUrl getQuote getSwapTransaction getTokenList getTokenPrice getTokenPrices listenerCount listeners off on once removeAllListeners removeListener setBaseUrl

Constructors

constructor

Properties

Staticprefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

executeSwap

  • executeSwap(params, userPublicKey, options?): Promise<{
        quote: JupiterQuoteResponse;
        signature: string;
        success: boolean;
    }>

  • Execute complete swap (quote + swap + send)

    Parameters

    • params: JupiterQuoteParams
    • userPublicKey: string
    • Optionaloptions: {
          sendOptions?: {
              maxRetries?: number;
              skipPreflight?: boolean;
          };
          signTransaction?: ((tx: VersionedTransaction) => Promise<VersionedTransaction>);
          swapOptions?: JupiterSwapOptions;
      }
      • OptionalsendOptions?: {
            maxRetries?: number;
            skipPreflight?: boolean;
        }
        • OptionalmaxRetries?: number
        • OptionalskipPreflight?: boolean
      • OptionalsignTransaction?: ((tx: VersionedTransaction) => Promise<VersionedTransaction>)
          • (tx): Promise<VersionedTransaction>

          • Parameters

            • tx: VersionedTransaction

            Returns Promise<VersionedTransaction>

      • OptionalswapOptions?: JupiterSwapOptions

    Returns Promise<{
        quote: JupiterQuoteResponse;
        signature: string;
        success: boolean;
    }>

getBaseUrl

getQuote

getSwapTransaction

getTokenList

  • getTokenList(): Promise<{
        address: string;
        decimals: number;
        logoURI?: string;
        name: string;
        symbol: string;
        tags?: string[];
    }[]>

  • Get supported tokens list

    Returns Promise<{
        address: string;
        decimals: number;
        logoURI?: string;
        name: string;
        symbol: string;
        tags?: string[];
    }[]>

getTokenPrice

getTokenPrices

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args: any[]) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args: any[]) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

setBaseUrl

Settings

Member Visibility

On This Page

Constructors
Properties
Methods