@cowprotocol/cow-sdk 6.0.0-RC.9 → 6.0.0

package/dist/order-book/generated/models/OrderCancellationError.d.ts

@@ -1,15 +1,15 @@
-export type OrderCancellationError = {
-    errorType: OrderCancellationError.errorType;
-    description: string;
-};
-export declare namespace OrderCancellationError {
-    enum errorType {
-        INVALID_SIGNATURE = "InvalidSignature",
-        WRONG_OWNER = "WrongOwner",
-        ORDER_NOT_FOUND = "OrderNotFound",
-        ALREADY_CANCELLED = "AlreadyCancelled",
-        ORDER_FULLY_EXECUTED = "OrderFullyExecuted",
-        ORDER_EXPIRED = "OrderExpired",
-        ON_CHAIN_ORDER = "OnChainOrder"
-    }
-}
+export type OrderCancellationError = {
+    errorType: OrderCancellationError.errorType;
+    description: string;
+};
+export declare namespace OrderCancellationError {
+    enum errorType {
+        INVALID_SIGNATURE = "InvalidSignature",
+        WRONG_OWNER = "WrongOwner",
+        ORDER_NOT_FOUND = "OrderNotFound",
+        ALREADY_CANCELLED = "AlreadyCancelled",
+        ORDER_FULLY_EXECUTED = "OrderFullyExecuted",
+        ORDER_EXPIRED = "OrderExpired",
+        ON_CHAIN_ORDER = "OnChainOrder"
+    }
+}

package/dist/order-book/generated/models/OrderCancellations.d.ts

@@ -1,18 +1,18 @@
-import type { EcdsaSignature } from './EcdsaSignature';
-import type { EcdsaSigningScheme } from './EcdsaSigningScheme';
-import type { UID } from './UID';
-/**
- * EIP-712 signature of struct OrderCancellations { orderUid: bytes[] } from the order's owner.
- *
- */
-export type OrderCancellations = {
-    /**
-     * UIDs of orders to cancel.
-     */
-    orderUids?: Array<UID>;
-    /**
-     * `OrderCancellation` signed by the owner.
-     */
-    signature: EcdsaSignature;
-    signingScheme: EcdsaSigningScheme;
-};
+import type { EcdsaSignature } from './EcdsaSignature';
+import type { EcdsaSigningScheme } from './EcdsaSigningScheme';
+import type { UID } from './UID';
+/**
+ * EIP-712 signature of struct OrderCancellations { orderUid: bytes[] } from the order's owner.
+ *
+ */
+export type OrderCancellations = {
+    /**
+     * UIDs of orders to cancel.
+     */
+    orderUids?: Array<UID>;
+    /**
+     * `OrderCancellation` signed by the owner.
+     */
+    signature: EcdsaSignature;
+    signingScheme: EcdsaSigningScheme;
+};

package/dist/order-book/generated/models/OrderClass.d.ts

@@ -1,8 +1,8 @@
-/**
- * Order class.
- */
-export declare enum OrderClass {
-    MARKET = "market",
-    LIMIT = "limit",
-    LIQUIDITY = "liquidity"
-}
+/**
+ * Order class.
+ */
+export declare enum OrderClass {
+    MARKET = "market",
+    LIMIT = "limit",
+    LIQUIDITY = "liquidity"
+}

package/dist/order-book/generated/models/OrderCreation.d.ts

