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

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

@@ -1,30 +1,30 @@
-import type { Address } from './Address';
-import type { AuctionOrder } from './AuctionOrder';
-import type { AuctionPrices } from './AuctionPrices';
-/**
- * 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 solvable orders included in the auction.
-     *
-     */
-    orders?: Array<AuctionOrder>;
-    prices?: AuctionPrices;
-    /**
-     * List of addresses on whose surplus will count towards the objective value of their solution (unlike other orders that were created by the solver).
-     *
-     */
-    surplusCapturingJitOrderOwners?: Array<Address>;
-};
+import type { Address } from './Address';
+import type { AuctionOrder } from './AuctionOrder';
+import type { AuctionPrices } from './AuctionPrices';
+/**
+ * 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 solvable orders included in the auction.
+     *
+     */
+    orders?: Array<AuctionOrder>;
+    prices?: AuctionPrices;
+    /**
+     * List of addresses on whose surplus will count towards the objective value of their solution (unlike other orders that were created by the solver).
+     *
+     */
+    surplusCapturingJitOrderOwners?: Array<Address>;
+};

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

@@ -1,92 +1,92 @@
-import type { Address } from './Address';
-import type { AppDataHash } from './AppDataHash';
-import type { BuyTokenDestination } from './BuyTokenDestination';
-import type { FeePolicy } from './FeePolicy';
-import type { InteractionData } from './InteractionData';
-import type { OrderClass } from './OrderClass';
-import type { OrderKind } from './OrderKind';
-import type { Quote } from './Quote';
-import type { SellTokenSource } from './SellTokenSource';
-import type { Signature } from './Signature';
-import type { TokenAmount } from './TokenAmount';
-import type { UID } from './UID';
-/**
- * A solvable order included in the current batch auction. Contains the data forwarded to solvers for solving.
- *
- */
-export type AuctionOrder = {
-    uid: UID;
-    /**
-     * see `OrderParameters::sellToken`
-     */
-    sellToken: Address;
-    /**
-     * see `OrderParameters::buyToken`
-     */
-    buyToken: Address;
-    /**
-     * see `OrderParameters::sellAmount`
-     */
-    sellAmount: TokenAmount;
-    /**
-     * see `OrderParameters::buyAmount`
-     */
-    buyAmount: TokenAmount;
-    /**
-     * Creation time of the order. Denominated in epoch seconds.
-     */
-    created: string;
-    /**
-     * see `OrderParameters::validTo`
-     */
-    validTo: number;
-    /**
-     * see `OrderParameters::kind`
-     */
-    kind: OrderKind;
-    /**
-     * see `OrderParameters::receiver`
-     */
-    receiver: Address | null;
-    owner: Address;
-    /**
-     * see `OrderParameters::partiallyFillable`
-     */
-    partiallyFillable: boolean;
-    /**
-     * Currently executed amount of sell/buy token, depending on the order kind.
-     *
-     */
-    executed: TokenAmount;
-    /**
-     * The pre-interactions that need to be executed before the first execution of the order.
-     *
-     */
-    preInteractions: Array<InteractionData>;
-    /**
-     * The post-interactions that need to be executed after the execution of the order.
-     *
-     */
-    postInteractions: Array<InteractionData>;
-    /**
-     * see `OrderParameters::sellTokenBalance`
-     */
-    sellTokenBalance: SellTokenSource;
-    /**
-     * see `OrderParameters::buyTokenBalance`
-     */
-    buyTokenBalance: BuyTokenDestination;
-    class: OrderClass;
-    appData: AppDataHash;
-    signature: Signature;
-    /**
-     * The fee policies that are used to compute the protocol fees for this order.
-     *
-     */
-    protocolFees: Array<FeePolicy>;
-    /**
-     * A winning quote.
-     *
-     */
-    quote?: Quote;
-};
+import type { Address } from './Address';
+import type { AppDataHash } from './AppDataHash';
+import type { BuyTokenDestination } from './BuyTokenDestination';
+import type { FeePolicy } from './FeePolicy';
+import type { InteractionData } from './InteractionData';
+import type { OrderClass } from './OrderClass';
+import type { OrderKind } from './OrderKind';
+import type { Quote } from './Quote';
+import type { SellTokenSource } from './SellTokenSource';
+import type { Signature } from './Signature';
+import type { TokenAmount } from './TokenAmount';
+import type { UID } from './UID';
+/**
+ * A solvable order included in the current batch auction. Contains the data forwarded to solvers for solving.
+ *
+ */
+export type AuctionOrder = {
+    uid: UID;
+    /**
+     * see `OrderParameters::sellToken`
+     */
+    sellToken: Address;
+    /**
+     * see `OrderParameters::buyToken`
+     */
+    buyToken: Address;
+    /**
+     * see `OrderParameters::sellAmount`
+     */
+    sellAmount: TokenAmount;
+    /**
+     * see `OrderParameters::buyAmount`
+     */
+    buyAmount: TokenAmount;
+    /**
+     * Creation time of the order. Denominated in epoch seconds.
+     */
+    created: string;
+    /**
+     * see `OrderParameters::validTo`
+     */
+    validTo: number;
+    /**
+     * see `OrderParameters::kind`
+     */
+    kind: OrderKind;
+    /**
+     * see `OrderParameters::receiver`
+     */
+    receiver: Address | null;
+    owner: Address;
+    /**
+     * see `OrderParameters::partiallyFillable`
+     */
+    partiallyFillable: boolean;
+    /**
+     * Currently executed amount of sell/buy token, depending on the order kind.
+     *
+     */
+    executed: TokenAmount;
+    /**
+     * The pre-interactions that need to be executed before the first execution of the order.
+     *
+     */
+    preInteractions: Array<InteractionData>;
+    /**
+     * The post-interactions that need to be executed after the execution of the order.
+     *
+     */
+    postInteractions: Array<InteractionData>;
+    /**
+     * see `OrderParameters::sellTokenBalance`
+     */
+    sellTokenBalance: SellTokenSource;
+    /**
+     * see `OrderParameters::buyTokenBalance`
+     */
+    buyTokenBalance: BuyTokenDestination;
+    class: OrderClass;
+    appData: AppDataHash;
+    signature: Signature;
+    /**
+     * The fee policies that are used to compute the protocol fees for this order.
+     *
+     */
+    protocolFees: Array<FeePolicy>;
+    /**
+     * A winning quote.
+     *
+     */
+    quote?: Quote;
+};

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

