@cowprotocol/widget-lib 4.0.2 → 4.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/widget-lib",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "CoW Swap Widget Library. Allows you to easily embed a CoW Swap widget on your website.",
   "repository": {
     "type": "git",
@@ -17,7 +17,7 @@
   "dependencies": {
     "@cowprotocol/cow-sdk": "9.0.2",
     "@cowprotocol/events": "^4.3.1",
-    "@cowprotocol/iframe-transport": "^2.2.3"
+    "@cowprotocol/iframe-transport": "^2.2.4"
   },
   "exports": {
     ".": {

package/types.d.ts

@@ -5,6 +5,39 @@ export type { OnTradeParamsPayload } from '@cowprotocol/events';
 export type PerTradeTypeConfig<T> = Partial<Record<TradeType, T>>;
 export type PerNetworkConfig<T> = Partial<Record<SupportedChainId, T>>;
 export type FlexibleConfig<T> = T | PerNetworkConfig<T> | PerTradeTypeConfig<T> | PerTradeTypeConfig<PerNetworkConfig<T>> | PerNetworkConfig<PerTradeTypeConfig<T>>;
+/**
+ * A single forbidden sell→buy token combination for the widget.
+ *
+ * Used as an entry in {@link CowSwapWidgetParams.tokenPairConstraints} to
+ * prevent users from creating orders that swap the given `sell` token for
+ * the given `buy` token (in that direction). Reversing the direction —
+ * trading `buy` for `sell` — is **not** blocked unless an explicit entry
+ * for the reverse pair is also supplied.
+ *
+ * Addresses are matched case-insensitively against the user's selected
+ * tokens; `chainId` must match the active widget chain for the entry to
+ * apply.
+ *
+ * @example
+ * ```ts
+ * tokenPairConstraints: [
+ *   {
+ *     sell: { address: '0xA0b8...eB48', chainId: SupportedChainId.MAINNET },
+ *     buy:  { address: '0xdAC1...1ec7', chainId: SupportedChainId.MAINNET },
+ *   },
+ * ]
+ * ```
+ */
+export type TokenPairConstraint = {
+    sell: {
+        address: string;
+        chainId: SupportedChainId;
+    };
+    buy: {
+        address: string;
+        chainId: SupportedChainId;
+    };
+};
 export declare enum WidgetMethodsEmit {
     ACTIVATE = "ACTIVATE",
     READY = "READY",
@@ -362,6 +395,10 @@ export interface CowSwapWidgetParams {
         whenPriceImpactIsUnknown?: boolean;
         whenPriceImpactIsHigherThan?: number;
     };
+    /**
+     * Disables trading of specific token pair
+     */
+    tokenPairConstraints?: TokenPairConstraint[];
     hooks?: Partial<{
         onBeforeApproval(payload: OnApprovalPayload): WidgetHookResult;
         onBeforeWrapOrUnwrap(payload: OnTradeParamsPayload): WidgetHookResult;