@compass-labs/api-sdk 2.2.28 → 2.2.29-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/README.md +2 -2
  2. package/dist/commonjs/funcs/creditCreditBundle.d.ts +1 -1
  3. package/dist/commonjs/funcs/creditCreditBundle.js +1 -1
  4. package/dist/commonjs/funcs/earnEarnVaults.js +1 -0
  5. package/dist/commonjs/funcs/earnEarnVaults.js.map +1 -1
  6. package/dist/commonjs/lib/config.d.ts +2 -2
  7. package/dist/commonjs/lib/config.js +2 -2
  8. package/dist/commonjs/lib/config.js.map +1 -1
  9. package/dist/commonjs/lib/files.d.ts +13 -0
  10. package/dist/commonjs/lib/files.d.ts.map +1 -1
  11. package/dist/commonjs/lib/files.js +19 -0
  12. package/dist/commonjs/lib/files.js.map +1 -1
  13. package/dist/commonjs/lib/sdks.d.ts.map +1 -1
  14. package/dist/commonjs/lib/sdks.js +8 -4
  15. package/dist/commonjs/lib/sdks.js.map +1 -1
  16. package/dist/commonjs/lib/url.d.ts.map +1 -1
  17. package/dist/commonjs/lib/url.js +4 -2
  18. package/dist/commonjs/lib/url.js.map +1 -1
  19. package/dist/commonjs/models/components/approvetransferresponse.d.ts +8 -2
  20. package/dist/commonjs/models/components/approvetransferresponse.d.ts.map +1 -1
  21. package/dist/commonjs/models/components/approvetransferresponse.js +2 -2
  22. package/dist/commonjs/models/components/approvetransferresponse.js.map +1 -1
  23. package/dist/commonjs/models/components/creditborrowrequest.d.ts +10 -10
  24. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  25. package/dist/commonjs/models/components/creditborrowrequest.js +3 -3
  26. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  27. package/dist/commonjs/models/components/creditrepayrequest.d.ts +7 -7
  28. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  29. package/dist/commonjs/models/components/creditrepayrequest.js +2 -2
  30. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  31. package/dist/commonjs/models/components/credittransfertoaddressparams.d.ts +44 -0
  32. package/dist/commonjs/models/components/credittransfertoaddressparams.d.ts.map +1 -0
  33. package/dist/commonjs/models/components/credittransfertoaddressparams.js +63 -0
  34. package/dist/commonjs/models/components/credittransfertoaddressparams.js.map +1 -0
  35. package/dist/commonjs/models/components/credituseroperation.d.ts +5 -4
  36. package/dist/commonjs/models/components/credituseroperation.d.ts.map +1 -1
  37. package/dist/commonjs/models/components/credituseroperation.js +3 -0
  38. package/dist/commonjs/models/components/credituseroperation.js.map +1 -1
  39. package/dist/commonjs/models/components/depositforburnresponse.d.ts +8 -2
  40. package/dist/commonjs/models/components/depositforburnresponse.d.ts.map +1 -1
  41. package/dist/commonjs/models/components/depositforburnresponse.js +3 -2
  42. package/dist/commonjs/models/components/depositforburnresponse.js.map +1 -1
  43. package/dist/commonjs/models/components/earnmanageresponse.d.ts +8 -2
  44. package/dist/commonjs/models/components/earnmanageresponse.d.ts.map +1 -1
  45. package/dist/commonjs/models/components/earnmanageresponse.js +3 -2
  46. package/dist/commonjs/models/components/earnmanageresponse.js.map +1 -1
  47. package/dist/commonjs/models/components/earnswapresponse.d.ts +11 -2
  48. package/dist/commonjs/models/components/earnswapresponse.d.ts.map +1 -1
  49. package/dist/commonjs/models/components/earnswapresponse.js +3 -2
  50. package/dist/commonjs/models/components/earnswapresponse.js.map +1 -1
  51. package/dist/commonjs/models/components/earntransferresponse.d.ts +11 -2
  52. package/dist/commonjs/models/components/earntransferresponse.d.ts.map +1 -1
  53. package/dist/commonjs/models/components/earntransferresponse.js +2 -2
  54. package/dist/commonjs/models/components/earntransferresponse.js.map +1 -1
  55. package/dist/commonjs/models/components/index.d.ts +1 -0
  56. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  57. package/dist/commonjs/models/components/index.js +1 -0
  58. package/dist/commonjs/models/components/index.js.map +1 -1
  59. package/dist/commonjs/models/components/vaultinfo.d.ts +4 -0
  60. package/dist/commonjs/models/components/vaultinfo.d.ts.map +1 -1
  61. package/dist/commonjs/models/components/vaultinfo.js +2 -0
  62. package/dist/commonjs/models/components/vaultinfo.js.map +1 -1
  63. package/dist/commonjs/models/operations/v2earnvaults.d.ts +14 -0
  64. package/dist/commonjs/models/operations/v2earnvaults.d.ts.map +1 -1
  65. package/dist/commonjs/models/operations/v2earnvaults.js +9 -1
  66. package/dist/commonjs/models/operations/v2earnvaults.js.map +1 -1
  67. package/dist/commonjs/sdk/credit.d.ts +1 -1
  68. package/dist/commonjs/sdk/credit.js +1 -1
  69. package/dist/esm/funcs/creditCreditBundle.d.ts +1 -1
  70. package/dist/esm/funcs/creditCreditBundle.js +1 -1
  71. package/dist/esm/funcs/earnEarnVaults.js +1 -0
  72. package/dist/esm/funcs/earnEarnVaults.js.map +1 -1
  73. package/dist/esm/lib/config.d.ts +2 -2
  74. package/dist/esm/lib/config.js +2 -2
  75. package/dist/esm/lib/config.js.map +1 -1
  76. package/dist/esm/lib/files.d.ts +13 -0
  77. package/dist/esm/lib/files.d.ts.map +1 -1
  78. package/dist/esm/lib/files.js +18 -0
  79. package/dist/esm/lib/files.js.map +1 -1
  80. package/dist/esm/lib/sdks.d.ts.map +1 -1
  81. package/dist/esm/lib/sdks.js +8 -4
  82. package/dist/esm/lib/sdks.js.map +1 -1
  83. package/dist/esm/lib/url.d.ts.map +1 -1
  84. package/dist/esm/lib/url.js +4 -2
  85. package/dist/esm/lib/url.js.map +1 -1
  86. package/dist/esm/models/components/approvetransferresponse.d.ts +8 -2
  87. package/dist/esm/models/components/approvetransferresponse.d.ts.map +1 -1
  88. package/dist/esm/models/components/approvetransferresponse.js +2 -2
  89. package/dist/esm/models/components/approvetransferresponse.js.map +1 -1
  90. package/dist/esm/models/components/creditborrowrequest.d.ts +10 -10
  91. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  92. package/dist/esm/models/components/creditborrowrequest.js +3 -3
  93. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  94. package/dist/esm/models/components/creditrepayrequest.d.ts +7 -7
  95. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  96. package/dist/esm/models/components/creditrepayrequest.js +2 -2
  97. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  98. package/dist/esm/models/components/credittransfertoaddressparams.d.ts +44 -0
  99. package/dist/esm/models/components/credittransfertoaddressparams.d.ts.map +1 -0
  100. package/dist/esm/models/components/credittransfertoaddressparams.js +25 -0
  101. package/dist/esm/models/components/credittransfertoaddressparams.js.map +1 -0
  102. package/dist/esm/models/components/credituseroperation.d.ts +5 -4
  103. package/dist/esm/models/components/credituseroperation.d.ts.map +1 -1
  104. package/dist/esm/models/components/credituseroperation.js +3 -0
  105. package/dist/esm/models/components/credituseroperation.js.map +1 -1
  106. package/dist/esm/models/components/depositforburnresponse.d.ts +8 -2
  107. package/dist/esm/models/components/depositforburnresponse.d.ts.map +1 -1
  108. package/dist/esm/models/components/depositforburnresponse.js +3 -2
  109. package/dist/esm/models/components/depositforburnresponse.js.map +1 -1
  110. package/dist/esm/models/components/earnmanageresponse.d.ts +8 -2
  111. package/dist/esm/models/components/earnmanageresponse.d.ts.map +1 -1
  112. package/dist/esm/models/components/earnmanageresponse.js +3 -2
  113. package/dist/esm/models/components/earnmanageresponse.js.map +1 -1
  114. package/dist/esm/models/components/earnswapresponse.d.ts +11 -2
  115. package/dist/esm/models/components/earnswapresponse.d.ts.map +1 -1
  116. package/dist/esm/models/components/earnswapresponse.js +3 -2
  117. package/dist/esm/models/components/earnswapresponse.js.map +1 -1
  118. package/dist/esm/models/components/earntransferresponse.d.ts +11 -2
  119. package/dist/esm/models/components/earntransferresponse.d.ts.map +1 -1
  120. package/dist/esm/models/components/earntransferresponse.js +2 -2
  121. package/dist/esm/models/components/earntransferresponse.js.map +1 -1
  122. package/dist/esm/models/components/index.d.ts +1 -0
  123. package/dist/esm/models/components/index.d.ts.map +1 -1
  124. package/dist/esm/models/components/index.js +1 -0
  125. package/dist/esm/models/components/index.js.map +1 -1
  126. package/dist/esm/models/components/vaultinfo.d.ts +4 -0
  127. package/dist/esm/models/components/vaultinfo.d.ts.map +1 -1
  128. package/dist/esm/models/components/vaultinfo.js +2 -0
  129. package/dist/esm/models/components/vaultinfo.js.map +1 -1
  130. package/dist/esm/models/operations/v2earnvaults.d.ts +14 -0
  131. package/dist/esm/models/operations/v2earnvaults.d.ts.map +1 -1
  132. package/dist/esm/models/operations/v2earnvaults.js +7 -0
  133. package/dist/esm/models/operations/v2earnvaults.js.map +1 -1
  134. package/dist/esm/sdk/credit.d.ts +1 -1
  135. package/dist/esm/sdk/credit.js +1 -1
  136. package/docs/models/components/approvetransferresponse.md +3 -40
  137. package/docs/models/components/creditborrowrequest.md +3 -3
  138. package/docs/models/components/creditborrowrequestamountin.md +1 -1
  139. package/docs/models/components/creditrepayrequest.md +2 -2
  140. package/docs/models/components/credittransfertoaddressparams.md +28 -0
  141. package/docs/models/components/credittransfertoaddressparamsamount.md +19 -0
  142. package/docs/models/components/credituseroperationbody.md +11 -0
  143. package/docs/models/components/depositforburnresponse.md +3 -37
  144. package/docs/models/components/earnmanageresponse.md +3 -16
  145. package/docs/models/components/earnswapresponse.md +3 -37
  146. package/docs/models/components/earntransferresponse.md +4 -15
  147. package/docs/models/components/earntransferresponseeip712.md +2 -0
  148. package/docs/models/components/permittypeddataresponseoutput.md +7 -2
  149. package/docs/models/components/vaultinfo.md +1 -0
  150. package/docs/models/components/withdrawamount.md +1 -1
  151. package/docs/models/operations/minliquidityusd.md +19 -0
  152. package/docs/models/operations/v2earnvaultsrequest.md +2 -1
  153. package/docs/sdks/credit/README.md +1 -1
  154. package/examples/node_modules/get-tsconfig/dist/index.cjs +1 -1
  155. package/examples/node_modules/get-tsconfig/dist/index.mjs +1 -1
  156. package/examples/node_modules/get-tsconfig/package.json +1 -1
  157. package/examples/package-lock.json +3 -3
  158. package/package.json +1 -1
  159. package/src/funcs/creditCreditBundle.ts +1 -1
  160. package/src/funcs/earnEarnVaults.ts +1 -0
  161. package/src/lib/config.ts +2 -2
  162. package/src/lib/files.ts +22 -0
  163. package/src/lib/sdks.ts +7 -5
  164. package/src/lib/url.ts +16 -14
  165. package/src/models/components/approvetransferresponse.ts +10 -4
  166. package/src/models/components/creditborrowrequest.ts +13 -13
  167. package/src/models/components/creditrepayrequest.ts +9 -9
  168. package/src/models/components/credittransfertoaddressparams.ts +89 -0
  169. package/src/models/components/credituseroperation.ts +11 -0
  170. package/src/models/components/depositforburnresponse.ts +11 -4
  171. package/src/models/components/earnmanageresponse.ts +11 -4
  172. package/src/models/components/earnswapresponse.ts +14 -4
  173. package/src/models/components/earntransferresponse.ts +17 -4
  174. package/src/models/components/index.ts +1 -0
  175. package/src/models/components/vaultinfo.ts +6 -0
  176. package/src/models/operations/v2earnvaults.ts +28 -0
  177. package/src/sdk/credit.ts +1 -1
