Skip to main content

Namespace: v1_4_0

Interfaces​

Type Aliases​

AppCode​

Ƭ AppCode: string

The code identifying the CLI, UI, service generating the order.

Defined in​

generatedTypes/v1.4.0.ts:15

AppCode1​

Ƭ AppCode1: string

The code identifying the UI powering the widget

Defined in​

generatedTypes/v1.4.0.ts:88

Environment​

Ƭ Environment: string

Environment from which the order came from.

Defined in​

generatedTypes/v1.4.0.ts:19

Environment1​

Ƭ Environment1: string

Environment from which the order came from.

Defined in​

generatedTypes/v1.4.0.ts:92

HookCallData​

Ƭ HookCallData: string

The calldata to use when calling the hook

Defined in​

generatedTypes/v1.4.0.ts:68

HookGasLimit​

Ƭ HookGasLimit: string

The gas limit (in gas units) for the hook

Defined in​

generatedTypes/v1.4.0.ts:72

HookTarget​

Ƭ HookTarget: string

The contract to call for the hook

Defined in​

generatedTypes/v1.4.0.ts:64

IdOfTheDAppWhichHasBuiltTheHook​

Ƭ IdOfTheDAppWhichHasBuiltTheHook: string

CoW Swap has an interface that allows dApps to build hooks for orders. This field is used to identify the dApp that has built the hook.

Defined in​

generatedTypes/v1.4.0.ts:76

MaxVolumeBasisPointBPS​

Ƭ MaxVolumeBasisPointBPS: number

The maximum volume in basis points (BPS) to be paid to the partner. Capped at protocol level to 100 BPS (1%). You can chose to go lower but not higher

Defined in​

generatedTypes/v1.4.0.ts:141

OrderClass1​

Ƭ OrderClass1: "market" | "limit" | "liquidity" | "twap"

Indicator of the order class.

Defined in​

generatedTypes/v1.4.0.ts:56

PartnerAccount​

Ƭ PartnerAccount: string

The Ethereum address of the partner to receive the fee.

Defined in​

generatedTypes/v1.4.0.ts:133

PartnerFee​

Ƭ PartnerFee: ({ recipient: PartnerAccount ; volumeBps: VolumeBasisPointBPS } | { maxVolumeBps: MaxVolumeBasisPointBPS ; recipient: PartnerAccount ; surplusBps: SurplusBasisPointBPS } | { maxVolumeBps: MaxVolumeBasisPointBPS ; priceImprovementBps: PriceImprovementBasisPointBPS ; recipient: PartnerAccount })[] | { recipient: PartnerAccount ; volumeBps: VolumeBasisPointBPS } | { maxVolumeBps: MaxVolumeBasisPointBPS ; recipient: PartnerAccount ; surplusBps: SurplusBasisPointBPS } | { maxVolumeBps: MaxVolumeBasisPointBPS ; priceImprovementBps: PriceImprovementBasisPointBPS ; recipient: PartnerAccount }

Defined in​

generatedTypes/v1.4.0.ts:93

PostHooks​

Ƭ PostHooks: CoWHook[]

CoW Hooks to call after an order executes

Defined in​

generatedTypes/v1.4.0.ts:84

PreHooks​

Ƭ PreHooks: CoWHook[]

CoW Hooks to call before an order executes

Defined in​

generatedTypes/v1.4.0.ts:80

PriceImprovementBasisPointBPS​

Ƭ PriceImprovementBasisPointBPS: number

The fee in basis points (BPS) to be paid to the partner based on price improvement

Defined in​

generatedTypes/v1.4.0.ts:145

ReferrerAddress​

Ƭ ReferrerAddress: string

Defined in​

generatedTypes/v1.4.0.ts:24

ReplacedOrderUID​

Ƭ ReplacedOrderUID: string

The replaced order UID.

Defined in​

generatedTypes/v1.4.0.ts:149

Signer​

Ƭ Signer: string

The address of the trader who signs the CoW Swap order. This field should normally be omitted; it is recommended to use it if the signer is a smart-contract wallet using EIP-1271 signatures.

Defined in​

generatedTypes/v1.4.0.ts:23

SlippageBips​

Ƭ SlippageBips: number

Slippage tolerance that was applied to the order to get the limit price. Expressed in Basis Points (BPS). One basis point is equivalent to 0.01% (1/100th of a percent)

Defined in​

generatedTypes/v1.4.0.ts:48

SmartSlippage​

Ƭ SmartSlippage: boolean

Whether the given slippageBips used is originated from a Smart slippage suggestion

Defined in​

generatedTypes/v1.4.0.ts:52

SurplusBasisPointBPS​

Ƭ SurplusBasisPointBPS: number

The fee in basis points (BPS) to be paid to the partner based on surplus

Defined in​

generatedTypes/v1.4.0.ts:137

UTMCampaign​

Ƭ UTMCampaign: string

Track the performance of a specific campaign

Defined in​

generatedTypes/v1.4.0.ts:36

UTMContent​

Ƭ UTMContent: string

Track which link was clicked

Defined in​

generatedTypes/v1.4.0.ts:40

UTMKeywordTerm​

Ƭ UTMKeywordTerm: string

Track which keyword term a website visitor came from

Defined in​

generatedTypes/v1.4.0.ts:44

UTMMedium​

Ƭ UTMMedium: string

Tracks in which medium the traffic originated from (mail, CPC, social, etc.)

Defined in​

generatedTypes/v1.4.0.ts:32

UTMSource​

Ƭ UTMSource: string

Tracks in which medium the traffic originated from (twitter, facebook, etc.)

Defined in​

generatedTypes/v1.4.0.ts:28

Version​

Ƭ Version: string

Semantic versioning of document.

Defined in​

generatedTypes/v1.4.0.ts:11

Version1​

Ƭ Version1: string

Semantic versioning of document.

Defined in​

generatedTypes/v1.4.0.ts:60

VolumeBasisPointBPS​

Ƭ VolumeBasisPointBPS: number

The fee in basis points (BPS) to be paid to the partner based on volume. Capped at protocol level to 100 BPS (1%)

Defined in​

generatedTypes/v1.4.0.ts:129