Skip to main content

Interface: TwapStruct

Parameters for a TWAP order, as expected by the contract's staticInput.

Hierarchy

Properties

appData

Readonly appData: string

Meta-data associated with the order. Normally would be the keccak256 hash of the document generated in http://github.com/cowprotocol/app-data

This hash should have been uploaded to the API https://api.cow.fi/docs/#/default/put_api_v1_app_data__app_data_hash_ and potentially to other data availability protocols like IPFS.

Inherited from

TwapDataBase.appData

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:63


buyToken

Readonly buyToken: string

which token to buy

Inherited from

TwapDataBase.buyToken

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:50


minPartLimit

Readonly minPartLimit: BigNumber

minimum amount of buyToken that must be bought in each part

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:78


n

Readonly n: BigNumber

number of parts

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:88


partSellAmount

Readonly partSellAmount: BigNumber

amount of sellToken to sell in each part

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:73


receiver

Readonly receiver: string

who to send the tokens to

Inherited from

TwapDataBase.receiver

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:55


sellToken

Readonly sellToken: string

which token to sell

Inherited from

TwapDataBase.sellToken

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:45


span

Readonly span: BigNumber

whether the TWAP is valid for the entire interval or not

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:98


t

Readonly t: BigNumber

duration of the TWAP interval

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:93


t0

Readonly t0: BigNumber

start time of the TWAP

Defined in

external/cow-sdk/src/composable/orderTypes/Twap.ts:83