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

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

@@ -1,58 +1,58 @@
-import type { Address } from './Address';
-import type { AppData } from './AppData';
-import type { AppDataHash } from './AppDataHash';
-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 & {
-    /**
-     * ERC-20 token to be sold
-     */
-    sellToken: Address;
-    /**
-     * ERC-20 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;
-    /**
-     * AppData which will be assigned to the order.
-     *
-     * Expects either a string JSON doc as defined on
-     * [AppData](https://github.com/cowprotocol/app-data) or a hex
-     * encoded string for backwards compatibility.
-     *
-     * When the first format is used, it's possible to provide the
-     * derived appDataHash field.
-     */
-    appData?: (AppData | AppDataHash);
-    /**
-     * The hash of the stringified JSON appData doc.
-     *
-     * If present, `appData` field must be set with the aforementioned
-     * data where this hash is derived from.
-     *
-     * In case they differ, the call will fail.
-     */
-    appDataHash?: AppDataHash;
-    sellTokenBalance?: SellTokenSource;
-    buyTokenBalance?: BuyTokenDestination;
-    from: Address;
-    priceQuality?: PriceQuality;
-    signingScheme?: SigningScheme;
-    /**
-     * Flag to signal whether the order is intended for on-chain order placement. Only valid for non ECDSA-signed orders."
-     *
-     */
-    onchainOrder?: any;
-});
+import type { Address } from './Address';
+import type { AppData } from './AppData';
+import type { AppDataHash } from './AppDataHash';
+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 & {
+    /**
+     * ERC-20 token to be sold
+     */
+    sellToken: Address;
+    /**
+     * ERC-20 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;
+    /**
+     * AppData which will be assigned to the order.
+     *
+     * Expects either a string JSON doc as defined on
+     * [AppData](https://github.com/cowprotocol/app-data) or a hex
+     * encoded string for backwards compatibility.
+     *
+     * When the first format is used, it's possible to provide the
+     * derived appDataHash field.
+     */
+    appData?: (AppData | AppDataHash);
+    /**
+     * The hash of the stringified JSON appData doc.
+     *
+     * If present, `appData` field must be set with the aforementioned
+     * data where this hash is derived from.
+     *
+     * In case they differ, the call will fail.
+     */
+    appDataHash?: AppDataHash;
+    sellTokenBalance?: SellTokenSource;
+    buyTokenBalance?: BuyTokenDestination;
+    from: Address;
+    priceQuality?: PriceQuality;
+    signingScheme?: SigningScheme;
+    /**
+     * Flag to signal whether the order is intended for on-chain order placement. Only valid for non ECDSA-signed orders."
+     *
+     */
+    onchainOrder?: any;
+});

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

@@ -1,27 +1,27 @@
-import type { Address } from './Address';
-import type { OrderParameters } from './OrderParameters';
-/**
- * An order quoted by the backend 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;
-    /**
-     * Quote ID linked to a quote to enable providing more metadata when analysing order slippage.
-     *
-     */
-    id?: number;
-    /**
-     * Whether it was possible to verify that the quoted amounts are accurate using a simulation.
-     *
-     */
-    verified: boolean;
-};
+import type { Address } from './Address';
+import type { OrderParameters } from './OrderParameters';
+/**
+ * An order quoted by the backend 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;
+    /**
+     * Quote ID linked to a quote to enable providing more metadata when analysing order slippage.
+     *
+     */
+    id?: number;
+    /**
+     * Whether it was possible to verify that the quoted amounts are accurate using a simulation.
+     *
+     */
+    verified: boolean;
+};

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

