@cowprotocol/cow-sdk 2.0.0-alpha.1 → 2.0.0-alpha.3

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

@@ -1,86 +1,86 @@
-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;
-    /**
-     * Amount of sellToken available for the settlement contract to spend on behalf of the owner. Null if API was unable to fetch balance or if the order status isn't Open.
-     */
-    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;
-    /**
-     * For ethflow orders - order that are placed onchain with native eth -, this field
-     * contains a struct with two variables user_valid_to and is_refunded
-     *
-     */
-    ethflowData?: EthflowData;
-    /**
-     * TODO: smth related to ETH flow
-     *
-     */
-    onchainUser?: Address;
-    /**
-     * There is some data only available for orders that are placed onchain. This data
-     * can be found in this object
-     *
-     */
-    onchainOrderData?: OnchainOrderData;
-    /**
-     * Surplus fee that the limit order was executed with.
-     */
-    executedSurplusFee?: BigUint | 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;
+    /**
+     * Amount of sellToken available for the settlement contract to spend on behalf of the owner. Null if API was unable to fetch balance or if the order status isn't Open.
+     */
+    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;
+    /**
+     * For ethflow orders - order that are placed onchain with native eth -, this field
+     * contains a struct with two variables user_valid_to and is_refunded
+     *
+     */
+    ethflowData?: EthflowData;
+    /**
+     * TODO: smth related to ETH flow
+     *
+     */
+    onchainUser?: Address;
+    /**
+     * There is some data only available for orders that are placed onchain. This data
+     * can be found in this object
+     *
+     */
+    onchainOrderData?: OnchainOrderData;
+    /**
+     * Surplus fee that the limit order was executed with.
+     */
+    executedSurplusFee?: BigUint | null;
+};

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

@@ -1,60 +1,60 @@
-import type { Address } from './Address';
-import type { AppData } from './AppData';
-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 = {
-    /**
-     * ERC20 token to be sold
-     */
-    sellToken: Address;
-    /**
-     * ERC20 token to be bought
-     */
-    buyToken: Address;
-    /**
-     * An optional 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 until the order is valid. uint32.
-     */
-    validTo: number;
-    /**
-     * Arbitrary application specific data that can be added to an order. This can
-     * also be used to ensure uniqueness between two orders with otherwise the
-     * exact same parameters.
-     *
-     */
-    appData: AppData;
-    /**
-     * Fees: feeRatio * sellAmount + minimal_fee in atoms
-     */
-    feeAmount: TokenAmount;
-    /**
-     * The kind is either a buy or sell order
-     */
-    kind: OrderKind;
-    /**
-     * Is this a fill-or-kill order or a partially fillable order?
-     */
-    partiallyFillable: boolean;
-    sellTokenBalance?: SellTokenSource;
-    buyTokenBalance?: BuyTokenDestination;
-    signingScheme?: SigningScheme;
-};
+import type { Address } from './Address';
+import type { AppData } from './AppData';
+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 = {
+    /**
+     * ERC20 token to be sold
+     */
+    sellToken: Address;
+    /**
+     * ERC20 token to be bought
+     */
+    buyToken: Address;
+    /**
+     * An optional 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 until the order is valid. uint32.
+     */
+    validTo: number;
+    /**
+     * Arbitrary application specific data that can be added to an order. This can
+     * also be used to ensure uniqueness between two orders with otherwise the
+     * exact same parameters.
+     *
+     */
+    appData: AppData;
+    /**
+     * Fees: feeRatio * sellAmount + minimal_fee in atoms
+     */
+    feeAmount: TokenAmount;
+    /**
+     * The kind is either a buy or sell order
+     */
+    kind: OrderKind;
+    /**
+     * Is this a fill-or-kill order or a partially fillable order?
+     */
+    partiallyFillable: boolean;
+    sellTokenBalance?: SellTokenSource;
+    buyTokenBalance?: BuyTokenDestination;
+    signingScheme?: SigningScheme;
+};

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

