@dcl/schemas 13.6.3 → 13.6.4-20240827124856.commit-06fbd23

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.
@@ -2,12 +2,14 @@ import { BidAcceptedEvent, CollectionCreatedEvent, ItemSoldEvent, RentalEndedEve
2
2
  import { CatalystDeploymentEvent } from './catalyst';
3
3
  import { MoveToParcelEvent } from './client';
4
4
  import { BidReceivedEvent } from './marketplace';
5
+ import { RewardInProgressEvent, RewardAssignedEvent, CampaignOutOfFundsEvent, CampaignGasPriceHigherThanExpectedEvent, CampaignOutOfStockEvent, RewardDelayedEvent } from './rewards';
5
6
  export declare namespace Events {
6
7
  enum Type {
7
8
  BLOCKCHAIN = "blockchain",
8
9
  CATALYST_DEPLOYMENT = "catalyst-deployment",
9
10
  CLIENT = "client",
10
- MARKETPLACE = "marketplace"
11
+ MARKETPLACE = "marketplace",
12
+ REWARDS = "rewards"
11
13
  }
12
14
  namespace SubType {
13
15
  enum Blockchain {
@@ -32,13 +34,21 @@ export declare namespace Events {
32
34
  enum Client {
33
35
  MOVE_TO_PARCEL = "move-to-parcel"
34
36
  }
37
+ enum Rewards {
38
+ REWARD_IN_PROGRESS = "reward-in-progress",
39
+ REWARD_ASSIGNED = "reward-assigned",
40
+ CAMPAIGN_OUT_OF_FUNDS = "campaign-out-of-funds",
41
+ CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED = "campaign-gas-price-higher-than-expected",
42
+ CAMPAIGN_OUT_OF_STOCK = "campaign-out-of-stock",
43
+ REWARD_DELAYED = "reward-delayed"
44
+ }
35
45
  }
36
46
  }
37
47
  export type BaseEvent = {
38
48
  type: Events.Type;
39
- subType: Events.SubType.Blockchain | Events.SubType.CatalystDeployment | Events.SubType.Client | Events.SubType.Marketplace;
49
+ subType: Events.SubType.Blockchain | Events.SubType.CatalystDeployment | Events.SubType.Client | Events.SubType.Marketplace | Events.SubType.Rewards;
40
50
  key: string;
41
51
  timestamp: number;
42
52
  };
43
- export type Event = BidAcceptedEvent | BidReceivedEvent | ItemSoldEvent | RentalEndedEvent | RentalStartedEvent | RoyaltiesEarnedEvent | CollectionCreatedEvent | MoveToParcelEvent | CatalystDeploymentEvent;
53
+ export type Event = BidAcceptedEvent | BidReceivedEvent | ItemSoldEvent | RentalEndedEvent | RentalStartedEvent | RoyaltiesEarnedEvent | CollectionCreatedEvent | MoveToParcelEvent | CatalystDeploymentEvent | RewardInProgressEvent | RewardAssignedEvent | CampaignOutOfFundsEvent | CampaignGasPriceHigherThanExpectedEvent | CampaignOutOfStockEvent | RewardDelayedEvent;
44
54
  //# sourceMappingURL=base.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/platform/events/base.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEhD,yBAAiB,MAAM,CAAC;IACtB,KAAY,IAAI;QACd,UAAU,eAAe;QACzB,mBAAmB,wBAAwB;QAC3C,MAAM,WAAW;QACjB,WAAW,gBAAgB;KAC5B;IAED,UAAiB,OAAO,CAAC;QACvB,KAAY,UAAU;YACpB,YAAY,iBAAiB;YAC7B,SAAS,cAAc;YACvB,YAAY,sBAAsB;YAClC,cAAc,wBAAwB;YACtC,gBAAgB,qBAAqB;YACrC,kBAAkB,uBAAuB;SAC1C;QAED,KAAY,WAAW;YACrB,YAAY,iBAAiB;SAC9B;QAED,KAAY,kBAAkB;YAC5B,KAAK,UAAU;YACf,OAAO,YAAY;YACnB,QAAQ,aAAa;YACrB,KAAK,UAAU;YACf,KAAK,UAAU;YACf,OAAO,YAAY;SACpB;QAED,KAAY,MAAM;YAChB,cAAc,mBAAmB;SAClC;KACF;CACF;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAA;IACjB,OAAO,EACH,MAAM,CAAC,OAAO,CAAC,UAAU,GACzB,MAAM,CAAC,OAAO,CAAC,kBAAkB,GACjC,MAAM,CAAC,OAAO,CAAC,MAAM,GACrB,MAAM,CAAC,OAAO,CAAC,WAAW,CAAA;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,KAAK,GACb,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,iBAAiB,GACjB,uBAAuB,CAAA"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/platform/events/base.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,uCAAuC,EACvC,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,WAAW,CAAA;AAElB,yBAAiB,MAAM,CAAC;IACtB,KAAY,IAAI;QACd,UAAU,eAAe;QACzB,mBAAmB,wBAAwB;QAC3C,MAAM,WAAW;QACjB,WAAW,gBAAgB;QAC3B,OAAO,YAAY;KACpB;IAED,UAAiB,OAAO,CAAC;QACvB,KAAY,UAAU;YACpB,YAAY,iBAAiB;YAC7B,SAAS,cAAc;YACvB,YAAY,sBAAsB;YAClC,cAAc,wBAAwB;YACtC,gBAAgB,qBAAqB;YACrC,kBAAkB,uBAAuB;SAC1C;QAED,KAAY,WAAW;YACrB,YAAY,iBAAiB;SAC9B;QAED,KAAY,kBAAkB;YAC5B,KAAK,UAAU;YACf,OAAO,YAAY;YACnB,QAAQ,aAAa;YACrB,KAAK,UAAU;YACf,KAAK,UAAU;YACf,OAAO,YAAY;SACpB;QAED,KAAY,MAAM;YAChB,cAAc,mBAAmB;SAClC;QAED,KAAY,OAAO;YACjB,kBAAkB,uBAAuB;YACzC,eAAe,oBAAoB;YACnC,qBAAqB,0BAA0B;YAC/C,uCAAuC,4CAA4C;YACnF,qBAAqB,0BAA0B;YAC/C,cAAc,mBAAmB;SAClC;KACF;CACF;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAA;IACjB,OAAO,EACH,MAAM,CAAC,OAAO,CAAC,UAAU,GACzB,MAAM,CAAC,OAAO,CAAC,kBAAkB,GACjC,MAAM,CAAC,OAAO,CAAC,MAAM,GACrB,MAAM,CAAC,OAAO,CAAC,WAAW,GAC1B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAA;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,KAAK,GACb,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,mBAAmB,GACnB,uBAAuB,GACvB,uCAAuC,GACvC,uBAAuB,GACvB,kBAAkB,CAAA"}
@@ -9,6 +9,7 @@ var Events;
9
9
  Type["CATALYST_DEPLOYMENT"] = "catalyst-deployment";
10
10
  Type["CLIENT"] = "client";
11
11
  Type["MARKETPLACE"] = "marketplace";
12
+ Type["REWARDS"] = "rewards";
12
13
  })(Type = Events.Type || (Events.Type = {}));
13
14
  let SubType;
14
15
  (function (SubType) {
@@ -38,6 +39,15 @@ var Events;
38
39
  (function (Client) {
39
40
  Client["MOVE_TO_PARCEL"] = "move-to-parcel";
40
41
  })(Client = SubType.Client || (SubType.Client = {}));
42
+ let Rewards;
43
+ (function (Rewards) {
44
+ Rewards["REWARD_IN_PROGRESS"] = "reward-in-progress";
45
+ Rewards["REWARD_ASSIGNED"] = "reward-assigned";
46
+ Rewards["CAMPAIGN_OUT_OF_FUNDS"] = "campaign-out-of-funds";
47
+ Rewards["CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED"] = "campaign-gas-price-higher-than-expected";
48
+ Rewards["CAMPAIGN_OUT_OF_STOCK"] = "campaign-out-of-stock";
49
+ Rewards["REWARD_DELAYED"] = "reward-delayed";
50
+ })(Rewards = SubType.Rewards || (SubType.Rewards = {}));
41
51
  })(SubType = Events.SubType || (Events.SubType = {}));
42
52
  })(Events = exports.Events || (exports.Events = {}));
