@merkl/api 1.1.13 → 1.1.15

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 (48) hide show
  1. package/dist/src/constants.d.ts +61 -0
  2. package/dist/src/eden/index.d.ts +895 -5238
  3. package/dist/src/engine/deprecated/dynamicData/implementations/default.d.ts +1 -1
  4. package/dist/src/engine/implementations/Aave/metadata.d.ts +1 -1
  5. package/dist/src/engine/implementations/Erc20/subTypes/index.d.ts +1 -2
  6. package/dist/src/engine/tvl/factory.d.ts +1 -1
  7. package/dist/src/index.d.ts +192 -2368
  8. package/dist/src/modules/v4/apr/apr.model.d.ts +0 -8
  9. package/dist/src/modules/v4/campaign/campaign.controller.d.ts +20 -396
  10. package/dist/src/modules/v4/campaign/campaign.convertor.d.ts +1 -2
  11. package/dist/src/modules/v4/campaign/campaign.model.d.ts +17 -15
  12. package/dist/src/modules/v4/campaign/campaign.repository.d.ts +60 -63
  13. package/dist/src/modules/v4/campaign/campaign.service.d.ts +34 -54
  14. package/dist/src/modules/v4/campaign/campaign.test.controller.d.ts +44 -1168
  15. package/dist/src/modules/v4/dynamicData/dynamicData.service.d.ts +1 -14
  16. package/dist/src/modules/v4/opportunity/opportunity.controller.d.ts +46 -264
  17. package/dist/src/modules/v4/opportunity/opportunity.converter.d.ts +0 -6
  18. package/dist/src/modules/v4/opportunity/opportunity.formatter.d.ts +6 -3
  19. package/dist/src/modules/v4/opportunity/opportunity.model.d.ts +21 -73
  20. package/dist/src/modules/v4/opportunity/opportunity.repository.d.ts +34 -21
  21. package/dist/src/modules/v4/opportunity/opportunity.service.d.ts +40 -38
  22. package/dist/src/modules/v4/payload/payload.controller.d.ts +16 -468
  23. package/dist/src/modules/v4/payload/payload.model.d.ts +1 -10
  24. package/dist/src/modules/v4/payload/payload.service.d.ts +12 -379
  25. package/dist/src/modules/v4/programPayload/programPayload.controller.d.ts +3 -17
  26. package/dist/src/modules/v4/programPayload/programPayload.model.d.ts +1 -1
  27. package/dist/src/modules/v4/programPayload/programPayload.repository.d.ts +7 -429
  28. package/dist/src/modules/v4/programPayload/programPayload.service.d.ts +2 -1
  29. package/dist/src/modules/v4/programPayload/subPayloads/hypurrFi.d.ts +3 -11
  30. package/dist/src/modules/v4/reward/reward.controller.d.ts +3 -3
  31. package/dist/src/modules/v4/reward/reward.model.d.ts +4 -18
  32. package/dist/src/modules/v4/reward/reward.repository.d.ts +4 -2
  33. package/dist/src/modules/v4/reward/reward.service.d.ts +26 -13
  34. package/dist/src/modules/v4/router.d.ts +191 -2364
  35. package/dist/src/modules/v4/token/token.controller.d.ts +22 -14
  36. package/dist/src/modules/v4/token/token.model.d.ts +5 -15
  37. package/dist/src/modules/v4/token/token.repository.d.ts +11 -7
  38. package/dist/src/modules/v4/user/user.controller.d.ts +4 -2
  39. package/dist/src/routes/v3/opportunity.d.ts +0 -3
  40. package/dist/src/routes/v3/payload.d.ts +1 -1
  41. package/dist/src/routes/v3/router.d.ts +1 -4
  42. package/dist/src/utils/parseDistributionType.d.ts +1 -2
  43. package/dist/tsconfig.tsbuildinfo +1 -1
  44. package/package.json +1 -1
  45. package/dist/src/engine/implementations/Erc20/subTypes/implementations/ERC4626/metadata.d.ts +0 -31
  46. package/dist/src/engine/implementations/Erc20/subTypes/implementations/ERC4626/tvl.d.ts +0 -6
  47. package/dist/src/modules/v4/token/token.service.d.ts +0 -348
  48. package/dist/src/modules/v4/transaction/transaction.model.d.ts +0 -17
package/dist/src/modules/v4/opportunity/opportunity.service.d.ts CHANGED
@@ -1,30 +1,19 @@
1
1
  import { type MerklChainId } from "@angleprotocol/sdk/ts";
2
- import { DistributionType, type OpportunityAction, type OpportunityManualOverride, type Prisma, TokenType } from "@package/databases/api";
2
+ import { type OpportunityAction, type OpportunityManualOverride, type Prisma } from "@package/databases/api";
3
3
  import type { CampaignWithParams, FindCampaignModel } from "../../../modules/v4/campaign/campaign.model";
4
4
  import type { Protocol } from "../protocol/protocol.model";
5
5
  import type { Token } from "../token/token.model";
