@openpit/engine
    Preparing search index...

    Class SpotFundsBuilder

    Ready-builder token for the builtin spot-funds policy.

    Hierarchy (View Summary)

    Index
    NAME: string

    Stable name registered by the builtin spot-funds policy.

    • Returns void

    • 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

      • service: MarketDataService
      • default_slippage_bps: number
      • pricing_source: "Mark" | "BookTop" | null | undefined
      • overrides: Iterable<SpotFundsOverride, any, any> | null | undefined

      Returns SpotFundsReadyBuilder

    • Assigns the policy group id and returns the builder for chaining.

      Parameters

      • policy_group_id: number

      Returns SpotFundsReadyBuilder