@sonarwatch/portfolio-core 0.11.193 → 0.11.195

package/CHANGELOG.md

@@ -2,10 +2,18 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
-## [0.11.193](https://github.com/sonarwatch/portfolio/compare/core-0.11.192...core-0.11.193) (2024-05-02)
+## [0.11.195](https://github.com/sonarwatch/portfolio/compare/core-0.11.194...core-0.11.195) (2024-05-04)
 
 
 
+## [0.11.194](https://github.com/sonarwatch/portfolio/compare/core-0.11.193...core-0.11.194) (2024-05-04)
+
+
+
+## [0.11.193](https://github.com/sonarwatch/portfolio/compare/core-0.11.192...core-0.11.193) (2024-05-02)
+
+
+
 ## [0.11.192](https://github.com/sonarwatch/portfolio/compare/core-0.11.191...core-0.11.192) (2024-05-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonarwatch/portfolio-core",
-  "version": "0.11.193",
+  "version": "0.11.195",
   "type": "commonjs",
   "dependencies": {
     "@ethersproject/address": "^5.7.0",

package/src/Airdrop.d.ts

@@ -0,0 +1,66 @@
+import { AddressSystemType } from './Address';
+import { NetworkIdType } from './Network';
+import { UsdValue } from './UsdValue';
+export declare enum AirdropClaimStatus {
+    notYetOpen = "notYetOpen",
+    open = "open",
+    closed = "closed"
+}
+export declare enum AirdropUserStatus {
+    claimable = "claimable",
+    claimableLater = "claimableLater",
+    claimed = "claimed",
+    claimMissed = "claimMissed",
+    nonEligible = "nonEligible"
+}
+export declare function getAirdropClaimStatus(claimStart?: number, claimEnd?: number): AirdropClaimStatus;
+export declare function getAirdropUserStatus(claimStatus: AirdropClaimStatus, amount?: number, isClaimed?: boolean): AirdropUserStatus;
+export declare function getAirdropStatus(claimStart?: number, claimEnd?: number, amount?: number, isClaimed?: boolean): {
+    userStatus: AirdropUserStatus;
+    claimStatus: AirdropClaimStatus;
+};
+export type Airdrop = {
+    id: string;
+    claimStatus: AirdropClaimStatus;
+    claimLink: string;
+    claimStart?: number;
+    claimEnd?: number;
+    image: string;
+    organizerLink: string;
+    organizerName: string;
+    name?: string;
+    label: string;
+    price: UsdValue;
+    userStatus: AirdropUserStatus;
+    amount?: number;
+};
+/**
+ * Represents the result of a fetcher.
+ */
+export type AirdropFetcherResult = {
+    date: number;
+    owner: string;
+    networdkId: NetworkIdType;
+    fetcherId: string;
+    duration: number;
+    airdrop: Airdrop;
+};
+/**
+ * Represents the report of a fetcher.
+ */
+export type AirdropFetcherReport = {
+    id: string;
+    status: 'succeeded' | 'failed';
+    duration?: number;
+    error?: string;
+};
+/**
+ * Represents the result of multiple fetchers.
+ */
+export type AirdropFetchersResult = {
+    date: number;
+    owner: string;
+    addressSystem: AddressSystemType;
+    fetcherReports: AirdropFetcherReport[];
+    airdrops: Airdrop[];
+};

package/src/Airdrop.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAirdropStatus = exports.getAirdropUserStatus = exports.getAirdropClaimStatus = exports.AirdropUserStatus = exports.AirdropClaimStatus = void 0;
+var AirdropClaimStatus;
+(function (AirdropClaimStatus) {
+    AirdropClaimStatus["notYetOpen"] = "notYetOpen";
+    AirdropClaimStatus["open"] = "open";
+    AirdropClaimStatus["closed"] = "closed";
+})(AirdropClaimStatus || (exports.AirdropClaimStatus = AirdropClaimStatus = {}));
+var AirdropUserStatus;
+(function (AirdropUserStatus) {
+    AirdropUserStatus["claimable"] = "claimable";
+    AirdropUserStatus["claimableLater"] = "claimableLater";
+    AirdropUserStatus["claimed"] = "claimed";
+    AirdropUserStatus["claimMissed"] = "claimMissed";
+    AirdropUserStatus["nonEligible"] = "nonEligible";
+})(AirdropUserStatus || (exports.AirdropUserStatus = AirdropUserStatus = {}));
+function getAirdropClaimStatus(claimStart, claimEnd) {
+    const now = Date.now();
+    if (claimStart === undefined)
+        return AirdropClaimStatus.notYetOpen;
+    if (claimStart > now)
+        return AirdropClaimStatus.notYetOpen;
+    if (claimEnd === undefined)
+        return AirdropClaimStatus.open;
+    if (claimEnd > now)
+        return AirdropClaimStatus.open;
+    return AirdropClaimStatus.closed;
+}
+exports.getAirdropClaimStatus = getAirdropClaimStatus;
+function getAirdropUserStatus(claimStatus, amount, isClaimed) {
+    if (amount === undefined || amount === 0)
+        return AirdropUserStatus.nonEligible;
+    if (claimStatus === AirdropClaimStatus.notYetOpen)
+        return AirdropUserStatus.claimableLater;
+    if (isClaimed)
+        return AirdropUserStatus.claimed;
+    if (claimStatus === AirdropClaimStatus.closed)
+        return AirdropUserStatus.claimMissed;
+    return AirdropUserStatus.claimable;
+}
+exports.getAirdropUserStatus = getAirdropUserStatus;
+function getAirdropStatus(claimStart, claimEnd, amount, isClaimed) {
+    const claimStatus = getAirdropClaimStatus(claimStart, claimEnd);
+    return {
+        claimStatus,
+        userStatus: getAirdropUserStatus(claimStatus, amount, isClaimed),
+    };
+}
+exports.getAirdropStatus = getAirdropStatus;
+//# sourceMappingURL=Airdrop.js.map

package/src/Airdrop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Airdrop.js","sourceRoot":"","sources":["../../../../packages/core/src/Airdrop.ts"],"names":[],"mappings":";;;AAIA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,mCAAa,CAAA;IACb,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,sDAAiC,CAAA;IACjC,wCAAmB,CAAA;IACnB,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;AAC7B,CAAC,EANW,iBAAiB,iCAAjB,iBAAiB,QAM5B;AAED,SAAgB,qBAAqB,CACnC,UAAmB,EACnB,QAAiB;IAEjB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACnE,IAAI,UAAU,GAAG,GAAG;QAAE,OAAO,kBAAkB,CAAC,UAAU,CAAC;IAC3D,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,kBAAkB,CAAC,IAAI,CAAC;IAC3D,IAAI,QAAQ,GAAG,GAAG;QAAE,OAAO,kBAAkB,CAAC,IAAI,CAAC;IACnD,OAAO,kBAAkB,CAAC,MAAM,CAAC;AACnC,CAAC;AAVD,sDAUC;AAED,SAAgB,oBAAoB,CAClC,WAA+B,EAC/B,MAAe,EACf,SAAmB;IAEnB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,CAAC;QACtC,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAEvC,IAAI,WAAW,KAAK,kBAAkB,CAAC,UAAU;QAC/C,OAAO,iBAAiB,CAAC,cAAc,CAAC;IAE1C,IAAI,SAAS;QAAE,OAAO,iBAAiB,CAAC,OAAO,CAAC;IAEhD,IAAI,WAAW,KAAK,kBAAkB,CAAC,MAAM;QAC3C,OAAO,iBAAiB,CAAC,WAAW,CAAC;IAEvC,OAAO,iBAAiB,CAAC,SAAS,CAAC;AACrC,CAAC;AAjBD,oDAiBC;AAED,SAAgB,gBAAgB,CAC9B,UAAmB,EACnB,QAAiB,EACjB,MAAe,EACf,SAAmB;IAKnB,MAAM,WAAW,GAAG,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAChE,OAAO;QACL,WAAW;QACX,UAAU,EAAE,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC;KACjE,CAAC;AACJ,CAAC;AAdD,4CAcC"}

package/src/Portfolio.d.ts

@@ -19,6 +19,7 @@ export type PortfolioAssetAttributes = {
     /**
      * Represents the date (in ms) when the asset will be unlocked.
      * If current date is greater than this value, the asset is unlocked.
+     * If set to -1, it means it's locked for an unknown or indeterminate period
      */
     lockedUntil?: number;
     /**

package/src/Portfolio.js.map

@@ -1 +1 @@
-{"version":3,"file":"Portfolio.js","sourceRoot":"","sources":["../../../../packages/core/src/Portfolio.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACU,QAAA,kBAAkB,GAAG;IAChC,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;CAClB,CAAC;AAwCX;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;CAChB,CAAC"}
+{"version":3,"file":"Portfolio.js","sourceRoot":"","sources":["../../../../packages/core/src/Portfolio.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACU,QAAA,kBAAkB,GAAG;IAChC,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,aAAa;CAClB,CAAC;AAyCX;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;CAChB,CAAC"}

package/src/index.d.ts

@@ -4,6 +4,7 @@ export * from './name-service';
 export * from './utils';
 export * from './llama';
 export * from './Address';
+export * from './Airdrop';
 export * from './UsdValue';
 export * from './Client';
 export * from './Network';

package/src/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./name-service"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./llama"), exports);
 __exportStar(require("./Address"), exports);
+__exportStar(require("./Airdrop"), exports);
 __exportStar(require("./UsdValue"), exports);
 __exportStar(require("./Client"), exports);
 __exportStar(require("./Network"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB;AACxB,4CAA0B;AAC1B,6CAA2B;AAC3B,2CAAyB;AACzB,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,0CAAwB;AACxB,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB;AACxB,4CAA0B;AAC1B,4CAA0B;AAC1B,6CAA2B;AAC3B,2CAAyB;AACzB,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,0CAAwB;AACxB,mDAAiC"}