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

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

@@ -1,16 +1,16 @@
-import type { Address } from './Address';
-import type { TokenAmount } from './TokenAmount';
-/**
- * Provides the information about an estimated price.
- *
- */
-export type AmountEstimate = {
-    /**
-     * The estimated amount
-     */
-    amount?: TokenAmount;
-    /**
-     * The token in which the amount is given
-     */
-    token?: Address;
-};
+import type { Address } from './Address';
+import type { TokenAmount } from './TokenAmount';
+/**
+ * Provides the information about an estimated price.
+ *
+ */
+export type AmountEstimate = {
+    /**
+     * The estimated amount
+     */
+    amount?: TokenAmount;
+    /**
+     * The token in which the amount is given
+     */
+    token?: Address;
+};

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

@@ -1,4 +1,4 @@
-/**
- * 32 bytes encoded as hex with `0x` prefix.
- */
-export type AppData = string;
+/**
+ * 32 bytes encoded as hex with `0x` prefix.
+ */
+export type AppData = string;

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

@@ -1,40 +1,40 @@
-import type { BigUint } from './BigUint';
-import type { Order } from './Order';
-/**
- * A batch auction for solving.
- *
- */
-export type Auction = {
-    /**
-     * The unique identifier of the auction. Increment whenever the backend creates a new auction.
-     *
-     */
-    id?: number;
-    /**
-     * The block number for the auction. Orders and prices are guaranteed to be valid on this
-     * block. Proposed settlements should be valid for this block as well.
-     *
-     */
-    block?: number;
-    /**
-     * The latest block on which a settlement has been processed.
-     *
-     * Note that under certain conditions it is possible for a settlement to have been mined as
-     * part of `block` but not have yet been processed.
-     *
-     */
-    latestSettlementBlock?: number;
-    /**
-     * The solvable orders included in the auction.
-     *
-     */
-    orders?: Array<Order>;
-    /**
-     * The reference prices for all traded tokens in the auction as a mapping from token
-     * addresses to a price denominated in native token (i.e. 1e18 represents a token that
-     * trades one to one with the native token). These prices are used for solution competition
-     * for computing surplus and converting fees to native token.
-     *
-     */
-    prices?: Record<string, BigUint>;
-};
+import type { BigUint } from './BigUint';
+import type { Order } from './Order';
+/**
+ * A batch auction for solving.
+ *
+ */
+export type Auction = {
+    /**
+     * The unique identifier of the auction. Increment whenever the backend creates a new auction.
+     *
+     */
+    id?: number;
+    /**
+     * The block number for the auction. Orders and prices are guaranteed to be valid on this
+     * block. Proposed settlements should be valid for this block as well.
+     *
+     */
+    block?: number;
+    /**
+     * The latest block on which a settlement has been processed.
+     *
+     * Note that under certain conditions it is possible for a settlement to have been mined as
+     * part of `block` but not have yet been processed.
+     *
+     */
+    latestSettlementBlock?: number;
+    /**
+     * The solvable orders included in the auction.
+     *
+     */
+    orders?: Array<Order>;
+    /**
+     * The reference prices for all traded tokens in the auction as a mapping from token
+     * addresses to a price denominated in native token (i.e. 1e18 represents a token that
+     * trades one to one with the native token). These prices are used for solution competition
+     * for computing surplus and converting fees to native token.
+     *
+     */
+    prices?: Record<string, BigUint>;
+};

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

@@ -1,4 +1,4 @@
-/**
- * A big unsigned integer encoded in decimal.
- */
-export type BigUint = string;
+/**
+ * A big unsigned integer encoded in decimal.
+ */
+export type BigUint = string;

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

@@ -1,7 +1,7 @@
-/**
- * Where should the buy token be transfered to?
- */
-export declare enum BuyTokenDestination {
-    ERC20 = "erc20",
-    INTERNAL = "internal"
-}
+/**
+ * Where should the buy token be transfered to?
+ */
+export declare enum BuyTokenDestination {
+    ERC20 = "erc20",
+    INTERNAL = "internal"
+}

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

@@ -1,4 +1,4 @@
-/**
- * 65 bytes encoded as hex with `0x` prefix. r + s + v from the spec.
- */
-export type EcdsaSignature = string;
+/**
+ * 65 bytes encoded as hex with `0x` prefix. r + s + v from the spec.
+ */
+export type EcdsaSignature = string;

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

@@ -1,7 +1,7 @@
-/**
- * How was the order signed?
- */
-export declare enum EcdsaSigningScheme {
-    EIP712 = "eip712",
-    ETHSIGN = "ethsign"
-}
+/**
+ * How was the order signed?
+ */
+export declare enum EcdsaSigningScheme {
+    EIP712 = "eip712",
+    ETHSIGN = "ethsign"
+}

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

