Merge pull request #360 from stabilitydao/upd

📦🍀 OS building

Author: a17

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stabilitydao/stability",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "Stability Operating System Library",
   "main": "out/index.js",
   "types": "out/index.d.ts",

src/activity/builder.ts

@@ -1,70 +1,110 @@
+/**
+ BUILDER activity.
+ BUILDER is a team of engineers managed by DAOs.
+ */
+
 import { UnitComponentCategory } from "../os";
 
-export interface ILabel {
-  name: string;
-  description: string;
-  color: string;
-}
+/**
+ BUILDER data.
 
-export interface IGithubUser {
-  username: string;
-  img: string;
+ @alpha
+ @interface
+ */
+export interface IBuilderActivity {
+  /** Safe multisig account of dev team */
+  multisig: string[];
+  /** Tracked Github repositories where development going on */
+  repo: string[];
+  /** Engineers */
+  workers: IWorker[];
+  /** Conveyors of unit components. */
+  conveyors: IConveyor[];
+  /** Pools of development tasks. */
+  pools: IPool[];
+  /** Total salaries paid */
+  burnRate: {
+    /** Period of burning. Can be 1 month or any other. */
+    period: string;
+    /** How much USD was spent during period. */
+    usdAmount: number;
+  }[];
 }
 
-export interface IIssue {
-  repo: string;
-  id: number;
-  title: string;
-  labels: ILabel[];
-  assignees: IGithubUser;
-  body?: string;
-}
+/**
+ Engineer hired by a DAO. Can be human or machine (AI agent).
 
-export interface IBuildersMemory {
-  [tokenSymbol: string]: {
-    openIssues: {
-      total: { [repo: string]: number };
-      pools: { [poolName: string]: IIssue[] };
-    };
-    conveyors: {
-      [conveyorName: string]: {
-        [taskId: string]: {
-          [stepName: string]: IIssue[];
-        };
-      };
-    };
-  };
+ @alpha
+ @interface
+ */
+export interface IWorker {
+  /** Github username */
+  github: string;
+  /** USD hourly rate */
+  rate?: number;
+  /** USD xTOKEN hourly rate */
+  xRate?: number;
 }
 
 /**
- * Pool of development tasks.
+ * Pool of development tasks. A set of open github issues.
  * @interface
  */
 export interface IPool {
+  /** Pool is always linked to a set of units. */
   unitIds: string[];
+  /** Short name of the pool. */
   name: string;
-  label: ILabel;
-  productTypes?: string[];
+  /** Label on github repositories identifying relation to the pool. */
+  label: IGithubLabel;
+  /** What need to be done by the pool? */
+  description?: string;
+  /** Each solved task in the pool must have an artifact of specified type. */
   artifacts?: ArtifactType[];
 }
 
+/**
+ * Conveyor belt for building a components for units.
+ * @interface
+ */
 export interface IConveyor {
+  /** Linked unit */
   unitId: string;
   componentCategory: UnitComponentCategory;
   name: string;
   symbol: string;
   type: string;
-  label: ILabel;
+  label: IGithubLabel;
   description: string;
   issueTitleTemplate: string;
   taskIdIs: string;
   steps: IConveyorStep[];
 }
 
+export interface IGithubLabel {
+  name: string;
+  description: string;
+  color: string;
+}
+
+export interface IGithubUser {
+  username: string;
+  img: string;
+}
+
+export interface IGithubIssue {
+  repo: string;
+  id: number;
+  title: string;
+  labels: IGithubLabel[];
+  assignees: IGithubUser;
+  body?: string;
+}
+
 export const enum ArtifactType {
-  LIBRARY_RELEASE_TAG = "Library release tag",
-  DEPLOYMENT_ADDRESSES = "Deployment addresses",
   URL_UI = "URL to UI page",
+  URL_RELEASE = "Github package release link",
+  DEPLOYMENT_ADDRESSES = "Deployment addresses",
   URL_API = "API endpoint",
   URL_STATIC = "Static content URL",
   CONTRACT_ADDRESS = "Address of deployed contract",
@@ -84,18 +124,18 @@ export interface IConveyorStep {
   guide?: string;
 }
 
-export interface IBuilderActivity {
-  /** Safe multisig account of dev team */
-  multisig: string[];
-  /** Tracked Github repositories where development going on */
-  repo: string[];
-  burnRate: {
-    period: string;
-    usdAmount: number;
-  }[];
-  workers: string[];
-  /** Conveyors of unit components. */
-  conveyors: IConveyor[];
-  /** Pools of development tasks. */
-  pools: IPool[];
+export interface IBuildersMemory {
+  [tokenSymbol: string]: {
+    openIssues: {
+      total: { [repo: string]: number };
+      pools: { [poolName: string]: IGithubIssue[] };
+    };
+    conveyors: {
+      [conveyorName: string]: {
+        [taskId: string]: {
+          [stepName: string]: IGithubIssue[];
+        };
+      };
+    };
+  };
 }