@daohost/host 0.8.0

package/out/unit.d.ts

@@ -0,0 +1,75 @@
+import { UnitStatus, UnitType } from "./host/types";
+/**
+ Revenue generating unit owned by a DAO.
+ @interface
+ */
+export interface IUnit {
+    /** Unique unit string id. For DeFi protocol its defiOrg:protocolKey. */
+    unitId: string;
+    /** Blockchains where Unit deployed. Filled only for initial DAO chain Host instance. */
+    chainIds?: string[];
+    /** DAO UID of Unit Developer (Pool tasks solver) */
+    developerUid?: string;
+}
+/** Unit data that emitted, indexed and saved, translated by Host API later. */
+export interface IUnitEmitData {
+    /** Short name of the unit */
+    name: string;
+    /** Description of the unit */
+    description?: string;
+    /** Status of unit changes appear when unit starting to work and starting earning revenue */
+    status: UnitStatus;
+    /** Supported type of the Unit */
+    type: UnitType;
+    /** The share of a Unit's profit received by the DAO to which it belongs. 100 - 100%. */
+    revenueShare: number;
+    /** A unique emoji for the shortest possible representation of a Unit. */
+    emoji?: string;
+    /** Custom image location for Unit. When not used then DAO image used. */
+    image?: string;
+    /** Frontend endpoints of Unit */
+    ui?: IUnitUILink[];
+    /** Links to API of the Unit */
+    api?: string[];
+    /** Components of the Unit. */
+    pool?: IUnitPool;
+}
+export interface IUnitUILink {
+    href: `https://${string}`;
+    title: string;
+}
+/**
+ * Pool of development tasks for Unit. A set of open GitHub issues.
+ * @interface
+ */
+export interface IUnitPool {
+    repos: string[];
+    /** Label on github repositories identifying relation to the pool. */
+    label: IGithubLabel;
+    contractorSymbol?: string;
+}
+export interface IGithubLabel {
+    name: string;
+    description: string;
+    color: string;
+}
+/** OFF-CHAIN only */
+export interface IGithubUser {
+    username: string;
+    img: string;
+}
+/** OFF-CHAIN only */
+export interface IGithubIssueV2 {
+    repo: string;
+    id: number;
+    title: string;
+    labels: IGithubLabel[];
+    assignees: IGithubUser[];
+    tasks?: {
+        done: boolean;
+        name: string;
+        category?: string;
+    }[];
+    body?: string;
+}
+//# sourceMappingURL=unit.d.ts.map

package/out/unit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit.d.ts","sourceRoot":"","sources":["../src/unit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEpD;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,WAAW,aAAa;IAC5B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4FAA4F;IAC5F,MAAM,EAAE,UAAU,CAAC;IACnB,iCAAiC;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,wFAAwF;IACxF,YAAY,EAAE,MAAM,CAAC;IACrB,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC;IACnB,+BAA+B;IAC/B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,8BAA8B;IAE9B,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,MAAM,EAAE,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,qEAAqE;IACrE,KAAK,EAAE,YAAY,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,qBAAqB;AACrB,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,qBAAqB;AACrB,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,SAAS,EAAE,WAAW,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,EAAE,CAAC;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}

package/out/unit.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=unit.js.map

package/out/unit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit.js","sourceRoot":"","sources":["../src/unit.ts"],"names":[],"mappings":""}

package/out/validation.d.ts

@@ -0,0 +1,15 @@
+import { Activity } from "./activity";
+import { IFunding, IVesting, LifecyclePhase } from "./host";
+import { IHostSettings } from "./host/types";
+export declare class Validation {
+    /**
+     * Ensure that the activity array does not contain duplicate activities
+     * and if builder activity exist one more other activity should exist too
+     * @param activity
+     */
+    static validateActivity(activity: Activity[]): void;
+    static validateFunding(daoPhase: LifecyclePhase, fundings: IFunding[], settings: IHostSettings): void;
+    static validateVesting(daoPhase: LifecyclePhase, vestings: IVesting[], settings: IHostSettings, tge?: IFunding): void;
+    private static _validateVesting;
+}
+//# sourceMappingURL=validation.d.ts.map