@@ -1,6 +1,6 @@
-import type { BigUint } from './BigUint';
-/**
- * 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.
- *
- */
-export type AuctionPrices = Record<string, BigUint>;
+import type { BigUint } from './BigUint';
+/**
+ * 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.
+ *
+ */
+export type AuctionPrices = 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 `buyToken` be transferred to?
- */
-export declare enum BuyTokenDestination {
-    ERC20 = "erc20",
-    INTERNAL = "internal"
-}
+/**
+ * Where should the `buyToken` be transferred to?
+ */
+export declare enum BuyTokenDestination {
+    ERC20 = "erc20",
+    INTERNAL = "internal"
+}

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

@@ -1,4 +1,4 @@
-/**
- * Some `calldata` sent to a contract in a transaction encoded as a hex with `0x` prefix.
- */
-export type CallData = string;
+/**
+ * Some `calldata` sent to a contract in a transaction encoded as a hex with `0x` prefix.
+ */
+export type CallData = string;

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

@@ -1,14 +1,14 @@
-import type { AuctionPrices } from './AuctionPrices';
-import type { UID } from './UID';
-/**
- * The components that describe a batch auction for the solver competition.
- *
- */
-export type CompetitionAuction = {
-    /**
-     * The UIDs of the orders included in the auction.
-     *
-     */
-    orders?: Array<UID>;
-    prices?: AuctionPrices;
-};
+import type { AuctionPrices } from './AuctionPrices';
+import type { UID } from './UID';
+/**
+ * The components that describe a batch auction for the solver competition.
+ *
+ */
+export type CompetitionAuction = {
+    /**
+     * The UIDs of the orders included in the auction.
+     *
+     */
+    orders?: Array<UID>;
+    prices?: AuctionPrices;
+};

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

