@openpit/engine
    Preparing search index...

    Interface SpotFundsReadyBuilder

    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: "Mark"
                | "BookTop"
                | null,
                overrides: Iterable<SpotFundsOverride, any, any> | null,
            ],
        ): SpotFundsReadyBuilder;
        withPolicyGroupId(
            ...args: [policy_group_id: number],
        ): SpotFundsReadyBuilder;
    }

    Hierarchy (View Summary)

    Index
    "[builtinReadyBuilderBrand]": true
    • 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

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

      Returns SpotFundsReadyBuilder