package/out/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAe,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,qBAAa,UAAU;IACrB;;;;OAIG;WACW,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE;WAgBrC,eAAe,CAC3B,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,QAAQ,EAAE,EACpB,QAAQ,EAAE,aAAa;WAiDX,eAAe,CAC3B,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,QAAQ,EAAE,EACpB,QAAQ,EAAE,aAAa,EACvB,GAAG,CAAC,EAAE,QAAQ;IA8BhB,OAAO,CAAC,MAAM,CAAC,gBAAgB;CA4BhC"}

package/out/validation.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validation = void 0;
+const host_1 = require("./host");
+class Validation {
+    /**
+     * Ensure that the activity array does not contain duplicate activities
+     * and if builder activity exist one more other activity should exist too
+     * @param activity
+     */
+    static validateActivity(activity) {
+        // ensure that the activity array does not contain duplicate activities
+        let set = new Set();
+        for (let a of activity) {
+            if (set.has(a)) {
+                throw new Error("InvalidActivityCombination");
+            }
+            set.add(a);
+        }
+        // if builder activity exist one more other activity should exist too
+        if (activity.length === 0) {
+            throw new Error("ZeroActivityNotAllowed");
+        }
+    }
+    static validateFunding(daoPhase, fundings, settings) {
+        const set = new Set();
+        for (const funding of fundings) {
+            // ----------------------- Check phase
+            if (funding.type === host_1.FundingType.SEED &&
+                daoPhase !== host_1.LifecyclePhase.DRAFT) {
+                throw new Error("TooLateToUpdateSuchFunding");
+            }
+            if (funding.type === host_1.FundingType.TGE &&
+                ![
+                    host_1.LifecyclePhase.DRAFT,
+                    host_1.LifecyclePhase.SEED,
+                    host_1.LifecyclePhase.DEVELOPMENT,
+                ].includes(daoPhase)) {
+                throw new Error("TooLateToUpdateSuchFunding");
+            }
+            // ----------------------- Check duplicate funding types
+            if (set.has(funding.type)) {
+                throw new Error("InvalidFundingArray");
+            }
+            set.add(funding.type);
+            // ----------------------- Min/max round duration
+            const duration = funding.end - funding.start;
+            if (duration < settings.minFundingDuration * 24 * 3600 ||
+                duration > settings.maxFundingDuration * 24 * 3600) {
+                throw new Error("InvalidFundingPeriod");
+            }
+            // ----------------------- Min/max raise
+            if (funding.minRaise >= funding.maxRaise ||
+                funding.minRaise < settings.minFundingRaise ||
+                funding.maxRaise > settings.maxFundingRaise) {
+                throw new Error("InvalidFundingRaise");
+            }
+            // start date delay is not checked
+        }
+    }
+    static validateVesting(daoPhase, vestings, settings, tge) {
+        if ([
+            host_1.LifecyclePhase.LIVE_CLIFF,
+            host_1.LifecyclePhase.LIVE_VESTING,
+            host_1.LifecyclePhase.LIVE,
+        ].includes(daoPhase)) {
+            throw new Error("TooLateToUpdateVesting");
+        }
+        if (!tge?.claim) {
+            if (vestings.length !== 0) {
+                throw new Error("VestingNotAllowed");
+            }
+        }
+        else {
+            let totalAllocation = 0;
+            for (const vesting of vestings) {
+                // check vesting consistency
+                this._validateVesting(vesting, settings, tge);
+                totalAllocation += vesting.allocation;
+            }
+            if (totalAllocation >= 100) {
+                throw new Error("TotalAllocationTooHigh");
+            }
+        }
+    }
+    static _validateVesting(vesting, settings, tge) {
+        if (vesting.name.length < settings.minVestingNameLen ||
+            vesting.name.length > settings.maxVestingNameLen) {
+            throw new Error(`NameLength(${vesting.name.length})`);
+        }
+        if (vesting.allocation === 0) {
+            throw new Error("ZeroValueNotAllowed");
+        }
+        if (vesting.start < (tge.claim ?? 0) + settings.minCliff * 24 * 3600) {
+            throw new Error("IncorrectVestingStart");
+        }
+        const duration = vesting.end - vesting.start;
+        if (duration < settings.minVestingDuration * 24 * 3600 ||
+            duration > settings.maxVestingDuration * 24 * 3600) {
+            throw new Error("InvalidVestingPeriod");
+        }
+    }
+}
+exports.Validation = Validation;
+//# sourceMappingURL=validation.js.map