@@ -1,29 +1,29 @@
-import type { ExecutedAmounts } from './ExecutedAmounts';
-export type CompetitionOrderStatus = {
-    type: CompetitionOrderStatus.type;
-    /**
-     * A list of solvers who participated in the latest competition, sorted
-     * by score in ascending order, where the last element is the winner.
-     *
-     * The presence of executed amounts defines whether the solver provided
-     * a solution for the desired order.
-     */
-    value?: Array<{
-        /**
-         * Name of the solver.
-         */
-        solver: string;
-        executedAmounts?: ExecutedAmounts;
-    }>;
-};
-export declare namespace CompetitionOrderStatus {
-    enum type {
-        OPEN = "open",
-        SCHEDULED = "scheduled",
-        ACTIVE = "active",
-        SOLVED = "solved",
-        EXECUTING = "executing",
-        TRADED = "traded",
-        CANCELLED = "cancelled"
-    }
-}
+import type { ExecutedAmounts } from './ExecutedAmounts';
+export type CompetitionOrderStatus = {
+    type: CompetitionOrderStatus.type;
+    /**
+     * A list of solvers who participated in the latest competition, sorted
+     * by score in ascending order, where the last element is the winner.
+     *
+     * The presence of executed amounts defines whether the solver provided
+     * a solution for the desired order.
+     */
+    value?: Array<{
+        /**
+         * Name of the solver.
+         */
+        solver: string;
+        executedAmounts?: ExecutedAmounts;
+    }>;
+};
+export declare namespace CompetitionOrderStatus {
+    enum type {
+        OPEN = "open",
+        SCHEDULED = "scheduled",
+        ACTIVE = "active",
+        SOLVED = "solved",
+        EXECUTING = "executing",
+        TRADED = "traded",
+        CANCELLED = "cancelled"
+    }
+}

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 `validTo` of an order ethflow order.
-     *
-     * **NOTE**: For ethflow orders, the `validTo` encoded in the smart
-     * contract is `type(uint256).max`.
-     *
-     */
-    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 `validTo` of an order ethflow order.
+     *
+     * **NOTE**: For ethflow orders, the `validTo` encoded in the smart
+     * contract is `type(uint256).max`.
+     *
+     */
+    userValidTo: number;
+};

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

@@ -1,5 +1,5 @@
-import type { BigUint } from './BigUint';
-export type ExecutedAmounts = {
-    sell: BigUint;
-    buy: BigUint;
-};
+import type { BigUint } from './BigUint';
+export type ExecutedAmounts = {
+    sell: BigUint;
+    buy: BigUint;
+};

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

@@ -1,8 +1,8 @@
-import type { Address } from './Address';
-import type { FeePolicy } from './FeePolicy';
-import type { TokenAmount } from './TokenAmount';
-export type ExecutedProtocolFee = {
-    policy?: FeePolicy;
-    amount?: TokenAmount;
-    token?: Address;
-};
+import type { Address } from './Address';
+import type { FeePolicy } from './FeePolicy';
+import type { TokenAmount } from './TokenAmount';
+export type ExecutedProtocolFee = {
+    policy?: FeePolicy;
+    amount?: TokenAmount;
+    token?: Address;
+};

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

@@ -1,7 +1,7 @@
-import type { PriceImprovement } from './PriceImprovement';
-import type { Surplus } from './Surplus';
-import type { Volume } from './Volume';
-/**
- * Defines the ways to calculate the protocol fee.
- */
-export type FeePolicy = (Surplus | Volume | PriceImprovement);
+import type { PriceImprovement } from './PriceImprovement';
+import type { Surplus } from './Surplus';
+import type { Volume } from './Volume';
+/**
+ * Defines the ways to calculate the protocol fee.
+ */
+export type FeePolicy = (Surplus | Volume | PriceImprovement);

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

@@ -1,11 +1,11 @@
-import type { Address } from './Address';
-import type { CallData } from './CallData';
-import type { TokenAmount } from './TokenAmount';
-export type InteractionData = {
-    target?: Address;
-    value?: TokenAmount;
-    /**
-     * The call data to be used for the interaction.
-     */
-    call_data?: Array<CallData>;
-};
+import type { Address } from './Address';
+import type { CallData } from './CallData';
+import type { TokenAmount } from './TokenAmount';
+export type InteractionData = {
+    target?: Address;
+    value?: TokenAmount;
+    /**
+     * The call data to be used for the interaction.
+     */
+    call_data?: Array<CallData>;
+};

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

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

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

@@ -1,24 +1,24 @@
-import type { Address } from './Address';
-export type OnchainOrderData = {
-    /**
-     * If orders are placed as on-chain 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 `validTo` 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 `validTo` 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 on-chain 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 `validTo` 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 `validTo` 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,14 +1,14 @@
-import type { EcdsaSignature } from './EcdsaSignature';
-import type { EcdsaSigningScheme } from './EcdsaSigningScheme';
-/**
- * [EIP-712](https://eips.ethereum.org/EIPS/eip-712) signature of struct
- * `OrderCancellation(bytes orderUid)` 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](https://eips.ethereum.org/EIPS/eip-712) signature of struct
+ * `OrderCancellation(bytes orderUid)` from the order's owner.
+ *
+ */
+export type OrderCancellation = {
+    /**
+     * OrderCancellation signed by owner
+     */
+    signature: EcdsaSignature;
+    signingScheme: EcdsaSigningScheme;
+};