@@ -1,80 +1,80 @@
-import type { Address } from './Address';
-import type { AppData } from './AppData';
-import type { AppDataHash } from './AppDataHash';
-import type { BuyTokenDestination } from './BuyTokenDestination';
-import type { OrderKind } from './OrderKind';
-import type { SellTokenSource } from './SellTokenSource';
-import type { Signature } from './Signature';
-import type { SigningScheme } from './SigningScheme';
-import type { TokenAmount } from './TokenAmount';
-/**
- * Data a user provides when creating a new order.
- */
-export type OrderCreation = {
-    /**
-     * see `OrderParameters::sellToken`
-     */
-    sellToken: Address;
-    /**
-     * see `OrderParameters::buyToken`
-     */
-    buyToken: Address;
-    /**
-     * see `OrderParameters::receiver`
-     */
-    receiver?: Address | null;
-    /**
-     * see `OrderParameters::sellAmount`
-     */
-    sellAmount: TokenAmount;
-    /**
-     * see `OrderParameters::buyAmount`
-     */
-    buyAmount: TokenAmount;
-    /**
-     * see `OrderParameters::validTo`
-     */
-    validTo: number;
-    /**
-     * see `OrderParameters::feeAmount`
-     */
-    feeAmount: TokenAmount;
-    /**
-     * see `OrderParameters::kind`
-     */
-    kind: OrderKind;
-    /**
-     * see `OrderParameters::partiallyFillable`
-     */
-    partiallyFillable: boolean;
-    /**
-     * see `OrderParameters::sellTokenBalance`
-     */
-    sellTokenBalance?: SellTokenSource;
-    /**
-     * see `OrderParameters::buyTokenBalance`
-     */
-    buyTokenBalance?: BuyTokenDestination;
-    signingScheme: SigningScheme;
-    signature: Signature;
-    /**
-     * If set, the backend enforces that this address matches what is decoded as the *signer* of the signature. This helps catch errors with invalid signature encodings as the backend might otherwise silently work with an unexpected address that for example does not have any balance.
-     *
-     */
-    from?: Address | null;
-    /**
-     * Orders can optionally include a quote ID. This way the order can be linked to a quote and enable providing more metadata when analysing order slippage.
-     *
-     */
-    quoteId?: number | null;
-    /**
-     * This field comes in two forms for backward compatibility. The hash form will eventually stop being accepted.
-     *
-     */
-    appData: (AppData | AppDataHash);
-    /**
-     * May be set for debugging purposes. If set, this field is compared to what the backend internally calculates as the app data hash based on the contents of `appData`. If the hash does not match, an error is returned. If this field is set, then `appData` **MUST** be a string encoding of a JSON object.
-     *
-     */
-    appDataHash?: AppDataHash | null;
-};
+import type { Address } from './Address';
+import type { AppData } from './AppData';
+import type { AppDataHash } from './AppDataHash';
+import type { BuyTokenDestination } from './BuyTokenDestination';
+import type { OrderKind } from './OrderKind';
+import type { SellTokenSource } from './SellTokenSource';
+import type { Signature } from './Signature';
+import type { SigningScheme } from './SigningScheme';
+import type { TokenAmount } from './TokenAmount';
+/**
+ * Data a user provides when creating a new order.
+ */
+export type OrderCreation = {
+    /**
+     * see `OrderParameters::sellToken`
+     */
+    sellToken: Address;
+    /**
+     * see `OrderParameters::buyToken`
+     */
+    buyToken: Address;
+    /**
+     * see `OrderParameters::receiver`
+     */
+    receiver?: Address | null;
+    /**
+     * see `OrderParameters::sellAmount`
+     */
+    sellAmount: TokenAmount;
+    /**
+     * see `OrderParameters::buyAmount`
+     */
+    buyAmount: TokenAmount;
+    /**
+     * see `OrderParameters::validTo`
+     */
+    validTo: number;
+    /**
+     * see `OrderParameters::feeAmount`
+     */
+    feeAmount: TokenAmount;
+    /**
+     * see `OrderParameters::kind`
+     */
+    kind: OrderKind;
+    /**
+     * see `OrderParameters::partiallyFillable`
+     */
+    partiallyFillable: boolean;
+    /**
+     * see `OrderParameters::sellTokenBalance`
+     */
+    sellTokenBalance?: SellTokenSource;
+    /**
+     * see `OrderParameters::buyTokenBalance`
+     */
+    buyTokenBalance?: BuyTokenDestination;
+    signingScheme: SigningScheme;
+    signature: Signature;
+    /**
+     * If set, the backend enforces that this address matches what is decoded as the *signer* of the signature. This helps catch errors with invalid signature encodings as the backend might otherwise silently work with an unexpected address that for example does not have any balance.
+     *
+     */
+    from?: Address | null;
+    /**
+     * Orders can optionally include a quote ID. This way the order can be linked to a quote and enable providing more metadata when analysing order slippage.
+     *
+     */
+    quoteId?: number | null;
+    /**
+     * This field comes in two forms for backward compatibility. The hash form will eventually stop being accepted.
+     *
+     */
+    appData: (AppData | AppDataHash);
+    /**
+     * May be set for debugging purposes. If set, this field is compared to what the backend internally calculates as the app data hash based on the contents of `appData`. If the hash does not match, an error is returned. If this field is set, then `appData` **MUST** be a string encoding of a JSON object.
+     *
+     */
+    appDataHash?: AppDataHash | null;
+};