package/out/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":";;;AACA,iCAAyE;AAGzE,MAAa,UAAU;IACrB;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,QAAoB;QACjD,uEAAuE;QACvE,IAAI,GAAG,GAAkB,IAAI,GAAG,EAAE,CAAC;QACnC,KAAK,IAAI,CAAC,IAAI,QAAQ,EAAE,CAAC;YACvB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAChD,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACb,CAAC;QAED,qEAAqE;QACrE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAC3B,QAAwB,EACxB,QAAoB,EACpB,QAAuB;QAEvB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAe,CAAC;QACnC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,sCAAsC;YACtC,IACE,OAAO,CAAC,IAAI,KAAK,kBAAW,CAAC,IAAI;gBACjC,QAAQ,KAAK,qBAAc,CAAC,KAAK,EACjC,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAChD,CAAC;YACD,IACE,OAAO,CAAC,IAAI,KAAK,kBAAW,CAAC,GAAG;gBAChC,CAAC;oBACC,qBAAc,CAAC,KAAK;oBACpB,qBAAc,CAAC,IAAI;oBACnB,qBAAc,CAAC,WAAW;iBAC3B,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACpB,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAChD,CAAC;YACD,wDAAwD;YACxD,IAAI,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACzC,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEtB,iDAAiD;YACjD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;YAC7C,IACE,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI;gBAClD,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI,EAClD,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC1C,CAAC;YAED,wCAAwC;YACxC,IACE,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ;gBACpC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,eAAe;gBAC3C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,eAAe,EAC3C,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACzC,CAAC;YAED,kCAAkC;QACpC,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAC3B,QAAwB,EACxB,QAAoB,EACpB,QAAuB,EACvB,GAAc;QAEd,IACE;YACE,qBAAc,CAAC,UAAU;YACzB,qBAAc,CAAC,YAAY;YAC3B,qBAAc,CAAC,IAAI;SACpB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACpB,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;YAChB,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,eAAe,GAAG,CAAC,CAAC;YACxB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC/B,4BAA4B;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;gBAC9C,eAAe,IAAI,OAAO,CAAC,UAAU,CAAC;YACxC,CAAC;YAED,IAAI,eAAe,IAAI,GAAG,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAC7B,OAAiB,EACjB,QAAuB,EACvB,GAAa;QAEb,IACE,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,iBAAiB;YAChD,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,iBAAiB,EAChD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,cAAc,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;QAC7C,IACE,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI;YAClD,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,GAAG,EAAE,GAAG,IAAI,EAClD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;CACF;AAxID,gCAwIC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@daohost/host",
+  "version": "0.8.0",
+  "description": "Host library",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "files": [
+    "out",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
+  "repository": "https://github.com/daohost/host.git",
+  "author": "Host Dev",
+  "license": "GPL-3.0",
+  "scripts": {
+    "host": "ts-node tools/overview.ts",
+    "overview": "ts-node tools/overview.ts",
+    "draw:dao": "ts-node tools/draw-dao-images.ts",
+    "build": "tsc",
+    "test": "jest",
+    "coverage": "jest --collect-coverage",
+    "postbuild": "shx cp src/tokenlist.json out/",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "canvas": "^3.2.1",
+    "jest": "^30.2.0",
+    "prettier": "^3.7.4",
+    "shx": "^0.4.0",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}