@@ -1,27 +1,27 @@
-export type OrderPostError = {
-    errorType: OrderPostError.errorType;
-    description: string;
-};
-export declare namespace OrderPostError {
-    enum errorType {
-        DUPLICATE_ORDER = "DuplicateOrder",
-        INSUFFICIENT_FEE = "InsufficientFee",
-        INSUFFICIENT_ALLOWANCE = "InsufficientAllowance",
-        INSUFFICIENT_BALANCE = "InsufficientBalance",
-        INSUFFICIENT_VALID_TO = "InsufficientValidTo",
-        EXCESSIVE_VALID_TO = "ExcessiveValidTo",
-        INVALID_SIGNATURE = "InvalidSignature",
-        TRANSFER_ETH_TO_CONTRACT = "TransferEthToContract",
-        TRANSFER_SIMULATION_FAILED = "TransferSimulationFailed",
-        UNSUPPORTED_TOKEN = "UnsupportedToken",
-        WRONG_OWNER = "WrongOwner",
-        MISSING_FROM = "MissingFrom",
-        SAME_BUY_AND_SELL_TOKEN = "SameBuyAndSellToken",
-        ZERO_AMOUNT = "ZeroAmount",
-        UNSUPPORTED_BUY_TOKEN_DESTINATION = "UnsupportedBuyTokenDestination",
-        UNSUPPORTED_SELL_TOKEN_SOURCE = "UnsupportedSellTokenSource",
-        UNSUPPORTED_ORDER_TYPE = "UnsupportedOrderType",
-        UNSUPPORTED_SIGNATURE = "UnsupportedSignature",
-        TOO_MANY_LIMIT_ORDERS = "TooManyLimitOrders"
-    }
-}
+export type OrderPostError = {
+    errorType: OrderPostError.errorType;
+    description: string;
+};
+export declare namespace OrderPostError {
+    enum errorType {
+        DUPLICATE_ORDER = "DuplicateOrder",
+        INSUFFICIENT_FEE = "InsufficientFee",
+        INSUFFICIENT_ALLOWANCE = "InsufficientAllowance",
+        INSUFFICIENT_BALANCE = "InsufficientBalance",
+        INSUFFICIENT_VALID_TO = "InsufficientValidTo",
+        EXCESSIVE_VALID_TO = "ExcessiveValidTo",
+        INVALID_SIGNATURE = "InvalidSignature",
+        TRANSFER_ETH_TO_CONTRACT = "TransferEthToContract",
+        TRANSFER_SIMULATION_FAILED = "TransferSimulationFailed",
+        UNSUPPORTED_TOKEN = "UnsupportedToken",
+        WRONG_OWNER = "WrongOwner",
+        MISSING_FROM = "MissingFrom",
+        SAME_BUY_AND_SELL_TOKEN = "SameBuyAndSellToken",
+        ZERO_AMOUNT = "ZeroAmount",
+        UNSUPPORTED_BUY_TOKEN_DESTINATION = "UnsupportedBuyTokenDestination",
+        UNSUPPORTED_SELL_TOKEN_SOURCE = "UnsupportedSellTokenSource",
+        UNSUPPORTED_ORDER_TYPE = "UnsupportedOrderType",
+        UNSUPPORTED_SIGNATURE = "UnsupportedSignature",
+        TOO_MANY_LIMIT_ORDERS = "TooManyLimitOrders"
+    }
+}

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