@@ -20,13 +20,26 @@ import {
20
20
  UnsignedTransaction$inboundSchema,
21
21
  } from "./unsignedtransaction.js";
22
22
 
23
+ /**
24
+ * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.
25
+ */
23
26
  export type EarnTransferResponseEip712 =
24
27
  | BatchedSafeOperationsResponseOutput
25
28
  | Permit2TypedDataOutput;
26
29
 
27
30
  export type EarnTransferResponse = {
28
- transaction: UnsignedTransaction | null;
29
- eip712: BatchedSafeOperationsResponseOutput | Permit2TypedDataOutput | null;
31
+ /**
32
+ * Unsigned transaction for direct execution. Present when gas_sponsorship=false.
33
+ */
34
+ transaction?: UnsignedTransaction | null | undefined;
35
+ /**
36
+ * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.
37
+ */
38
+ eip712?:
39
+ | BatchedSafeOperationsResponseOutput
40
+ | Permit2TypedDataOutput
41
+ | null
42
+ | undefined;
30
43
  };
31
44
 
32
45
  /** @internal */
@@ -55,13 +68,13 @@ export const EarnTransferResponse$inboundSchema: z.ZodType<
55
68
  z.ZodTypeDef,
56
69
  unknown
57
70
  > = z.object({
58
- transaction: z.nullable(UnsignedTransaction$inboundSchema),
71
+ transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
59
72
  eip_712: z.nullable(
60
73
  z.union([
61
74
  BatchedSafeOperationsResponseOutput$inboundSchema,
62
75
  Permit2TypedDataOutput$inboundSchema,
63
76
  ]),
64
- ),
77
+ ).optional(),
65
78
  }).transform((v) => {
66
79
  return remap$(v, {
67
80
  "eip_712": "eip712",
@@ -99,6 +99,7 @@ export * from "./creditrepayresponse.js";
99
99
  export * from "./creditsupplyparams.js";
100
100
  export * from "./credittransferrequest.js";
101
101
  export * from "./credittransferresponse.js";
102
+ export * from "./credittransfertoaddressparams.js";
102
103
  export * from "./credituseroperation.js";
103
104
  export * from "./creditwithdrawparams.js";
104
105
  export * from "./debtposition.js";
@@ -52,6 +52,10 @@ export type VaultInfo = {
52
52
  * Total Value Locked in USD.
53
53
  */
54
54
  tvlUsd?: string | null | undefined;
55
+ /**
56
+ * Available liquidity in USD (withdrawable amount).
57
+ */
58
+ liquidityUsd?: string | null | undefined;
55
59
  /**
56
60
  * 7-day APY as a percentage (e.g., 5.25 = 5.25%).
57
61
  */
@@ -85,6 +89,7 @@ export const VaultInfo$inboundSchema: z.ZodType<
85
89
  asset_name: z.nullable(z.string()).optional(),
86
90
  asset_symbol: z.nullable(z.string()).optional(),
87
91
  tvl_usd: z.nullable(z.string()).optional(),
92
+ liquidity_usd: z.nullable(z.string()).optional(),
88
93
  apy_7d: z.nullable(z.string()).optional(),
89
94
  apy_30d: z.nullable(z.string()).optional(),
90
95
  apy_90d: z.nullable(z.string()).optional(),
@@ -95,6 +100,7 @@ export const VaultInfo$inboundSchema: z.ZodType<
95
100
  "asset_name": "assetName",
96
101
  "asset_symbol": "assetSymbol",
97
102
  "tvl_usd": "tvlUsd",
103
+ "liquidity_usd": "liquidityUsd",
98
104
  "apy_7d": "apy7d",
99
105
  "apy_30d": "apy30d",
100
106
  "apy_90d": "apy90d",
@@ -24,6 +24,11 @@ export type V2EarnVaultsDirection = ClosedEnum<typeof V2EarnVaultsDirection>;
24
24
  */
25
25
  export type V2EarnVaultsMinTvlUsd = number | string;
26
26
 
27
+ /**
28
+ * Minimum available liquidity in USD. Vaults below this are excluded.
29
+ */
30
+ export type MinLiquidityUsd = number | string;
31
+
27
32
  export type V2EarnVaultsRequest = {
28
33
  /**
29
34
  * The field to order the results by.
@@ -53,6 +58,10 @@ export type V2EarnVaultsRequest = {
53
58
  * Minimum TVL in USD. Vaults with TVL below this value will be excluded.
54
59
  */
55
60
  minTvlUsd?: number | string | null | undefined;
61
+ /**
62
+ * Minimum available liquidity in USD. Vaults below this are excluded.
63
+ */
64
+ minLiquidityUsd?: number | string | null | undefined;
56
65
  };
57
66
 
58
67
  /** @internal */
@@ -78,6 +87,22 @@ export function v2EarnVaultsMinTvlUsdToJSON(
78
87
  );
79
88
  }
80
89
 
90
+ /** @internal */
91
+ export type MinLiquidityUsd$Outbound = number | string;
92
+
93
+ /** @internal */
94
+ export const MinLiquidityUsd$outboundSchema: z.ZodType<
95
+ MinLiquidityUsd$Outbound,
96
+ z.ZodTypeDef,
97
+ MinLiquidityUsd
98
+ > = z.union([z.number(), z.string()]);
99
+
100
+ export function minLiquidityUsdToJSON(
101
+ minLiquidityUsd: MinLiquidityUsd,
102
+ ): string {
103
+ return JSON.stringify(MinLiquidityUsd$outboundSchema.parse(minLiquidityUsd));
104
+ }
105
+
81
106
  /** @internal */
82
107
  export type V2EarnVaultsRequest$Outbound = {
83
108
  order_by: string;
@@ -87,6 +112,7 @@ export type V2EarnVaultsRequest$Outbound = {
87
112
  chain?: string | null | undefined;
88
113
  asset_symbol?: string | null | undefined;
89
114
  min_tvl_usd?: number | string | null | undefined;
115
+ min_liquidity_usd?: number | string | null | undefined;
90
116
  };
91
117
 
92
118
  /** @internal */
@@ -102,11 +128,13 @@ export const V2EarnVaultsRequest$outboundSchema: z.ZodType<
102
128
  chain: z.nullable(components.Chain$outboundSchema).optional(),
103
129
  assetSymbol: z.nullable(z.string()).optional(),
104
130
  minTvlUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
131
+ minLiquidityUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
105
132
  }).transform((v) => {
106
133
  return remap$(v, {
107
134
  orderBy: "order_by",
108
135
  assetSymbol: "asset_symbol",
109
136
  minTvlUsd: "min_tvl_usd",
137
+ minLiquidityUsd: "min_liquidity_usd",
110
138
  });
111
139
  });
112
140
 
package/src/sdk/credit.ts CHANGED
@@ -136,7 +136,7 @@ export class Credit extends ClientSDK {
136
136
  }
137
137
 
138
138
  /**
139
- * Execute multiple credit actions atomically
139
+ * Execute multiple credit actions
140
140
  *
141
141
  * @remarks
142
142
  * Compose individual credit operations (supply, withdraw, borrow, repay, swap, transfer)