Always-ready spot-funds builder token.

interface SpotFundsReadyBuilder {
    [builtinReadyBuilderBrand]: true;
    [dispose](): void;
    clone(): SpotFundsReadyBuilder;
    free(): void;
    marketData(...args: [service: MarketDataService, default_slippage_bps: number, pricing_source: null | "Mark" | "BookTop", overrides: null | Iterable<SpotFundsOverride, any, any>]): SpotFundsReadyBuilder;
    withPolicyGroupId(...args: [policy_group_id: number]): SpotFundsReadyBuilder;
}

Hierarchy (view full)

Properties

[builtinReadyBuilderBrand]

Methods

  • Returns void

  • Enables market orders against service and returns the ready builder.

    defaultSlippageBps is the global worst-case slippage; pricingSource selects the base price ("Mark" default or "BookTop"); overrides is an array of SpotFundsOverride. Without this call the policy is limit-only (market orders rejected UnsupportedOrderType).

    Errors

    Throws ParamError when defaultSlippageBps is out of range or pricingSource is invalid.

    Parameters

    • Rest...args: [service: MarketDataService, default_slippage_bps: number, pricing_source: null | "Mark" | "BookTop", overrides: null | Iterable<SpotFundsOverride, any, any>]

    Returns SpotFundsReadyBuilder