@@ -1,20 +1,20 @@
-import type { TransactionHash } from './TransactionHash';
-/**
- * Provides the additional data for ethflow orders
- *
- */
-export type EthflowData = {
-    /**
-     * Specifies in which transaction the order was refunded. If
-     * this field is null the order was not yet refunded.
-     *
-     */
-    refundTxHash: TransactionHash | null;
-    /**
-     * Describes the valid to of an order ethflow order.
-     * Note that for ethflow orders, the valid_to encoded in the smart
-     * contract is max(uint)
-     *
-     */
-    userValidTo: number;
-};
+import type { TransactionHash } from './TransactionHash';
+/**
+ * Provides the additional data for ethflow orders
+ *
+ */
+export type EthflowData = {
+    /**
+     * Specifies in which transaction the order was refunded. If
+     * this field is null the order was not yet refunded.
+     *
+     */
+    refundTxHash: TransactionHash | null;
+    /**
+     * Describes the valid to of an order ethflow order.
+     * Note that for ethflow orders, the valid_to encoded in the smart
+     * contract is max(uint)
+     *
+     */
+    userValidTo: number;
+};

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

@@ -1,9 +1,9 @@
-import type { FeeInformation } from './FeeInformation';
-import type { TokenAmount } from './TokenAmount';
-export type FeeAndQuoteBuyResponse = {
-    fee?: FeeInformation;
-    /**
-     * The sell amount including the fee.
-     */
-    sellAmountBeforeFee?: TokenAmount;
-};
+import type { FeeInformation } from './FeeInformation';
+import type { TokenAmount } from './TokenAmount';
+export type FeeAndQuoteBuyResponse = {
+    fee?: FeeInformation;
+    /**
+     * The sell amount including the fee.
+     */
+    sellAmountBeforeFee?: TokenAmount;
+};

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

@@ -1,12 +1,12 @@
-export type FeeAndQuoteError = {
-    errorType: FeeAndQuoteError.errorType;
-    description: string;
-};
-export declare namespace FeeAndQuoteError {
-    enum errorType {
-        NO_LIQUIDITY = "NoLiquidity",
-        UNSUPPORTED_TOKEN = "UnsupportedToken",
-        AMOUNT_IS_ZERO = "AmountIsZero",
-        SELL_AMOUNT_DOES_NOT_COVER_FEE = "SellAmountDoesNotCoverFee"
-    }
-}
+export type FeeAndQuoteError = {
+    errorType: FeeAndQuoteError.errorType;
+    description: string;
+};
+export declare namespace FeeAndQuoteError {
+    enum errorType {
+        NO_LIQUIDITY = "NoLiquidity",
+        UNSUPPORTED_TOKEN = "UnsupportedToken",
+        AMOUNT_IS_ZERO = "AmountIsZero",
+        SELL_AMOUNT_DOES_NOT_COVER_FEE = "SellAmountDoesNotCoverFee"
+    }
+}

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

@@ -1,9 +1,9 @@
-import type { FeeInformation } from './FeeInformation';
-import type { TokenAmount } from './TokenAmount';
-export type FeeAndQuoteSellResponse = {
-    fee?: FeeInformation;
-    /**
-     * The buy amount after deducting the fee.
-     */
-    buyAmountAfterFee?: TokenAmount;
-};
+import type { FeeInformation } from './FeeInformation';
+import type { TokenAmount } from './TokenAmount';
+export type FeeAndQuoteSellResponse = {
+    fee?: FeeInformation;
+    /**
+     * The buy amount after deducting the fee.
+     */
+    buyAmountAfterFee?: TokenAmount;
+};

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

@@ -1,17 +1,17 @@
-import type { TokenAmount } from './TokenAmount';
-/**
- * Provides the information to calculate the fees.
- *
- */
-export type FeeInformation = {
-    /**
-     * Expiration date of the offered fee. Order service might not accept
-     * the fee after this expiration date. Encoded as ISO 8601 UTC.
-     *
-     */
-    expiration: string;
-    /**
-     * Absolute amount of fee charged per order in specified sellToken
-     */
-    amount: TokenAmount;
-};
+import type { TokenAmount } from './TokenAmount';
+/**
+ * Provides the information to calculate the fees.
+ *
+ */
+export type FeeInformation = {
+    /**
+     * Expiration date of the offered fee. Order service might not accept
+     * the fee after this expiration date. Encoded as ISO 8601 UTC.
+     *
+     */
+    expiration: string;
+    /**
+     * Absolute amount of fee charged per order in specified sellToken
+     */
+    amount: TokenAmount;
+};

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