@@ -1,26 +1,26 @@
-import type { OrderQuoteSideKindBuy } from './OrderQuoteSideKindBuy';
-import type { OrderQuoteSideKindSell } from './OrderQuoteSideKindSell';
-import type { TokenAmount } from './TokenAmount';
-/**
- * The buy or sell side when quoting an order.
- */
-export type OrderQuoteSide = ({
-    kind: OrderQuoteSideKindSell;
-    /**
-     * 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: OrderQuoteSideKindSell;
-    /**
-     * The `sellAmount` for the order.
-     */
-    sellAmountAfterFee: TokenAmount;
-} | {
-    kind: OrderQuoteSideKindBuy;
-    /**
-     * The `buyAmount` for the order.
-     */
-    buyAmountAfterFee: TokenAmount;
-});
+import type { OrderQuoteSideKindBuy } from './OrderQuoteSideKindBuy';
+import type { OrderQuoteSideKindSell } from './OrderQuoteSideKindSell';
+import type { TokenAmount } from './TokenAmount';
+/**
+ * The buy or sell side when quoting an order.
+ */
+export type OrderQuoteSide = ({
+    kind: OrderQuoteSideKindSell;
+    /**
+     * 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: OrderQuoteSideKindSell;
+    /**
+     * The `sellAmount` for the order.
+     */
+    sellAmountAfterFee: TokenAmount;
+} | {
+    kind: OrderQuoteSideKindBuy;
+    /**
+     * The `buyAmount` for the order.
+     */
+    buyAmountAfterFee: TokenAmount;
+});

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

@@ -1,3 +1,3 @@
-export declare enum OrderQuoteSideKindBuy {
-    BUY = "buy"
-}
+export declare enum OrderQuoteSideKindBuy {
+    BUY = "buy"
+}

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

