@gearbox-protocol/sdk 14.12.0-next.77 → 14.12.0-next.79

package/dist/types/model/liquidations.schema.d.ts

@@ -8,33 +8,33 @@ import { z } from "zod/v4";
  * {@link LiquidatableAccountFilter}
  **/
 declare const liquidatableAccountFilterSchema: z.ZodObject<{
-  chainIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
-  underlyingType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
-  paused: z.ZodOptional<z.ZodBoolean>;
-  rwa: z.ZodOptional<z.ZodBoolean>;
-  delayed: z.ZodOptional<z.ZodBoolean>;
+  chainIds: z.ZodOptional<z.ZodUnion<[z.ZodArray<z.ZodNumber>, z.ZodLiteral<"all">]>>;
+  underlyingType: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>, z.ZodLiteral<"all">]>>;
+  paused: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"all">]>>;
+  rwa: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"all">]>>;
+  delayed: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"all">]>>;
 }, z.core.$strip>;
 /**
  * {@link LiquidatableAccount}
  **/
 declare const liquidatableAccountSchema: z.ZodObject<{
   chainId: z.ZodNumber;
-  creditAccount: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
-  creditManager: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+  creditAccount: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+  creditManager: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
   asset: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   totalValue: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -42,11 +42,11 @@ declare const liquidatableAccountSchema: z.ZodObject<{
     }, z.core.$strip>;
   }, z.core.$strip>;
   repaymentAmount: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -54,11 +54,11 @@ declare const liquidatableAccountSchema: z.ZodObject<{
     }, z.core.$strip>;
   }, z.core.$strip>;
   estimatedProfit: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -73,11 +73,11 @@ declare const liquidatableAccountSchema: z.ZodObject<{
  * {@link InstantReceivedAsset}
  **/
 declare const instantReceivedAssetSchema: z.ZodObject<{
-  value: z.ZodBigInt;
+  value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
   valueUsd: z.ZodNullable<z.ZodNumber>;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
@@ -89,29 +89,29 @@ declare const instantReceivedAssetSchema: z.ZodObject<{
  * {@link DelayedReceivedAsset}
  **/
 declare const delayedReceivedAssetSchema: z.ZodObject<{
-  value: z.ZodBigInt;
+  value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
   valueUsd: z.ZodNullable<z.ZodNumber>;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   isDelayed: z.ZodLiteral<true>;
-  redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+  redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
   claimableAt: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * {@link ReceivedAsset}
  **/
 declare const receivedAssetSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
-  value: z.ZodBigInt;
+  value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
   valueUsd: z.ZodNullable<z.ZodNumber>;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
@@ -119,35 +119,35 @@ declare const receivedAssetSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   }, z.core.$strip>;
   isDelayed: z.ZodLiteral<false>;
 }, z.core.$strip>, z.ZodObject<{
-  value: z.ZodBigInt;
+  value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
   valueUsd: z.ZodNullable<z.ZodNumber>;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   isDelayed: z.ZodLiteral<true>;
-  redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+  redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
   claimableAt: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>], "isDelayed">;
 /**
  * {@link LiquidationApproval}
  **/
 declare const liquidationApprovalSchema: z.ZodObject<{
-  value: z.ZodBigInt;
+  value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
   valueUsd: z.ZodNullable<z.ZodNumber>;
   token: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
-  spender: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+  spender: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
 }, z.core.$strip>;
 /**
  * {@link LiquidationPosition}
@@ -158,18 +158,18 @@ declare const liquidationPositionSchema: z.ZodObject<{
   chainId: z.ZodNumber;
   sourceToken: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   output: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -178,33 +178,33 @@ declare const liquidationPositionSchema: z.ZodObject<{
   }, z.core.$strip>;
   claimableAt: z.ZodOptional<z.ZodNumber>;
   claimTx: z.ZodOptional<z.ZodObject<{
-    to: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
-    callData: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
-    value: z.ZodOptional<z.ZodBigInt>;
+    to: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    callData: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    value: z.ZodOptional<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>;
   }, z.core.$strip>>;
-  redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+  redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
 }, z.core.$strip>;
 /**
  * {@link LiquidationDetails}
  **/
 declare const liquidationDetailsSchema: z.ZodObject<{
   chainId: z.ZodNumber;
-  creditAccount: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
-  creditManager: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+  creditAccount: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+  creditManager: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
   asset: z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>;
   totalValue: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -212,11 +212,11 @@ declare const liquidationDetailsSchema: z.ZodObject<{
     }, z.core.$strip>;
   }, z.core.$strip>;
   estimatedProfit: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -227,11 +227,11 @@ declare const liquidationDetailsSchema: z.ZodObject<{
   paused: z.ZodBoolean;
   rwa: z.ZodBoolean;
   repaymentAmount: z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -239,11 +239,11 @@ declare const liquidationDetailsSchema: z.ZodObject<{
     }, z.core.$strip>;
   }, z.core.$strip>;
   receivedAssets: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
@@ -251,18 +251,18 @@ declare const liquidationDetailsSchema: z.ZodObject<{
     }, z.core.$strip>;
     isDelayed: z.ZodLiteral<false>;
   }, z.core.$strip>, z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
       assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
     }, z.core.$strip>;
     isDelayed: z.ZodLiteral<true>;
