aftermath-ts-sdk - v6.1.0
    Preparing search index...

    Interface PerpetualsBuilderCodeParamaters

    Optional integrator fee configuration for an order.

    Integrators register once globally and are assigned a numeric integratorId. A user then approves an integrator by creating an integrator config with a maxIntegratorFee (see ApiPerpetualsBuilderCodesCreateIntegratorConfigTxBody). Orders placed on that user's behalf attach the integrator id and the fee to charge here.

    The fee is charged on the notional filled by the order and follows the order, so it applies to both taker and maker fills.

    interface PerpetualsBuilderCodeParamaters {
        integratorFee: number;
        integratorId: number;
    }
    Index
    integratorFee: number

    Integrator fee (as a decimal) charged on the notional filled by this order.

    For example, 0.0005 represents a 0.05% fee. This value must not exceed the maxIntegratorFee that the user approved for this integrator. The fee follows the order, so it is collected on taker and maker fills alike.

    integratorId: number

    Numeric integrator id (as assigned by the registry) of the integrator who will receive the fee.

    This integrator must have been previously approved by the account owner.