@@ -1,47 +1,47 @@
-import type { Address } from './Address';
-import type { AppData } from './AppData';
-import type { BuyTokenDestination } from './BuyTokenDestination';
-import type { OrderQuoteSide } from './OrderQuoteSide';
-import type { OrderQuoteValidity } from './OrderQuoteValidity';
-import type { PriceQuality } from './PriceQuality';
-import type { SellTokenSource } from './SellTokenSource';
-import type { SigningScheme } from './SigningScheme';
-/**
- * Request fee and price quote.
- */
-export type OrderQuoteRequest = (OrderQuoteSide & OrderQuoteValidity & {
-    /**
-     * ERC20 token to be sold
-     */
-    sellToken: Address;
-    /**
-     * ERC20 token to be bought
-     */
-    buyToken: Address;
-    /**
-     * An optional address to receive the proceeds of the trade instead of the
-     * owner (i.e. the order signer).
-     *
-     */
-    receiver?: Address | null;
-    /**
-     * Arbitrary application specific data that can be added to an order. This can
-     * also be used to ensure uniqueness between two orders with otherwise the
-     * exact same parameters.
-     *
-     */
-    appData?: AppData;
-    /**
-     * Is this a fill-or-kill order or a partially fillable order?
-     */
-    partiallyFillable?: boolean;
-    sellTokenBalance?: SellTokenSource;
-    buyTokenBalance?: BuyTokenDestination;
-    from: Address;
-    priceQuality?: PriceQuality;
-    signingScheme?: SigningScheme;
-    /**
-     * Flag to signal whether the order is intended for onchain order placement. Only valid for non ECDSA-signed orders
-     */
-    onchainOrder?: any;
-});
+import type { Address } from './Address';
+import type { AppData } from './AppData';
+import type { BuyTokenDestination } from './BuyTokenDestination';
+import type { OrderQuoteSide } from './OrderQuoteSide';
+import type { OrderQuoteValidity } from './OrderQuoteValidity';
+import type { PriceQuality } from './PriceQuality';
+import type { SellTokenSource } from './SellTokenSource';
+import type { SigningScheme } from './SigningScheme';
+/**
+ * Request fee and price quote.
+ */
+export type OrderQuoteRequest = (OrderQuoteSide & OrderQuoteValidity & {
+    /**
+     * ERC20 token to be sold
+     */
+    sellToken: Address;
+    /**
+     * ERC20 token to be bought
+     */
+    buyToken: Address;
+    /**
+     * An optional address to receive the proceeds of the trade instead of the
+     * owner (i.e. the order signer).
+     *
+     */
+    receiver?: Address | null;
+    /**
+     * Arbitrary application specific data that can be added to an order. This can
+     * also be used to ensure uniqueness between two orders with otherwise the
+     * exact same parameters.
+     *
+     */
+    appData?: AppData;
+    /**
+     * Is this a fill-or-kill order or a partially fillable order?
+     */
+    partiallyFillable?: boolean;
+    sellTokenBalance?: SellTokenSource;
+    buyTokenBalance?: BuyTokenDestination;
+    from: Address;
+    priceQuality?: PriceQuality;
+    signingScheme?: SigningScheme;
+    /**
+     * Flag to signal whether the order is intended for onchain order placement. Only valid for non ECDSA-signed orders
+     */
+    onchainOrder?: any;
+});

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

@@ -1,23 +1,23 @@
-import type { Address } from './Address';
-import type { OrderParameters } from './OrderParameters';
-/**
- * An order quoted by the back end that can be directly signed and
- * submitted to the order creation backend.
- *
- */
-export type OrderQuoteResponse = {
-    quote: OrderParameters;
-    from?: Address;
-    /**
-     * Expiration date of the offered fee. Order service might not accept
-     * the fee after this expiration date. Encoded as ISO 8601 UTC.
-     *
-     */
-    expiration: string;
-    /**
-     * Order ID linked to a quote to enable providing more metadata when analyzing
-     * order slippage.
-     *
-     */
-    id?: number;
-};
+import type { Address } from './Address';
+import type { OrderParameters } from './OrderParameters';
+/**
+ * An order quoted by the back end that can be directly signed and
+ * submitted to the order creation backend.
+ *
+ */
+export type OrderQuoteResponse = {
+    quote: OrderParameters;
+    from?: Address;
+    /**
+     * Expiration date of the offered fee. Order service might not accept
+     * the fee after this expiration date. Encoded as ISO 8601 UTC.
+     *
+     */
+    expiration: string;
+    /**
+     * Order ID linked to a quote to enable providing more metadata when analyzing
+     * order slippage.
+     *
+     */
+    id?: number;
+};

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