-    redeemer: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>>;
+    redeemer: z.ZodOptional<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>>;
     claimableAt: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>], "isDelayed">>;
   isLiquidatorEligible: z.ZodBoolean;
@@ -270,24 +270,24 @@ declare const liquidationDetailsSchema: z.ZodObject<{
   kycProtocol: z.ZodOptional<z.ZodString>;
   kycToken: z.ZodOptional<z.ZodObject<{
     chainId: z.ZodNumber;
-    address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
     symbol: z.ZodString;
     name: z.ZodString;
     decimals: z.ZodNumber;
     assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
   }, z.core.$strip>>;
   approve: z.ZodOptional<z.ZodObject<{
-    value: z.ZodBigInt;
+    value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
     token: z.ZodObject<{
       chainId: z.ZodNumber;
-      address: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
       symbol: z.ZodString;
       name: z.ZodString;
       decimals: z.ZodNumber;
       assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
     }, z.core.$strip>;
-    spender: z.ZodPipe<z.ZodString, z.ZodTransform<`0x${string}`, string>>;
+    spender: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
 //#endregion

package/dist/types/model/opportunities.d.ts

@@ -1,5 +1,6 @@
 import { Curator } from "./curators.js";
 import { Amount, AssetType, Bps, ChainId, Leverage, Timestamp, Token } from "./primitives.js";
+import { Filterable } from "./filters.js";
 import { Address } from "viem";
 //#region src/model/opportunities.d.ts
 /**
@@ -350,48 +351,51 @@ declare function opportunityId(opportunity: Opportunity): OpportunityId;
  * The list is filtered in memory over final values, so there is no paging and
  * no sorting: a screen sorts what it got.
  *
- * Every criterion is optional and an omitted one matches any value, so an empty
- * filter is the same as no filter at all. Criteria combine with AND.
+ * Every condition is optional and an omitted one matches any value, so an
+ * empty filter is the same as no filter at all. A condition can also be set to
+ * `"all"` to say the same thing explicitly, which is what a UI whose state has
+ * an "any" option holds, see {@link Filterable}. Conditions combine with AND.
  **/
 interface OpportunityFilter {
   /**
    * Keep only pools or only strategies.
    **/
-  kind?: OpportunityKind;
+  kind?: Filterable<OpportunityKind>;
   /**
    * Keep only opportunities on these chains.
    **/
-  chainIds?: ChainId[];
+  chainIds?: Filterable<ChainId[]>;
   /**
    * Keep only opportunities whose {@link OpportunityBase.underlyingToken} is of
    * this class, which for an RWA market means the class of the token its
    * wrapper holds. An underlying that is not in the hardcoded table never
    * matches, so a set filter also drops unclassified rows.
    **/
-  underlyingType?: AssetType;
+  underlyingType?: Filterable<AssetType>;
   /**
    * Keep only paused opportunities, or only unpaused ones.
    **/
-  paused?: boolean;
+  paused?: Filterable<boolean>;
   /**
    * Keep only opportunities being wound down, or only the ones that are not.
    **/
-  sunset?: boolean;
+  sunset?: Filterable<boolean>;
   /**
    * Keep only opportunities that accept RWA collateral, or only the ones that
    * do not.
    **/
-  rwa?: boolean;
+  rwa?: Filterable<boolean>;
 }
 /**
- * Whether an opportunity satisfies every criterion of a filter.
+ * Whether an opportunity satisfies every condition of a filter.
  *
- * This is the single definition of what each criterion means: every source
+ * This is the single definition of what each condition means: every source
  * builds its rows first and runs them through here, so the chain and the
  * backend cannot disagree on what a filter selects.
  *
  * @param opportunity - Row to test.
- * @param filter - Criteria to test against. An absent filter matches anything.
+ * @param filter - Conditions to test against. An absent filter matches
+ * anything.
  **/
 declare function matchesOpportunityFilter(opportunity: Opportunity, filter?: OpportunityFilter): boolean;
 /**