@@ -1,3 +1,3 @@
-export declare enum OrderQuoteSideKindSell {
-    SELL = "sell"
-}
+export declare enum OrderQuoteSideKindSell {
+    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 (`uint32`) until which the order is valid.
-     */
-    validTo?: number;
-} | {
-    /**
-     * Number (`uint32`) of seconds that the order should be valid for.
-     */
-    validFor?: number;
-});
+/**
+ * The validity for the order.
+ */
+export type OrderQuoteValidity = ({
+    /**
+     * Unix timestamp (`uint32`) until which the order is valid.
+     */
+    validTo?: number;
+} | {
+    /**
+     * Number (`uint32`) of seconds that the order should be valid for.
+     */
+    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/PriceEstimationError.d.ts

@@ -1,12 +1,12 @@
-export type PriceEstimationError = {
-    errorType: PriceEstimationError.errorType;
-    description: string;
-};
-export declare namespace PriceEstimationError {
-    enum errorType {
-        QUOTE_NOT_VERIFIED = "QuoteNotVerified",
-        UNSUPPORTED_TOKEN = "UnsupportedToken",
-        ZERO_AMOUNT = "ZeroAmount",
-        UNSUPPORTED_ORDER_TYPE = "UnsupportedOrderType"
-    }
-}
+export type PriceEstimationError = {
+    errorType: PriceEstimationError.errorType;
+    description: string;
+};
+export declare namespace PriceEstimationError {
+    enum errorType {
+        QUOTE_NOT_VERIFIED = "QuoteNotVerified",
+        UNSUPPORTED_TOKEN = "UnsupportedToken",
+        ZERO_AMOUNT = "ZeroAmount",
+        UNSUPPORTED_ORDER_TYPE = "UnsupportedOrderType"
+    }
+}

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

@@ -1,12 +1,12 @@
-import type { Quote } from './Quote';
-/**
- * The protocol fee is taken as a percent of the order price improvement which is a difference between the executed price and the best quote.
- */
-export type PriceImprovement = {
-    factor: number;
-    maxVolumeFactor: number;
-    /**
-     * The best quote received.
-     */
-    quote: Quote;
-};
+import type { Quote } from './Quote';
+/**
+ * The protocol fee is taken as a percent of the order price improvement which is a difference between the executed price and the best quote.
+ */
+export type PriceImprovement = {
+    factor: number;
+    maxVolumeFactor: number;
+    /**
+     * The best quote received.
+     */
+    quote: Quote;
+};

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

@@ -1,16 +1,16 @@
-/**
- * How good should the price estimate be?
- *
- * Fast: The price estimate is chosen among the fastest N price estimates.
- * Optimal: The price estimate is chosen among all price estimates.
- * Verified: The price estimate is chosen among all verified/simulated
- * price estimates.
- *
- * **NOTE**: Orders are supposed to be created from `verified` or `optimal`
- * price estimates.
- */
-export declare enum PriceQuality {
-    FAST = "fast",
-    OPTIMAL = "optimal",
-    VERIFIED = "verified"
-}
+/**
+ * How good should the price estimate be?
+ *
+ * Fast: The price estimate is chosen among the fastest N price estimates.
+ * Optimal: The price estimate is chosen among all price estimates.
+ * Verified: The price estimate is chosen among all verified/simulated
+ * price estimates.
+ *
+ * **NOTE**: Orders are supposed to be created from `verified` or `optimal`
+ * price estimates.
+ */
+export declare enum PriceQuality {
+    FAST = "fast",
+    OPTIMAL = "optimal",
+    VERIFIED = "verified"
+}

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

@@ -1,19 +1,19 @@
-import type { TokenAmount } from './TokenAmount';
-/**
- * A calculated order quote.
- *
- */
-export type Quote = {
-    /**
-     * The amount of the sell token.
-     */
-    sellAmount?: TokenAmount;
-    /**
-     * The amount of the buy token.
-     */
-    buyAmount?: TokenAmount;
-    /**
-     * The amount that needs to be paid, denominated in the sell token.
-     */
-    fee?: TokenAmount;
-};
+import type { TokenAmount } from './TokenAmount';
+/**
+ * A calculated order quote.
+ *
+ */
+export type Quote = {
+    /**
+     * The amount of the sell token.
+     */
+    sellAmount?: TokenAmount;
+    /**
+     * The amount of the buy token.
+     */
+    buyAmount?: TokenAmount;
+    /**
+     * The amount that needs to be paid, denominated in the sell token.
+     */
+    fee?: TokenAmount;
+};

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

@@ -1,8 +1,8 @@
-/**
- * Where should the `sellToken` be drawn from?
- */
-export declare enum SellTokenSource {
-    ERC20 = "erc20",
-    INTERNAL = "internal",
-    EXTERNAL = "external"
-}
+/**
+ * Where should the `sellToken` be drawn from?
+ */
+export declare enum SellTokenSource {
+    ERC20 = "erc20",
+    INTERNAL = "internal",
+    EXTERNAL = "external"
+}

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

@@ -1,6 +1,6 @@
-import type { EcdsaSignature } from './EcdsaSignature';
-import type { PreSignature } from './PreSignature';
-/**
- * A signature.
- */
-export type Signature = (EcdsaSignature | PreSignature);
+import type { EcdsaSignature } from './EcdsaSignature';
+import type { PreSignature } from './PreSignature';
+/**
+ * A signature.
+ */
+export type Signature = (EcdsaSignature | PreSignature);

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

@@ -1,9 +1,9 @@
-/**
- * How was the order signed?
- */
-export declare enum SigningScheme {
-    EIP712 = "eip712",
-    ETHSIGN = "ethsign",
-    PRESIGN = "presign",
-    EIP1271 = "eip1271"
-}
+/**
+ * How was the order signed?
+ */
+export declare enum SigningScheme {
+    EIP712 = "eip712",
+    ETHSIGN = "ethsign",
+    PRESIGN = "presign",
+    EIP1271 = "eip1271"
+}

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

@@ -1,30 +1,30 @@
-import type { CompetitionAuction } from './CompetitionAuction';
-import type { SolverSettlement } from './SolverSettlement';
-import type { TransactionHash } from './TransactionHash';
-/**
- * The settlements submitted by every solver for a specific auction.
- * The `auctionId` corresponds to the id external solvers are provided
- * with.
- *
- */
-export type SolverCompetitionResponse = {
-    /**
-     * The ID of the auction the competition info is for.
-     */
-    auctionId?: number;
-    /**
-     * The hash of the transaction that the winning solution of this info was submitted in.
-     */
-    transactionHash?: TransactionHash | null;
-    /**
-     * Gas price used for ranking solutions.
-     */
-    gasPrice?: number;
-    liquidityCollectedBlock?: number;
-    competitionSimulationBlock?: number;
-    auction?: CompetitionAuction;
-    /**
-     * Maps from solver name to object describing that solver's settlement.
-     */
-    solutions?: Array<SolverSettlement>;
-};
+import type { CompetitionAuction } from './CompetitionAuction';
+import type { SolverSettlement } from './SolverSettlement';
+import type { TransactionHash } from './TransactionHash';
+/**
+ * The settlements submitted by every solver for a specific auction.
+ * The `auctionId` corresponds to the id external solvers are provided
+ * with.
+ *
+ */
+export type SolverCompetitionResponse = {
+    /**
+     * The ID of the auction the competition info is for.
+     */
+    auctionId?: number;
+    /**
+     * The hash of the transaction that the winning solution of this info was submitted in.
+     */
+    transactionHash?: TransactionHash | null;
+    /**
+     * Gas price used for ranking solutions.
+     */
+    gasPrice?: number;
+    liquidityCollectedBlock?: number;
+    competitionSimulationBlock?: number;
+    auction?: CompetitionAuction;
+    /**
+     * Maps from solver name to object describing that solver's settlement.
+     */
+    solutions?: Array<SolverSettlement>;
+};

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

@@ -1,47 +1,47 @@
-import type { BigUint } from './BigUint';
-import type { UID } from './UID';
-export type SolverSettlement = {
-    /**
-     * Name of the solver.
-     */
-    solver?: string;
-    /**
-     * The address used by the solver to execute the settlement on-chain.
-     *
-     * This field is missing for old settlements, the zero address has been
-     * used instead.
-     */
-    solverAddress?: string;
-    objective?: {
-        /**
-         * The total objective value used for ranking solutions.
-         */
-        total?: number;
-        surplus?: number;
-        fees?: number;
-        cost?: number;
-        gas?: number;
-    };
-    /**
-     * The score of the current auction as defined in [CIP-20](https://snapshot.org/#/cow.eth/proposal/0x2d3f9bd1ea72dca84b03e97dda3efc1f4a42a772c54bd2037e8b62e7d09a491f).
-     * It is `null` for old auctions.
-     *
-     */
-    score?: BigUint | null;
-    /**
-     * The prices of tokens for settled user orders as passed to the settlement contract.
-     *
-     */
-    clearingPrices?: Record<string, BigUint>;
-    /**
-     * Touched orders.
-     */
-    orders?: Array<{
-        id?: UID;
-        executedAmount?: BigUint;
-    }>;
-    /**
-     * whether the solution is a winner (received the right to get executed) or not
-     */
-    isWinner?: boolean;
-};
+import type { BigUint } from './BigUint';
+import type { UID } from './UID';
+export type SolverSettlement = {
+    /**
+     * Name of the solver.
+     */
+    solver?: string;
+    /**
+     * The address used by the solver to execute the settlement on-chain.
+     *
+     * This field is missing for old settlements, the zero address has been
+     * used instead.
+     */
+    solverAddress?: string;
+    objective?: {
+        /**
+         * The total objective value used for ranking solutions.
+         */
+        total?: number;
+        surplus?: number;
+        fees?: number;
+        cost?: number;
+        gas?: number;
+    };
+    /**
+     * The score of the current auction as defined in [CIP-20](https://snapshot.org/#/cow.eth/proposal/0x2d3f9bd1ea72dca84b03e97dda3efc1f4a42a772c54bd2037e8b62e7d09a491f).
+     * It is `null` for old auctions.
+     *
+     */
+    score?: BigUint | null;
+    /**
+     * The prices of tokens for settled user orders as passed to the settlement contract.
+     *
+     */
+    clearingPrices?: Record<string, BigUint>;
+    /**
+     * Touched orders.
+     */
+    orders?: Array<{
+        id?: UID;
+        executedAmount?: BigUint;
+    }>;
+    /**
+     * whether the solution is a winner (received the right to get executed) or not
+     */
+    isWinner?: boolean;
+};

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

@@ -1,7 +1,7 @@
-/**
- * The protocol fee is taken as a percent of the surplus.
- */
-export type Surplus = {
-    factor: number;
-    maxVolumeFactor: number;
-};
+/**
+ * The protocol fee is taken as a percent of the surplus.
+ */
+export type Surplus = {
+    factor: number;
+    maxVolumeFactor: number;
+};

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

@@ -1,4 +1,4 @@
-/**
- * Amount of a token. `uint256` encoded in decimal.
- */
-export type TokenAmount = string;
+/**
+ * Amount of a token. `uint256` encoded in decimal.
+ */
+export type TokenAmount = string;