43
53
  //# sourceMappingURL=base.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/platform/events/base.ts"],"names":[],"mappings":";;;AAYA,IAAiB,MAAM,CAmCtB;AAnCD,WAAiB,MAAM;IACrB,IAAY,IAKX;IALD,WAAY,IAAI;QACd,iCAAyB,CAAA;QACzB,mDAA2C,CAAA;QAC3C,yBAAiB,CAAA;QACjB,mCAA2B,CAAA;IAC7B,CAAC,EALW,IAAI,GAAJ,WAAI,KAAJ,WAAI,QAKf;IAED,IAAiB,OAAO,CA0BvB;IA1BD,WAAiB,OAAO;QACtB,IAAY,UAOX;QAPD,WAAY,UAAU;YACpB,2CAA6B,CAAA;YAC7B,qCAAuB,CAAA;YACvB,gDAAkC,CAAA;YAClC,oDAAsC,CAAA;YACtC,mDAAqC,CAAA;YACrC,uDAAyC,CAAA;QAC3C,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;QAED,IAAY,WAEX;QAFD,WAAY,WAAW;YACrB,4CAA6B,CAAA;QAC/B,CAAC,EAFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAEtB;QAED,IAAY,kBAOX;QAPD,WAAY,kBAAkB;YAC5B,qCAAe,CAAA;YACf,yCAAmB,CAAA;YACnB,2CAAqB,CAAA;YACrB,qCAAe,CAAA;YACf,qCAAe,CAAA;YACf,yCAAmB,CAAA;QACrB,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;QAED,IAAY,MAEX;QAFD,WAAY,MAAM;YAChB,2CAAiC,CAAA;QACnC,CAAC,EAFW,MAAM,GAAN,cAAM,KAAN,cAAM,QAEjB;IACH,CAAC,EA1BgB,OAAO,GAAP,cAAO,KAAP,cAAO,QA0BvB;AACH,CAAC,EAnCgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAmCtB"}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/platform/events/base.ts"],"names":[],"mappings":";;;AAoBA,IAAiB,MAAM,CA6CtB;AA7CD,WAAiB,MAAM;IACrB,IAAY,IAMX;IAND,WAAY,IAAI;QACd,iCAAyB,CAAA;QACzB,mDAA2C,CAAA;QAC3C,yBAAiB,CAAA;QACjB,mCAA2B,CAAA;QAC3B,2BAAmB,CAAA;IACrB,CAAC,EANW,IAAI,GAAJ,WAAI,KAAJ,WAAI,QAMf;IAED,IAAiB,OAAO,CAmCvB;IAnCD,WAAiB,OAAO;QACtB,IAAY,UAOX;QAPD,WAAY,UAAU;YACpB,2CAA6B,CAAA;YAC7B,qCAAuB,CAAA;YACvB,gDAAkC,CAAA;YAClC,oDAAsC,CAAA;YACtC,mDAAqC,CAAA;YACrC,uDAAyC,CAAA;QAC3C,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;QAED,IAAY,WAEX;QAFD,WAAY,WAAW;YACrB,4CAA6B,CAAA;QAC/B,CAAC,EAFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAEtB;QAED,IAAY,kBAOX;QAPD,WAAY,kBAAkB;YAC5B,qCAAe,CAAA;YACf,yCAAmB,CAAA;YACnB,2CAAqB,CAAA;YACrB,qCAAe,CAAA;YACf,qCAAe,CAAA;YACf,yCAAmB,CAAA;QACrB,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;QAED,IAAY,MAEX;QAFD,WAAY,MAAM;YAChB,2CAAiC,CAAA;QACnC,CAAC,EAFW,MAAM,GAAN,cAAM,KAAN,cAAM,QAEjB;QAED,IAAY,OAOX;QAPD,WAAY,OAAO;YACjB,oDAAyC,CAAA;YACzC,8CAAmC,CAAA;YACnC,0DAA+C,CAAA;YAC/C,8FAAmF,CAAA;YACnF,0DAA+C,CAAA;YAC/C,4CAAiC,CAAA;QACnC,CAAC,EAPW,OAAO,GAAP,eAAO,KAAP,eAAO,QAOlB;IACH,CAAC,EAnCgB,OAAO,GAAP,cAAO,KAAP,cAAO,QAmCvB;AACH,CAAC,EA7CgB,MAAM,GAAN,cAAM,KAAN,cAAM,QA6CtB"}