@@ -1,30 +1,30 @@
-import type { TokenAmount } from './TokenAmount';
-/**
- * The buy or sell side when quoting an order.
- */
-export type OrderQuoteSide = ({
-    kind: OrderQuoteSide.kind;
-    /**
-     * The total amount that is available for the order. From this value, the fee
-     * is deducted and the buy amount is calculated.
-     *
-     */
-    sellAmountBeforeFee: TokenAmount;
-} | {
-    kind: OrderQuoteSide.kind;
-    /**
-     * The sell amount for the order.
-     */
-    sellAmountAfterFee: TokenAmount;
-} | {
-    kind: OrderQuoteSide.kind;
-    /**
-     * The buy amount for the order.
-     */
-    buyAmountAfterFee: TokenAmount;
-});
-export declare namespace OrderQuoteSide {
-    enum kind {
-        SELL = "sell"
-    }
-}
+import type { TokenAmount } from './TokenAmount';
+/**
+ * The buy or sell side when quoting an order.
+ */
+export type OrderQuoteSide = ({
+    kind: OrderQuoteSide.kind;
+    /**
+     * The total amount that is available for the order. From this value, the fee
+     * is deducted and the buy amount is calculated.
+     *
+     */
+    sellAmountBeforeFee: TokenAmount;
+} | {
+    kind: OrderQuoteSide.kind;
+    /**
+     * The sell amount for the order.
+     */
+    sellAmountAfterFee: TokenAmount;
+} | {
+    kind: OrderQuoteSide.kind;
+    /**
+     * The buy amount for the order.
+     */
+    buyAmountAfterFee: TokenAmount;
+});
+export declare namespace OrderQuoteSide {
+    enum kind {
+        SELL = "sell"
+    }
+}

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

@@ -1,14 +1,14 @@
-/**
- * The validity for the order
- */
-export type OrderQuoteValidity = ({
-    /**
-     * Unix timestamp until the order is valid. uint32.
-     */
-    validTo?: number;
-} | {
-    /**
-     * Number of seconds that the order should be valid for. uint32.
-     */
-    validFor?: number;
-});
+/**
+ * The validity for the order
+ */
+export type OrderQuoteValidity = ({
+    /**
+     * Unix timestamp until the order is valid. uint32.
+     */
+    validTo?: number;
+} | {
+    /**
+     * Number of seconds that the order should be valid for. uint32.
+     */
+    validFor?: number;
+});

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

@@ -1,10 +1,10 @@
-/**
- * The current order status
- */
-export declare enum OrderStatus {
-    PRESIGNATURE_PENDING = "presignaturePending",
-    OPEN = "open",
-    FULFILLED = "fulfilled",
-    CANCELLED = "cancelled",
-    EXPIRED = "expired"
-}
+/**
+ * The current order status
+ */
+export declare enum OrderStatus {
+    PRESIGNATURE_PENDING = "presignaturePending",
+    OPEN = "open",
+    FULFILLED = "fulfilled",
+    CANCELLED = "cancelled",
+    EXPIRED = "expired"
+}

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

@@ -1,4 +1,4 @@
-/**
- * Empty signature bytes. Used for "presign" signatures.
- */
-export type PreSignature = string;
+/**
+ * Empty signature bytes. Used for "presign" signatures.
+ */
+export type PreSignature = string;

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

@@ -1,9 +1,9 @@
-/**
- * How good should the price estimate be?
- * Note that orders are supposed to be created from "optimal" price estimates.
- *
- */
-export declare enum PriceQuality {
-    FAST = "fast",
-    OPTIMAL = "optimal"
-}
+/**
+ * How good should the price estimate be?
+ * Note that orders are supposed to be created from "optimal" price estimates.
+ *
+ */
+export declare enum PriceQuality {
+    FAST = "fast",
+    OPTIMAL = "optimal"
+}