package/dist/order-book/generated/models/OrderKind.d.ts

@@ -1,7 +1,7 @@
-/**
- * Is this order a buy or sell?
- */
-export declare enum OrderKind {
-    BUY = "buy",
-    SELL = "sell"
-}
+/**
+ * Is this order a buy or sell?
+ */
+export declare enum OrderKind {
+    BUY = "buy",
+    SELL = "sell"
+}

package/dist/order-book/generated/models/OrderMetaData.d.ts

@@ -1,100 +1,100 @@
-import type { Address } from './Address';
-import type { BigUint } from './BigUint';
-import type { EthflowData } from './EthflowData';
-import type { OnchainOrderData } from './OnchainOrderData';
-import type { OrderClass } from './OrderClass';
-import type { OrderStatus } from './OrderStatus';
-import type { TokenAmount } from './TokenAmount';
-import type { UID } from './UID';
-/**
- * Extra order data that is returned to users when querying orders but not provided by users when creating orders.
- *
- */
-export type OrderMetaData = {
-    /**
-     * Creation time of the order. Encoded as ISO 8601 UTC.
-     */
-    creationDate: string;
-    class: OrderClass;
-    owner: Address;
-    uid: UID;
-    /**
-     * Unused field that is currently always set to `null` and will be removed in the future.
-     *
-     * @deprecated
-     */
-    availableBalance?: TokenAmount | null;
-    /**
-     * The total amount of `sellToken` that has been executed for this order including fees.
-     *
-     */
-    executedSellAmount: BigUint;
-    /**
-     * The total amount of `sellToken` that has been executed for this order without fees.
-     *
-     */
-    executedSellAmountBeforeFees: BigUint;
-    /**
-     * The total amount of `buyToken` that has been executed for this order.
-     *
-     */
-    executedBuyAmount: BigUint;
-    /**
-     * The total amount of fees that have been executed for this order.
-     */
-    executedFeeAmount: BigUint;
-    /**
-     * Has this order been invalidated?
-     */
-    invalidated: boolean;
-    /**
-     * Order status.
-     */
-    status: OrderStatus;
-    /**
-     * Amount that the signed fee would be without subsidies.
-     */
-    fullFeeAmount?: TokenAmount;
-    /**
-     * Liquidity orders are functionally the same as normal smart contract
-     * orders but are not placed with the intent of actively getting
-     * traded. Instead they facilitate the trade of normal orders by
-     * allowing them to be matched against liquidity orders which uses less
-     * gas and can have better prices than external liquidity.
-     *
-     * As such liquidity orders will only be used in order to improve
-     * settlement of normal orders. They should not be expected to be
-     * traded otherwise and should not expect to get surplus.
-     */
-    isLiquidityOrder?: boolean;
-    ethflowData?: EthflowData;
-    /**
-     * This represents the actual trader of an on-chain order.
-     * ### ethflow orders
-     * In this case, the `owner` would be the `EthFlow` contract and *not* the actual trader.
-     *
-     */
-    onchainUser?: Address;
-    /**
-     * There is some data only available for orders that are placed on-chain. This data can be found in this object.
-     *
-     */
-    onchainOrderData?: OnchainOrderData;
-    /**
-     * Surplus fee that the limit order was executed with.
-     */
-    executedSurplusFee?: BigUint;
-    /**
-     * Total fee charged for execution of the order. Contains network fee and protocol fees.
-     */
-    executedFee?: BigUint;
-    /**
-     * Token the executed fee was captured in.
-     */
-    executedFeeToken?: Address;
-    /**
-     * Full `appData`, which the contract-level `appData` is a hash of. See `OrderCreation` for more information.
-     *
-     */
-    fullAppData?: string | null;
-};
+import type { Address } from './Address';
+import type { BigUint } from './BigUint';
+import type { EthflowData } from './EthflowData';
+import type { OnchainOrderData } from './OnchainOrderData';
+import type { OrderClass } from './OrderClass';
+import type { OrderStatus } from './OrderStatus';
+import type { TokenAmount } from './TokenAmount';
+import type { UID } from './UID';
+/**
+ * Extra order data that is returned to users when querying orders but not provided by users when creating orders.
+ *
+ */
+export type OrderMetaData = {
+    /**
+     * Creation time of the order. Encoded as ISO 8601 UTC.
+     */
+    creationDate: string;
+    class: OrderClass;
+    owner: Address;
+    uid: UID;
+    /**
+     * Unused field that is currently always set to `null` and will be removed in the future.
+     *
+     * @deprecated
+     */
+    availableBalance?: TokenAmount | null;
+    /**
+     * The total amount of `sellToken` that has been executed for this order including fees.
+     *
+     */
+    executedSellAmount: BigUint;
+    /**
+     * The total amount of `sellToken` that has been executed for this order without fees.
+     *
+     */
+    executedSellAmountBeforeFees: BigUint;
+    /**
+     * The total amount of `buyToken` that has been executed for this order.
+     *
+     */
+    executedBuyAmount: BigUint;
+    /**
+     * The total amount of fees that have been executed for this order.
+     */
+    executedFeeAmount: BigUint;
+    /**
+     * Has this order been invalidated?
+     */
+    invalidated: boolean;
+    /**
+     * Order status.
+     */
+    status: OrderStatus;
+    /**
+     * Amount that the signed fee would be without subsidies.
+     */
+    fullFeeAmount?: TokenAmount;
+    /**
+     * Liquidity orders are functionally the same as normal smart contract
+     * orders but are not placed with the intent of actively getting
+     * traded. Instead they facilitate the trade of normal orders by
+     * allowing them to be matched against liquidity orders which uses less
+     * gas and can have better prices than external liquidity.
+     *
+     * As such liquidity orders will only be used in order to improve
+     * settlement of normal orders. They should not be expected to be
+     * traded otherwise and should not expect to get surplus.
+     */
+    isLiquidityOrder?: boolean;
+    ethflowData?: EthflowData;
+    /**
+     * This represents the actual trader of an on-chain order.
+     * ### ethflow orders
+     * In this case, the `owner` would be the `EthFlow` contract and *not* the actual trader.
+     *
+     */
+    onchainUser?: Address;
+    /**
+     * There is some data only available for orders that are placed on-chain. This data can be found in this object.
+     *
+     */
+    onchainOrderData?: OnchainOrderData;
+    /**
+     * Surplus fee that the limit order was executed with.
+     */
+    executedSurplusFee?: BigUint;
+    /**
+     * Total fee charged for execution of the order. Contains network fee and protocol fees.
+     */
+    executedFee?: BigUint;
+    /**
+     * Token the executed fee was captured in.
+     */
+    executedFeeToken?: Address;
+    /**
+     * Full `appData`, which the contract-level `appData` is a hash of. See `OrderCreation` for more information.
+     *
+     */
+    fullAppData?: string | null;
+};