@@ -3,4 +3,5 @@ export * from './blockchain';
3
3
  export * from './catalyst';
4
4
  export * from './client';
5
5
  export * from './marketplace';
6
+ export * from './rewards';
6
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/platform/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/platform/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}
@@ -19,4 +19,5 @@ __exportStar(require("./blockchain"), exports);
19
19
  __exportStar(require("./catalyst"), exports);
20
20
  __exportStar(require("./client"), exports);
21
21
  __exportStar(require("./marketplace"), exports);
22
+ __exportStar(require("./rewards"), exports);
22
23
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/platform/events/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,+CAA4B;AAC5B,6CAA0B;AAC1B,2CAAwB;AACxB,gDAA6B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/platform/events/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,+CAA4B;AAC5B,6CAA0B;AAC1B,2CAAwB;AACxB,gDAA6B;AAC7B,4CAAyB"}
@@ -0,0 +1,75 @@
1
+ import { EthAddress } from '../../misc';
2
+ import { JSONSchema, ValidateFunction } from '../../validation';
3
+ import { BaseEvent, Events } from './base';
4
+ type BaseEventMetadata = {
5
+ title: string;
6
+ description: string;
7
+ };
8
+ export type RewardEventMetadata = BaseEventMetadata & {
9
+ beneficiary: EthAddress;
10
+ tokenName: string;
11
+ tokenImage: string;
12
+ tokenRarity?: string;
13
+ tokenCategory?: string;
14
+ };
15
+ export type CampaignWellKnownIssueEventMetadata = BaseEventMetadata & {
16
+ owner: EthAddress;
17
+ campaignId: string;
18
+ campaignName: string;
19
+ };
20
+ export type RewardInProgressEvent = BaseEvent & {
21
+ type: Events.Type.REWARDS;
22
+ subType: Events.SubType.Rewards.REWARD_IN_PROGRESS;
23
+ metadata: RewardEventMetadata;
24
+ };
25
+ export type RewardAssignedEvent = BaseEvent & {
26
+ type: Events.Type.REWARDS;
27
+ subType: Events.SubType.Rewards.REWARD_ASSIGNED;
28
+ metadata: RewardEventMetadata;
29
+ };
30
+ export type CampaignOutOfFundsEvent = BaseEvent & {
31
+ type: Events.Type.REWARDS;
32
+ subType: Events.SubType.Rewards.CAMPAIGN_OUT_OF_FUNDS;
33
+ metadata: CampaignWellKnownIssueEventMetadata;
34
+ };
35
+ export type CampaignGasPriceHigherThanExpectedEvent = BaseEvent & {
36
+ type: Events.Type.REWARDS;
37
+ subType: Events.SubType.Rewards.CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED;
38
+ metadata: CampaignWellKnownIssueEventMetadata;
39
+ };
40
+ export type CampaignOutOfStockEvent = BaseEvent & {
41
+ type: Events.Type.REWARDS;
42
+ subType: Events.SubType.Rewards.CAMPAIGN_OUT_OF_STOCK;
43
+ metadata: CampaignWellKnownIssueEventMetadata;
44
+ };
45
+ export type RewardDelayedEvent = BaseEvent & {
46
+ type: Events.Type.REWARDS;
47
+ subType: Events.SubType.Rewards.REWARD_DELAYED;
48
+ metadata: RewardEventMetadata;
49
+ };
50
+ export declare namespace RewardInProgressEvent {
51
+ const schema: JSONSchema<RewardInProgressEvent>;
52
+ const validate: ValidateFunction<RewardInProgressEvent>;
53
+ }
54
+ export declare namespace RewardAssignedEvent {
55
+ const schema: JSONSchema<RewardAssignedEvent>;
56
+ const validate: ValidateFunction<RewardAssignedEvent>;
57
+ }
58
+ export declare namespace CampaignOutOfFundsEvent {
59
+ const schema: JSONSchema<CampaignOutOfFundsEvent>;
60
+ const validate: ValidateFunction<CampaignOutOfFundsEvent>;
61
+ }
62
+ export declare namespace CampaignGasPriceHigherThanExpectedEvent {
63
+ const schema: JSONSchema<CampaignGasPriceHigherThanExpectedEvent>;
64
+ const validate: ValidateFunction<CampaignGasPriceHigherThanExpectedEvent>;
65
+ }
66
+ export declare namespace CampaignOutOfStockEvent {
67
+ const schema: JSONSchema<CampaignOutOfStockEvent>;
68
+ const validate: ValidateFunction<CampaignOutOfStockEvent>;
69
+ }
70
+ export declare namespace RewardDelayedEvent {
71
+ const schema: JSONSchema<RewardDelayedEvent>;
72
+ const validate: ValidateFunction<RewardDelayedEvent>;
73
+ }
74
+ export {};
75
+ //# sourceMappingURL=rewards.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rewards.d.ts","sourceRoot":"","sources":["../../../src/platform/events/rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAyB,UAAU,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACtF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE1C,KAAK,iBAAiB,GAAG;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACpD,WAAW,EAAE,UAAU,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,mCAAmC,GAAG,iBAAiB,GAAG;IACpE,KAAK,EAAE,UAAU,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAID,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG;IAC9C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAA;IAClD,QAAQ,EAAE,mBAAmB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAA;IAC/C,QAAQ,EAAE,mBAAmB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG;IAChD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAA;IACrD,QAAQ,EAAE,mCAAmC,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,uCAAuC,GAAG,SAAS,GAAG;IAChE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,uCAAuC,CAAA;IACvE,QAAQ,EAAE,mCAAmC,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG;IAChD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAA;IACrD,QAAQ,EAAE,mCAAmC,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAA;IAC9C,QAAQ,EAAE,mBAAmB,CAAA;CAC9B,CAAA;AA6CD,yBAAiB,qBAAqB,CAAC;IAC9B,MAAM,MAAM,EAAE,UAAU,CAAC,qBAAqB,CAGpD,CAAA;IACM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,qBAAqB,CAAiC,CAAA;CAC/F;AAED,yBAAiB,mBAAmB,CAAC;IAC5B,MAAM,MAAM,EAAE,UAAU,CAAC,mBAAmB,CAGlD,CAAA;IACM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,mBAAmB,CAAiC,CAAA;CAC7F;AAED,yBAAiB,uBAAuB,CAAC;IAChC,MAAM,MAAM,EAAE,UAAU,CAAC,uBAAuB,CAGtD,CAAA;IACM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,uBAAuB,CAAiC,CAAA;CACjG;AAED,yBAAiB,uCAAuC,CAAC;IAChD,MAAM,MAAM,EAAE,UAAU,CAAC,uCAAuC,CAGtE,CAAA;IACM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,uCAAuC,CAAiC,CAAA;CACjH;AAED,yBAAiB,uBAAuB,CAAC;IAChC,MAAM,MAAM,EAAE,UAAU,CAAC,uBAAuB,CAGtD,CAAA;IACM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,uBAAuB,CAAiC,CAAA;CACjG;AAED,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAGjD,CAAA;IACM,MAAM,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,CAAiC,CAAA;CAC5F"}
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RewardDelayedEvent = exports.CampaignOutOfStockEvent = exports.CampaignGasPriceHigherThanExpectedEvent = exports.CampaignOutOfFundsEvent = exports.RewardAssignedEvent = exports.RewardInProgressEvent = void 0;
4
+ const validation_1 = require("../../validation");
5
+ const base_1 = require("./base");
6
+ function createSchema(subType, metadataSchema) {
7
+ return {
8
+ type: 'object',
9
+ properties: {
10
+ type: { type: 'string', const: base_1.Events.Type.REWARDS },
11
+ subType: { type: 'string', const: subType },
12
+ key: { type: 'string' },
13
+ timestamp: { type: 'number', minimum: 0 },
14
+ metadata: metadataSchema
15
+ },
16
+ required: ['type', 'subType', 'key', 'timestamp', 'metadata'],
17
+ additionalProperties: false
18
+ };
19
+ }
20
+ const rewardEventMetadataSchema = {
21
+ type: 'object',
22
+ properties: {
23
+ title: { type: 'string' },
24
+ description: { type: 'string' },
25
+ beneficiary: { type: 'string' },
26
+ tokenName: { type: 'string' },
27
+ tokenImage: { type: 'string' },
28
+ tokenRarity: { type: 'string', nullable: true },
29
+ tokenCategory: { type: 'string', nullable: true }
30
+ },
31
+ required: ['title', 'description', 'beneficiary', 'tokenName', 'tokenImage'],
32
+ additionalProperties: false
33
+ };
34
+ const campaignEventMetadataSchema = {
35
+ type: 'object',
36
+ properties: {
37
+ title: { type: 'string' },
38
+ description: { type: 'string' },
39
+ owner: { type: 'string' },
40
+ campaignId: { type: 'string' },
41
+ campaignName: { type: 'string' }
42
+ },
43
+ required: ['title', 'description', 'owner', 'campaignId', 'campaignName'],
44
+ additionalProperties: false
45
+ };
46
+ var RewardInProgressEvent;
47
+ (function (RewardInProgressEvent) {
48
+ RewardInProgressEvent.schema = createSchema(base_1.Events.SubType.Rewards.REWARD_IN_PROGRESS, rewardEventMetadataSchema);
49
+ RewardInProgressEvent.validate = (0, validation_1.generateLazyValidator)(RewardInProgressEvent.schema);
50
+ })(RewardInProgressEvent = exports.RewardInProgressEvent || (exports.RewardInProgressEvent = {}));
51
+ var RewardAssignedEvent;
52
+ (function (RewardAssignedEvent) {
53
+ RewardAssignedEvent.schema = createSchema(base_1.Events.SubType.Rewards.REWARD_ASSIGNED, rewardEventMetadataSchema);
54
+ RewardAssignedEvent.validate = (0, validation_1.generateLazyValidator)(RewardAssignedEvent.schema);
55
+ })(RewardAssignedEvent = exports.RewardAssignedEvent || (exports.RewardAssignedEvent = {}));
56
+ var CampaignOutOfFundsEvent;
57
+ (function (CampaignOutOfFundsEvent) {
58
+ CampaignOutOfFundsEvent.schema = createSchema(base_1.Events.SubType.Rewards.CAMPAIGN_OUT_OF_FUNDS, campaignEventMetadataSchema);
59
+ CampaignOutOfFundsEvent.validate = (0, validation_1.generateLazyValidator)(CampaignOutOfFundsEvent.schema);
60
+ })(CampaignOutOfFundsEvent = exports.CampaignOutOfFundsEvent || (exports.CampaignOutOfFundsEvent = {}));
61
+ var CampaignGasPriceHigherThanExpectedEvent;
62
+ (function (CampaignGasPriceHigherThanExpectedEvent) {
63
+ CampaignGasPriceHigherThanExpectedEvent.schema = createSchema(base_1.Events.SubType.Rewards.CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED, campaignEventMetadataSchema);
64
+ CampaignGasPriceHigherThanExpectedEvent.validate = (0, validation_1.generateLazyValidator)(CampaignGasPriceHigherThanExpectedEvent.schema);
65
+ })(CampaignGasPriceHigherThanExpectedEvent = exports.CampaignGasPriceHigherThanExpectedEvent || (exports.CampaignGasPriceHigherThanExpectedEvent = {}));
66
+ var CampaignOutOfStockEvent;
67
+ (function (CampaignOutOfStockEvent) {
68
+ CampaignOutOfStockEvent.schema = createSchema(base_1.Events.SubType.Rewards.CAMPAIGN_OUT_OF_STOCK, campaignEventMetadataSchema);
69
+ CampaignOutOfStockEvent.validate = (0, validation_1.generateLazyValidator)(CampaignOutOfStockEvent.schema);
70
+ })(CampaignOutOfStockEvent = exports.CampaignOutOfStockEvent || (exports.CampaignOutOfStockEvent = {}));
71
+ var RewardDelayedEvent;
72
+ (function (RewardDelayedEvent) {
73
+ RewardDelayedEvent.schema = createSchema(base_1.Events.SubType.Rewards.REWARD_DELAYED, rewardEventMetadataSchema);
74
+ RewardDelayedEvent.validate = (0, validation_1.generateLazyValidator)(RewardDelayedEvent.schema);
75
+ })(RewardDelayedEvent = exports.RewardDelayedEvent || (exports.RewardDelayedEvent = {}));
76
+ //# sourceMappingURL=rewards.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rewards.js","sourceRoot":"","sources":["../../../src/platform/events/rewards.ts"],"names":[],"mappings":";;;AACA,iDAAsF;AACtF,iCAA0C;AA2D1C,SAAS,YAAY,CAAI,OAAe,EAAE,cAAoC;IAC5E,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAM,CAAC,IAAI,CAAC,OAAO,EAAE;YACpD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;YAC3C,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACvB,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE;YACzC,QAAQ,EAAE,cAAc;SACzB;QACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC;QAC7D,oBAAoB,EAAE,KAAK;KACX,CAAA;AACpB,CAAC;AAED,MAAM,yBAAyB,GAAoC;IACjE,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC/C,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KAClD;IACD,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,CAAC;IAC5E,oBAAoB,EAAE,KAAK;CAC5B,CAAA;AAED,MAAM,2BAA2B,GAAoD;IACnF,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KACjC;IACD,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,cAAc,CAAC;IACzE,oBAAoB,EAAE,KAAK;CAC5B,CAAA;AAED,IAAiB,qBAAqB,CAMrC;AAND,WAAiB,qBAAqB;IACvB,4BAAM,GAAsC,YAAY,CACnE,aAAM,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,EACzC,yBAAyB,CAC1B,CAAA;IACY,8BAAQ,GAA4C,IAAA,kCAAqB,EAAC,sBAAA,MAAM,CAAC,CAAA;AAChG,CAAC,EANgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMrC;AAED,IAAiB,mBAAmB,CAMnC;AAND,WAAiB,mBAAmB;IACrB,0BAAM,GAAoC,YAAY,CACjE,aAAM,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,EACtC,yBAAyB,CAC1B,CAAA;IACY,4BAAQ,GAA0C,IAAA,kCAAqB,EAAC,oBAAA,MAAM,CAAC,CAAA;AAC9F,CAAC,EANgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAMnC;AAED,IAAiB,uBAAuB,CAMvC;AAND,WAAiB,uBAAuB;IACzB,8BAAM,GAAwC,YAAY,CACrE,aAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,EAC5C,2BAA2B,CAC5B,CAAA;IACY,gCAAQ,GAA8C,IAAA,kCAAqB,EAAC,wBAAA,MAAM,CAAC,CAAA;AAClG,CAAC,EANgB,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAMvC;AAED,IAAiB,uCAAuC,CAMvD;AAND,WAAiB,uCAAuC;IACzC,8CAAM,GAAwD,YAAY,CACrF,aAAM,CAAC,OAAO,CAAC,OAAO,CAAC,uCAAuC,EAC9D,2BAA2B,CAC5B,CAAA;IACY,gDAAQ,GAA8D,IAAA,kCAAqB,EAAC,wCAAA,MAAM,CAAC,CAAA;AAClH,CAAC,EANgB,uCAAuC,GAAvC,+CAAuC,KAAvC,+CAAuC,QAMvD;AAED,IAAiB,uBAAuB,CAMvC;AAND,WAAiB,uBAAuB;IACzB,8BAAM,GAAwC,YAAY,CACrE,aAAM,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,EAC5C,2BAA2B,CAC5B,CAAA;IACY,gCAAQ,GAA8C,IAAA,kCAAqB,EAAC,wBAAA,MAAM,CAAC,CAAA;AAClG,CAAC,EANgB,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAMvC;AAED,IAAiB,kBAAkB,CAMlC;AAND,WAAiB,kBAAkB;IACpB,yBAAM,GAAmC,YAAY,CAChE,aAAM,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,EACrC,yBAAyB,CAC1B,CAAA;IACY,2BAAQ,GAAyC,IAAA,kCAAqB,EAAC,mBAAA,MAAM,CAAC,CAAA;AAC7F,CAAC,EANgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAMlC"}
package/dist/schemas.d.ts CHANGED
@@ -246,11 +246,16 @@ export declare type BaseBid = {
246
246
 
247
247
  export declare type BaseEvent = {
248
248
  type: Events.Type;
249
- subType: Events.SubType.Blockchain | Events.SubType.CatalystDeployment | Events.SubType.Client | Events.SubType.Marketplace;
249
+ subType: Events.SubType.Blockchain | Events.SubType.CatalystDeployment | Events.SubType.Client | Events.SubType.Marketplace | Events.SubType.Rewards;
250
250
  key: string;
251
251
  timestamp: number;
252
252
  };
253
253
 
254
+ declare type BaseEventMetadata = {
255
+ title: string;
256
+ description: string;
257
+ };
258
+
254
259
  /**
255
260
  * @public
256
261
  *
@@ -358,6 +363,45 @@ export declare namespace BodyShape {
358
363
  const validate: ValidateFunction<BodyShape>;
359
364
  }
360
365
 
366
+ export declare type CampaignGasPriceHigherThanExpectedEvent = BaseEvent & {
367
+ type: Events.Type.REWARDS;
368
+ subType: Events.SubType.Rewards.CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED;
369
+ metadata: CampaignWellKnownIssueEventMetadata;
370
+ };
371
+
372
+ export declare namespace CampaignGasPriceHigherThanExpectedEvent {
373
+ const schema: JSONSchema<CampaignGasPriceHigherThanExpectedEvent>;
374
+ const validate: ValidateFunction<CampaignGasPriceHigherThanExpectedEvent>;
375
+ }
376
+
377
+ export declare type CampaignOutOfFundsEvent = BaseEvent & {
378
+ type: Events.Type.REWARDS;
379
+ subType: Events.SubType.Rewards.CAMPAIGN_OUT_OF_FUNDS;
380
+ metadata: CampaignWellKnownIssueEventMetadata;
381
+ };
382
+
383
+ export declare namespace CampaignOutOfFundsEvent {
384
+ const schema: JSONSchema<CampaignOutOfFundsEvent>;
385
+ const validate: ValidateFunction<CampaignOutOfFundsEvent>;
386
+ }
387
+
388
+ export declare type CampaignOutOfStockEvent = BaseEvent & {
389
+ type: Events.Type.REWARDS;
390
+ subType: Events.SubType.Rewards.CAMPAIGN_OUT_OF_STOCK;
391
+ metadata: CampaignWellKnownIssueEventMetadata;
392
+ };
393
+
394
+ export declare namespace CampaignOutOfStockEvent {
395
+ const schema: JSONSchema<CampaignOutOfStockEvent>;
396
+ const validate: ValidateFunction<CampaignOutOfStockEvent>;
397
+ }
398
+
399
+ export declare type CampaignWellKnownIssueEventMetadata = BaseEventMetadata & {
400
+ owner: EthAddress;
401
+ campaignId: string;
402
+ campaignName: string;
403
+ };
404
+
361
405
  /**
362
406
  * All the possible Marketplace's catalog filters.
363
407
  * @public
@@ -823,14 +867,15 @@ export declare namespace EthAddress {
823
867
  const validate: ValidateFunction<EthAddress>;
824
868
  }
825
869
 
826
- export declare type Event = BidAcceptedEvent | BidReceivedEvent | ItemSoldEvent | RentalEndedEvent | RentalStartedEvent | RoyaltiesEarnedEvent | CollectionCreatedEvent | MoveToParcelEvent | CatalystDeploymentEvent;
870
+ export declare type Event = BidAcceptedEvent | BidReceivedEvent | ItemSoldEvent | RentalEndedEvent | RentalStartedEvent | RoyaltiesEarnedEvent | CollectionCreatedEvent | MoveToParcelEvent | CatalystDeploymentEvent | RewardInProgressEvent | RewardAssignedEvent | CampaignOutOfFundsEvent | CampaignGasPriceHigherThanExpectedEvent | CampaignOutOfStockEvent | RewardDelayedEvent;
827
871
 
828
872
  export declare namespace Events {
829
873
  export enum Type {
830
874
  BLOCKCHAIN = "blockchain",
831
875
  CATALYST_DEPLOYMENT = "catalyst-deployment",
832
876
  CLIENT = "client",
833
- MARKETPLACE = "marketplace"
877
+ MARKETPLACE = "marketplace",
878
+ REWARDS = "rewards"
834
879
  }
835
880
  export namespace SubType {
836
881
  export enum Blockchain {
@@ -855,6 +900,14 @@ export declare namespace Events {
855
900
  export enum Client {
856
901
  MOVE_TO_PARCEL = "move-to-parcel"
857
902
  }
903
+ export enum Rewards {
904
+ REWARD_IN_PROGRESS = "reward-in-progress",
905
+ REWARD_ASSIGNED = "reward-assigned",
906
+ CAMPAIGN_OUT_OF_FUNDS = "campaign-out-of-funds",
907
+ CAMPAIGN_GAS_PRICE_HIGHER_THAN_EXPECTED = "campaign-gas-price-higher-than-expected",
908
+ CAMPAIGN_OUT_OF_STOCK = "campaign-out-of-stock",
909
+ REWARD_DELAYED = "reward-delayed"
910
+ }
858
911
  }
859
912
  }
860
913
 
@@ -2321,6 +2374,47 @@ export declare enum RequiredPermission {
2321
2374
  OPEN_EXTERNAL_LINK = "OPEN_EXTERNAL_LINK"
2322
2375
  }
2323
2376
 
2377
+ export declare type RewardAssignedEvent = BaseEvent & {
2378
+ type: Events.Type.REWARDS;
2379
+ subType: Events.SubType.Rewards.REWARD_ASSIGNED;
2380
+ metadata: RewardEventMetadata;
2381
+ };
2382
+
2383
+ export declare namespace RewardAssignedEvent {
2384
+ const schema: JSONSchema<RewardAssignedEvent>;
2385
+ const validate: ValidateFunction<RewardAssignedEvent>;
2386
+ }
2387
+
2388
+ export declare type RewardDelayedEvent = BaseEvent & {
2389
+ type: Events.Type.REWARDS;
2390
+ subType: Events.SubType.Rewards.REWARD_DELAYED;
2391
+ metadata: RewardEventMetadata;
2392
+ };
2393
+
2394
+ export declare namespace RewardDelayedEvent {
2395
+ const schema: JSONSchema<RewardDelayedEvent>;
2396
+ const validate: ValidateFunction<RewardDelayedEvent>;
2397
+ }
2398
+
2399
+ export declare type RewardEventMetadata = BaseEventMetadata & {
2400
+ beneficiary: EthAddress;
2401
+ tokenName: string;
2402
+ tokenImage: string;
2403
+ tokenRarity?: string;
2404
+ tokenCategory?: string;
2405
+ };
2406
+
2407
+ export declare type RewardInProgressEvent = BaseEvent & {
2408
+ type: Events.Type.REWARDS;
2409
+ subType: Events.SubType.Rewards.REWARD_IN_PROGRESS;
2410
+ metadata: RewardEventMetadata;
2411
+ };
2412
+
2413
+ export declare namespace RewardInProgressEvent {
2414
+ const schema: JSONSchema<RewardInProgressEvent>;
2415
+ const validate: ValidateFunction<RewardInProgressEvent>;
2416
+ }
2417
+
2324
2418
  export declare type RoyaltiesEarnedEvent = BaseEvent & {
2325
2419
  type: Events.Type.BLOCKCHAIN;
2326
2420
  subType: Events.SubType.Blockchain.ROYALTIES_EARNED;
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "13.6.3",
2
+ "version": "13.6.4-20240827124856.commit-06fbd23",
3
3
  "name": "@dcl/schemas",
4
4
  "main": "./dist/index.js",
5
5
  "typings": "./dist/index.d.ts",
@@ -45,5 +45,5 @@
45
45
  "files": [
46
46
  "dist"
47
47
  ],
48
- "commit": "6367df13927fa0024da1bf9f6602a8775566e1a6"
48
+ "commit": "06fbd238f5f03ce4d75e2cb2655c4cce090e5007"
49
49
  }