Type Alias ApiRouterPartialCompleteTradeRouteBody

ApiRouterPartialCompleteTradeRouteBody: {
    coinInType: CoinType;
    coinOutType: CoinType;
    externalFee?: ExternalFee;
    referrer?: SuiAddress;
} & (
    | { protocolBlacklist?: RouterProtocolName[] }
    | { protocolWhitelist?: RouterProtocolName[] }
) & ({ poolBlacklist?: ObjectId[] } | { poolWhitelist?: ObjectId[] })

Basic body for partial router route construction, specifying coin types and optional third-party fee or referral info.

Type Declaration

coinInType: CoinType

The fully qualified Sui type of the coin supplied to the route.
coinOutType: CoinType

The fully qualified Sui type of the coin received from the route.
OptionalexternalFee?: ExternalFee

Optional third-party fee details. The router rejects values above Router.constants.maxExternalFeePercentage.
Optionalreferrer?: SuiAddress

An optional referrer address to include in the route and later referral transaction setup.

{ protocolBlacklist?: RouterProtocolName[] }
- OptionalprotocolBlacklist?: RouterProtocolName[]
  
  Protocols that the router must not use.
{ protocolWhitelist?: RouterProtocolName[] }
- OptionalprotocolWhitelist?: RouterProtocolName[]
  
  Protocols that the router may use. Other protocols are excluded.

{ poolBlacklist?: ObjectId[] }
- OptionalpoolBlacklist?: ObjectId[]
  
  Pool IDs that the router must not use.
{ poolWhitelist?: ObjectId[] }
- OptionalpoolWhitelist?: ObjectId[]
  
  Pool IDs that the router may use. Other pools are excluded.