6
- import type { FindManyOpportunityModel, FindOpportunityModel, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
6
+ import type { FindOpportunityModel, GetOpportunitiesQueryModel, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
7
7
  export declare abstract class OpportunityService {
8
- static transformQueryToTestAndTokenTypes(query: {
9
- tokenTypes?: TokenType[] | undefined;
10
- point?: boolean | undefined;
11
- test?: boolean | undefined;
12
- }): {
13
- tokenTypes: import("@package/databases").TokenType[] | undefined;
14
- test: boolean;
15
- };
16
- static transformQueryToDistributionTypes(query: {
17
- distributionTypes?: FindManyOpportunityModel["distributionTypes"];
18
- }): DistributionType[] | undefined;
19
8
  static hashId(opportunity: OpportunityUnique): string;
20
- static getAprBins(query: FindManyOpportunityModel): Promise<{
9
+ static getAprBins(query: GetOpportunitiesQueryModel): Promise<{
21
10
  data: {
22
11
  count: any;
23
12
  min: number;
24
13
  max: number;
25
14
  }[];
26
15
  }>;
27
- static getTvlBins(query: FindManyOpportunityModel): Promise<{
16
+ static getTvlBins(query: GetOpportunitiesQueryModel): Promise<{
28
17
  data: {
29
18
  count: any;
30
19
  min: number;
@@ -66,9 +55,10 @@ export declare abstract class OpportunityService {
66
55
  address: string;
67
56
  id: string;
68
57
  chainId: number;
69
- type: import("@package/databases").TokenType;
70
58
  icon: string;
71
59
  isNative: boolean;
60
+ isPoint: boolean;
61
+ isPreTGE: boolean;
72
62
  isTest: boolean;
73
63
  verified: boolean;
74
64
  } & {
@@ -91,9 +81,10 @@ export declare abstract class OpportunityService {
91
81
  address: string;
92
82
  id: string;
93
83
  chainId: number;
94
- type: import("@package/databases").TokenType;
95
84
  icon: string;
96
85
  isNative: boolean;
86
+ isPoint: boolean;
87
+ isPreTGE: boolean;
97
88
  isTest: boolean;
98
89
  verified: boolean;
99
90
  displaySymbol: string;
@@ -146,9 +137,10 @@ export declare abstract class OpportunityService {
146
137
  address: string;
147
138
  id: string;
148
139
  chainId: number;
149
- type: import("@package/databases").TokenType;
150
140
  icon: string;
151
141
  isNative: boolean;
142
+ isPoint: boolean;
143
+ isPreTGE: boolean;
152
144
  isTest: boolean;
153
145
  verified: boolean;
154
146
  } & {
@@ -171,9 +163,10 @@ export declare abstract class OpportunityService {
171
163
  address: string;
172
164
  id: string;
173
165
  chainId: number;
174
- type: import("@package/databases").TokenType;
175
166
  icon: string;
176
167
  isNative: boolean;
168
+ isPoint: boolean;
169
+ isPreTGE: boolean;
177
170
  isTest: boolean;
178
171
  verified: boolean;
179
172
  displaySymbol: string;
@@ -225,9 +218,10 @@ export declare abstract class OpportunityService {
225
218
  address: string;
226
219
  id: string;
227
220
  chainId: number;
228
- type: import("@package/databases").TokenType;
229
221
  icon: string;
230
222
  isNative: boolean;
223
+ isPoint: boolean;
224
+ isPreTGE: boolean;
231
225
  isTest: boolean;
232
226
  verified: boolean;
233
227
  } & {
@@ -250,9 +244,10 @@ export declare abstract class OpportunityService {
250
244
  address: string;
251
245
  id: string;
252
246
  chainId: number;
253
- type: import("@package/databases").TokenType;
254
247
  icon: string;
255
248
  isNative: boolean;
249
+ isPoint: boolean;
250
+ isPreTGE: boolean;
256
251
  isTest: boolean;
257
252
  verified: boolean;
258
253
  displaySymbol: string;
@@ -308,13 +303,13 @@ export declare abstract class OpportunityService {
308
303
  timestamp: string | bigint;
309
304
  cumulated: number;
310
305
  breakdowns: {
311
- distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "MAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
306
+ distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
312
307
  value: number;
313
- type: "TOKEN" | "CAMPAIGN" | "PROTOCOL";
308
+ type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
314
309
  identifier: string;
315
310
  }[];
316
311
  } | undefined;
317
- distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "MAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
312
+ distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
318
313
  explorerAddress?: string | undefined;
319
314
  tvlRecord?: {
320
315
  timestamp: string | bigint;
@@ -329,7 +324,7 @@ export declare abstract class OpportunityService {
329
324
  timestamp: string | bigint;
330
325
  total: number;
331
326
  breakdowns: {
332
- distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "MAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
327
+ distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
333
328
  token: {
334
329
  price?: number | null | undefined;
335
330
  symbol: string;
@@ -338,9 +333,10 @@ export declare abstract class OpportunityService {
338
333
  address: string;
339
334
  id: string;
340
335
  chainId: number;
341
- type: "TOKEN" | "PRETGE" | "POINT";
342
336
  icon: string;
343
337
  isNative: boolean;
338
+ isPoint: boolean;
339
+ isPreTGE: boolean;
344
340
  isTest: boolean;
345
341
  verified: boolean;
346
342
  };
@@ -359,9 +355,10 @@ export declare abstract class OpportunityService {
359
355
  address: string;
360
356
  id: string;
361
357
  chainId: number;
362
- type: "TOKEN" | "PRETGE" | "POINT";
363
358
  icon: string;
364
359
  isNative: boolean;
360
+ isPoint: boolean;
361
+ isPreTGE: boolean;
365
362
  isTest: boolean;
366
363
  verified: boolean;
367
364
  }[];
@@ -384,7 +381,7 @@ export declare abstract class OpportunityService {
384
381
  computedUntil: string | number;
385
382
  processingStarted: string | number;
386
383
  } | undefined;
387
- distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "MAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
384
+ distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
388
385
  rootCampaignId?: string | undefined;
389
386
  parentCampaignId?: string | undefined;
390
387
  distributionChain?: {
@@ -405,9 +402,10 @@ export declare abstract class OpportunityService {
405
402
  address: string;
406
403
  id: string;
407
404
  chainId: number;
408
- type: "TOKEN" | "PRETGE" | "POINT";
409
405
  icon: string;
410
406
  isNative: boolean;
407
+ isPoint: boolean;
408
+ isPreTGE: boolean;
411
409
  isTest: boolean;
412
410
  verified: boolean;
413
411
  };
@@ -458,7 +456,7 @@ export declare abstract class OpportunityService {
458
456
  * @param query
459
457
  * @returns A list of opportunities
460
458
  */
461
- static findMany(query: FindManyOpportunityModel): Promise<{
459
+ static findMany(query: GetOpportunitiesQueryModel): Promise<{
462
460
  aprRecord: {
463
461
  cumulated: number;
464
462
  timestamp: bigint;
@@ -499,9 +497,10 @@ export declare abstract class OpportunityService {
499
497
  address: string;
500
498
  id: string;
501
499
  chainId: number;
502
- type: import("@package/databases").TokenType;
503
500
  icon: string;
504
501
  isNative: boolean;
502
+ isPoint: boolean;
503
+ isPreTGE: boolean;
505
504
  isTest: boolean;
506
505
  verified: boolean;
507
506
  displaySymbol: string;
@@ -519,9 +518,10 @@ export declare abstract class OpportunityService {
519
518
  address: string;
520
519
  id: string;
521
520
  chainId: number;
522
- type: import("@package/databases").TokenType;
523
521
  icon: string;
524
522
  isNative: boolean;
523
+ isPoint: boolean;
524
+ isPreTGE: boolean;
525
525
  isTest: boolean;
526
526
  verified: boolean;
527
527
  } & {
@@ -565,7 +565,7 @@ export declare abstract class OpportunityService {
565
565
  * @param query
566
566
  * @returns the number of opportunities
567
567
  */
568
- static countMany(query: FindManyOpportunityModel): Promise<number>;
568
+ static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
569
569
  static findLiveWithCampaigns(chainId: MerklChainId, take?: number): Promise<{
570
570
  aprRecord: {
571
571
  cumulated: number;
@@ -607,9 +607,10 @@ export declare abstract class OpportunityService {
607
607
  address: string;
608
608
  id: string;
609
609
  chainId: number;
610
- type: import("@package/databases").TokenType;
611
610
  icon: string;
612
611
  isNative: boolean;
612
+ isPoint: boolean;
613
+ isPreTGE: boolean;
613
614
  isTest: boolean;
614
615
  verified: boolean;
615
616
  displaySymbol: string;
@@ -627,9 +628,10 @@ export declare abstract class OpportunityService {
627
628
  address: string;
628
629
  id: string;
629
630
  chainId: number;
630
- type: import("@package/databases").TokenType;
631
631
  icon: string;
632
632
  isNative: boolean;
633
+ isPoint: boolean;
634
+ isPreTGE: boolean;
633
635
  isTest: boolean;
634
636
  verified: boolean;
635
637
  } & {
@@ -667,13 +669,13 @@ export declare abstract class OpportunityService {
667
669
  dailyRewards: number;
668
670
  tags: string[];
669
671
  }[]>;
670
- static aggregate(query: FindManyOpportunityModel, field: keyof Prisma.OpportunitySumAggregateInputType): Promise<{
672
+ static aggregate(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunitySumAggregateInputType): Promise<{
671
673
  sum: string;
672
674
  }>;
673
- static aggregateMin(query: FindManyOpportunityModel, field: keyof Prisma.OpportunityMinAggregateInputType): Promise<{
675
+ static aggregateMin(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunityMinAggregateInputType): Promise<{
674
676
  min: string;
675
677
  }>;
676
- static aggregateMax(query: FindManyOpportunityModel, field: keyof Prisma.OpportunityMaxAggregateInputType): Promise<{
678
+ static aggregateMax(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunityMaxAggregateInputType): Promise<{
677
679
  max: string;
678
680
  }>;
679
681
  static update(id: string, data: Partial<Opportunity["raw"]>): Promise<{