package/dist/order-book/generated/models/OrderParameters.d.ts

@@ -1,53 +1,53 @@
-import type { Address } from './Address';
-import type { AppDataHash } from './AppDataHash';
-import type { BuyTokenDestination } from './BuyTokenDestination';
-import type { OrderKind } from './OrderKind';
-import type { SellTokenSource } from './SellTokenSource';
-import type { SigningScheme } from './SigningScheme';
-import type { TokenAmount } from './TokenAmount';
-/**
- * Order parameters.
- */
-export type OrderParameters = {
-    /**
-     * ERC-20 token to be sold.
-     */
-    sellToken: Address;
-    /**
-     * ERC-20 token to be bought.
-     */
-    buyToken: Address;
-    /**
-     * An optional Ethereum address to receive the proceeds of the trade instead of the owner (i.e. the order signer).
-     *
-     */
-    receiver?: Address | null;
-    /**
-     * Amount of `sellToken` to be sold in atoms.
-     */
-    sellAmount: TokenAmount;
-    /**
-     * Amount of `buyToken` to be bought in atoms.
-     */
-    buyAmount: TokenAmount;
-    /**
-     * Unix timestamp (`uint32`) until which the order is valid.
-     */
-    validTo: number;
-    appData: AppDataHash;
-    /**
-     * feeRatio * sellAmount + minimal_fee in atoms.
-     */
-    feeAmount: TokenAmount;
-    /**
-     * The kind is either a buy or sell order.
-     */
-    kind: OrderKind;
-    /**
-     * Is the order fill-or-kill or partially fillable?
-     */
-    partiallyFillable: boolean;
-    sellTokenBalance?: SellTokenSource;
-    buyTokenBalance?: BuyTokenDestination;
-    signingScheme?: SigningScheme;
-};
+import type { Address } from './Address';
+import type { AppDataHash } from './AppDataHash';
+import type { BuyTokenDestination } from './BuyTokenDestination';
+import type { OrderKind } from './OrderKind';
+import type { SellTokenSource } from './SellTokenSource';
+import type { SigningScheme } from './SigningScheme';
+import type { TokenAmount } from './TokenAmount';
+/**
+ * Order parameters.
+ */
+export type OrderParameters = {
+    /**
+     * ERC-20 token to be sold.
+     */
+    sellToken: Address;
+    /**
+     * ERC-20 token to be bought.
+     */
+    buyToken: Address;
+    /**
+     * An optional Ethereum address to receive the proceeds of the trade instead of the owner (i.e. the order signer).
+     *
+     */
+    receiver?: Address | null;
+    /**
+     * Amount of `sellToken` to be sold in atoms.
+     */
+    sellAmount: TokenAmount;
+    /**
+     * Amount of `buyToken` to be bought in atoms.
+     */
+    buyAmount: TokenAmount;
+    /**
+     * Unix timestamp (`uint32`) until which the order is valid.
+     */
+    validTo: number;
+    appData: AppDataHash;
+    /**
+     * feeRatio * sellAmount + minimal_fee in atoms.
+     */
+    feeAmount: TokenAmount;
+    /**
+     * The kind is either a buy or sell order.
+     */
+    kind: OrderKind;
+    /**
+     * Is the order fill-or-kill or partially fillable?
+     */
+    partiallyFillable: boolean;
+    sellTokenBalance?: SellTokenSource;
+    buyTokenBalance?: BuyTokenDestination;
+    signingScheme?: SigningScheme;
+};