@@ -1,10 +1,10 @@
-/**
- * The estimated native price for the token
- *
- */
-export type NativePriceResponse = {
-    /**
-     * the estimated price of the token
-     */
-    price?: number;
-};
+/**
+ * The estimated native price for the token
+ *
+ */
+export type NativePriceResponse = {
+    /**
+     * the estimated price of the token
+     */
+    price?: number;
+};

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

@@ -1,30 +1,30 @@
-import type { Address } from './Address';
-export type OnchainOrderData = {
-    /**
-     * If orders are placed as onchain orders, the owner of the order might
-     * be a smart contract, but not the user placing the order. The
-     * actual user will be provided in this field
-     *
-     */
-    sender: Address;
-    /**
-     * Describes the error, if the order placement was not
-     * successful. This could happen, for example, if the
-     * valid_to is too high, or no valid quote was found or generated
-     *
-     */
-    placementError?: OnchainOrderData.placementError;
-};
-export declare namespace OnchainOrderData {
-    /**
-     * Describes the error, if the order placement was not
-     * successful. This could happen, for example, if the
-     * valid_to is too high, or no valid quote was found or generated
-     *
-     */
-    enum placementError {
-        QUOTE_NOT_FOUND = "QuoteNotFound",
-        VALID_TO_TOO_FAR_IN_FUTURE = "ValidToTooFarInFuture",
-        PRE_VALIDATION_ERROR = "PreValidationError"
-    }
-}
+import type { Address } from './Address';
+export type OnchainOrderData = {
+    /**
+     * If orders are placed as onchain orders, the owner of the order might
+     * be a smart contract, but not the user placing the order. The
+     * actual user will be provided in this field
+     *
+     */
+    sender: Address;
+    /**
+     * Describes the error, if the order placement was not
+     * successful. This could happen, for example, if the
+     * valid_to is too high, or no valid quote was found or generated
+     *
+     */
+    placementError?: OnchainOrderData.placementError;
+};
+export declare namespace OnchainOrderData {
+    /**
+     * Describes the error, if the order placement was not
+     * successful. This could happen, for example, if the
+     * valid_to is too high, or no valid quote was found or generated
+     *
+     */
+    enum placementError {
+        QUOTE_NOT_FOUND = "QuoteNotFound",
+        VALID_TO_TOO_FAR_IN_FUTURE = "ValidToTooFarInFuture",
+        PRE_VALIDATION_ERROR = "PreValidationError"
+    }
+}

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

@@ -1,3 +1,3 @@
-import type { OrderCreation } from './OrderCreation';
-import type { OrderMetaData } from './OrderMetaData';
-export type Order = (OrderCreation & OrderMetaData);
+import type { OrderCreation } from './OrderCreation';
+import type { OrderMetaData } from './OrderMetaData';
+export type Order = (OrderCreation & OrderMetaData);

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

@@ -1,13 +1,13 @@
-import type { EcdsaSignature } from './EcdsaSignature';
-import type { EcdsaSigningScheme } from './EcdsaSigningScheme';
-/**
- * EIP-712 signature of struct OrderCancellation { orderUid: bytes } from the order's owner
- *
- */
-export type OrderCancellation = {
-    /**
-     * OrderCancellation signed by owner
-     */
-    signature: EcdsaSignature;
-    signingScheme: EcdsaSigningScheme;
-};
+import type { EcdsaSignature } from './EcdsaSignature';
+import type { EcdsaSigningScheme } from './EcdsaSigningScheme';
+/**
+ * EIP-712 signature of struct OrderCancellation { orderUid: bytes } from the order's owner
+ *
+ */
+export type OrderCancellation = {
+    /**
+     * OrderCancellation signed by owner
+     */
+    signature: EcdsaSignature;
+    signingScheme: EcdsaSigningScheme;
+};

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 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 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,25 +1,25 @@
-import type { Address } from './Address';
-import type { OrderParameters } from './OrderParameters';
-import type { Signature } from './Signature';
-import type { SigningScheme } from './SigningScheme';
-/**
- * Data a user provides when creating a new order.
- */
-export type OrderCreation = (OrderParameters & {
-    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 analyzing order slippage.
-     *
-     */
-    quoteId?: number | null;
-});
+import type { Address } from './Address';
+import type { OrderParameters } from './OrderParameters';
+import type { Signature } from './Signature';
+import type { SigningScheme } from './SigningScheme';
+/**
+ * Data a user provides when creating a new order.
+ */
+export type OrderCreation = (OrderParameters & {
+    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 analyzing order slippage.
+     *
+     */
+    quoteId?: number | null;
+});

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

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