Class BitFluxTask

Fetch the current swap price from a BitFlux pool.

Input: None

Returns: The swap price between the specified input and output tokens.

Example: Fetch the swap price using a custom RPC provider

{
"bitFluxTask": {
"provider": "https://my-custom-rpc.example.com",
"poolAddress": "0x0000000000000000000000000000000000000000",
"inToken": "0x0000000000000000000000000000000000000000",
"outToken": "0x0000000000000000000000000000000000000000"
}
}

Implements

Constructors

constructor

Properties

inToken outToken poolAddress provider

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new BitFluxTask(properties?: IBitFluxTask): BitFluxTask

    Constructs a new BitFluxTask.

    Parameters

    Returns BitFluxTask

Properties

inToken

inToken: string

The address of the input token.

outToken

outToken: string

The address of the output token.

poolAddress

poolAddress: string

The address of the BitFlux pool.

provider

provider: string

Optional. The RPC endpoint to use for requests. If not specified, a default RPC will be used.

Methods

toJSON

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

    Converts this BitFluxTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IBitFluxTask): BitFluxTask

    Creates a new BitFluxTask instance using the specified properties.

    Parameters

    Returns BitFluxTask

    BitFluxTask instance

Staticdecode

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

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

    BitFluxTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns BitFluxTask

    BitFluxTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IBitFluxTask

      BitFluxTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IBitFluxTask

      BitFluxTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns BitFluxTask

    BitFluxTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for BitFluxTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    • message: BitFluxTask

      BitFluxTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

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

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