package/dist/order-book/generated/models/OrderPostError.d.ts

@@ -1,35 +1,35 @@
-export type OrderPostError = {
-    errorType: OrderPostError.errorType;
-    description: string;
-};
-export declare namespace OrderPostError {
-    enum errorType {
-        DUPLICATED_ORDER = "DuplicatedOrder",
-        QUOTE_NOT_FOUND = "QuoteNotFound",
-        QUOTE_NOT_VERIFIED = "QuoteNotVerified",
-        INVALID_QUOTE = "InvalidQuote",
-        MISSING_FROM = "MissingFrom",
-        WRONG_OWNER = "WrongOwner",
-        INVALID_EIP1271SIGNATURE = "InvalidEip1271Signature",
-        INSUFFICIENT_BALANCE = "InsufficientBalance",
-        INSUFFICIENT_ALLOWANCE = "InsufficientAllowance",
-        INVALID_SIGNATURE = "InvalidSignature",
-        SELL_AMOUNT_OVERFLOW = "SellAmountOverflow",
-        TRANSFER_SIMULATION_FAILED = "TransferSimulationFailed",
-        ZERO_AMOUNT = "ZeroAmount",
-        INCOMPATIBLE_SIGNING_SCHEME = "IncompatibleSigningScheme",
-        TOO_MANY_LIMIT_ORDERS = "TooManyLimitOrders",
-        TOO_MUCH_GAS = "TooMuchGas",
-        UNSUPPORTED_BUY_TOKEN_DESTINATION = "UnsupportedBuyTokenDestination",
-        UNSUPPORTED_SELL_TOKEN_SOURCE = "UnsupportedSellTokenSource",
-        UNSUPPORTED_ORDER_TYPE = "UnsupportedOrderType",
-        INSUFFICIENT_VALID_TO = "InsufficientValidTo",
-        EXCESSIVE_VALID_TO = "ExcessiveValidTo",
-        INVALID_NATIVE_SELL_TOKEN = "InvalidNativeSellToken",
-        SAME_BUY_AND_SELL_TOKEN = "SameBuyAndSellToken",
-        UNSUPPORTED_TOKEN = "UnsupportedToken",
-        INVALID_APP_DATA = "InvalidAppData",
-        APP_DATA_HASH_MISMATCH = "AppDataHashMismatch",
-        APPDATA_FROM_MISMATCH = "AppdataFromMismatch"
-    }
-}
+export type OrderPostError = {
+    errorType: OrderPostError.errorType;
+    description: string;
+};
+export declare namespace OrderPostError {
+    enum errorType {
+        DUPLICATED_ORDER = "DuplicatedOrder",
+        QUOTE_NOT_FOUND = "QuoteNotFound",
+        QUOTE_NOT_VERIFIED = "QuoteNotVerified",
+        INVALID_QUOTE = "InvalidQuote",
+        MISSING_FROM = "MissingFrom",
+        WRONG_OWNER = "WrongOwner",
+        INVALID_EIP1271SIGNATURE = "InvalidEip1271Signature",
+        INSUFFICIENT_BALANCE = "InsufficientBalance",
+        INSUFFICIENT_ALLOWANCE = "InsufficientAllowance",
+        INVALID_SIGNATURE = "InvalidSignature",
+        SELL_AMOUNT_OVERFLOW = "SellAmountOverflow",
+        TRANSFER_SIMULATION_FAILED = "TransferSimulationFailed",
+        ZERO_AMOUNT = "ZeroAmount",
+        INCOMPATIBLE_SIGNING_SCHEME = "IncompatibleSigningScheme",
+        TOO_MANY_LIMIT_ORDERS = "TooManyLimitOrders",
+        TOO_MUCH_GAS = "TooMuchGas",
+        UNSUPPORTED_BUY_TOKEN_DESTINATION = "UnsupportedBuyTokenDestination",
+        UNSUPPORTED_SELL_TOKEN_SOURCE = "UnsupportedSellTokenSource",
+        UNSUPPORTED_ORDER_TYPE = "UnsupportedOrderType",
+        INSUFFICIENT_VALID_TO = "InsufficientValidTo",
+        EXCESSIVE_VALID_TO = "ExcessiveValidTo",
+        INVALID_NATIVE_SELL_TOKEN = "InvalidNativeSellToken",
+        SAME_BUY_AND_SELL_TOKEN = "SameBuyAndSellToken",
+        UNSUPPORTED_TOKEN = "UnsupportedToken",
+        INVALID_APP_DATA = "InvalidAppData",
+        APP_DATA_HASH_MISMATCH = "AppDataHashMismatch",
+        APPDATA_FROM_MISMATCH = "AppdataFromMismatch"
+    }
+}