Class TitanTask

Fetch the simulated swap price from Titan API.

Input: None

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

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

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

Example: Fetch the Titan price for exchanging 1000 SOL into USDC with slippage.

{ "titanTask": { "inTokenAddress": "So11111111111111111111111111111111111111112", "outTokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "amount": "1000", "slippageBps": 50 } }

Implements

Constructors

constructor

Properties

accessToken amount apiEndpoint dexes? excludeDexes? inTokenAddress onlyDirectRoutes outTokenAddress providers slippageBps swapMode userPublicKey

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

accessToken

accessToken: string

Optional API access token for authenticated requests

amount

amount: string

The amount of tokens to swap (raw atoms, not scaled by decimals).

apiEndpoint

apiEndpoint: string

Optional API endpoint override (defaults to partners.api.titan.exchange)

Optionaldexes

dexes?: null | OracleJob.TitanTask.IFilterList

If set, constrain quotes to the given set of DEXes.

OptionalexcludeDexes

excludeDexes?: null | OracleJob.TitanTask.IFilterList

If set, exclude the following DEXes when determining routes.

inTokenAddress

inTokenAddress: string

The input token mint address (base58 encoded).

onlyDirectRoutes

onlyDirectRoutes: boolean

If set to true, only direct routes between the input and output mint will be considered.

outTokenAddress

outTokenAddress: string

The output token mint address (base58 encoded).

providers

providers: string[]

If set, limit quotes to the given set of provider IDs.

slippageBps

slippageBps: number

Allowed slippage in basis points (e.g., 50 = 0.5%).

swapMode

swapMode: SwapMode

Whether the amount is in terms of input or output token. Defaults to ExactIn.

userPublicKey

userPublicKey: string

Optional user public key for transaction generation (base58 encoded).

Methods

toJSON

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

    Converts this TitanTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

Staticdecode

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

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

    TitanTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.TitanTask

    TitanTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: ITitanTask

      TitanTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: ITitanTask

      TitanTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns OracleJob.TitanTask

    TitanTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for TitanTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

    Creates a plain object from a TitanTask message. Also converts values to other types if specified.

    Parameters

    • message: OracleJob.TitanTask

      TitanTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): null | string

    Verifies a TitanTask 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