@stabilitydao/host 0.2.1

package/README.md

@@ -0,0 +1,35 @@
+# Host: A Cozy Home for DAOs
+
+<p align="left">
+<a href="https://dao.host">
+<img src="/logo.png" title="Infrastructure layer for strategic DeFi Assets Management">
+</a>
+</p>
+
+Unit Status: PROTOTYPE
+
+**Host** is an Operating System of Self-developing Decentralized Autonomous Organizations.
+
+This repository contains the core Host integration library and its typescript implementation.
+
+## Library contents
+
+- `src/api.ts` Host API types
+- `src/host.ts` Host typescript implementation.
+- `src/daos.ts` All deployed DAOs dump for apps.
+- `src/chains.ts` Blockchain data.
+- `src/tokenlist.json` Supported tokens.
+- `src/assets.ts` Extended assets data (description, website, colors).
+
+## Use
+
+```shell
+#coming soon
+```
+
+## Develop
+
+```shell
+yarn coverage
+yarn prettier --write .
+```

package/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  preset: "ts-jest",
+  transform: { "^.+\\.ts?$": "ts-jest" },
+  testEnvironment: "node",
+  testRegex: "/tests/.*\\.(test|spec)?\\.(ts|tsx)$",
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  modulePathIgnorePatterns: ["out"],
+  collectCoverageFrom: ["src/**/*.ts"],
+};

package/out/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDAOUnit = exports.daoMetaData = exports.daos = exports.UnitType = exports.UnitStatus = exports.Host = exports.LifecyclePhase = exports.Activity = exports.getAsset = exports.assets = exports.tokenlist = exports.getChainByName = exports.ChainStatus = exports.ChainName = exports.chainStatusInfo = exports.chains = void 0;
+const chains_1 = require("./chains");
+Object.defineProperty(exports, "chains", { enumerable: true, get: function () { return chains_1.chains; } });
+Object.defineProperty(exports, "chainStatusInfo", { enumerable: true, get: function () { return chains_1.chainStatusInfo; } });
+Object.defineProperty(exports, "ChainName", { enumerable: true, get: function () { return chains_1.ChainName; } });
+Object.defineProperty(exports, "ChainStatus", { enumerable: true, get: function () { return chains_1.ChainStatus; } });
+Object.defineProperty(exports, "getChainByName", { enumerable: true, get: function () { return chains_1.getChainByName; } });
+const tokenlist_json_1 = __importDefault(require("./tokenlist.json"));
+exports.tokenlist = tokenlist_json_1.default;
+const assets_1 = require("./assets");
+Object.defineProperty(exports, "assets", { enumerable: true, get: function () { return assets_1.assets; } });
+Object.defineProperty(exports, "getAsset", { enumerable: true, get: function () { return assets_1.getAsset; } });
+const activity_1 = require("./activity");
+Object.defineProperty(exports, "Activity", { enumerable: true, get: function () { return activity_1.Activity; } });
+const host_1 = require("./host");
+Object.defineProperty(exports, "LifecyclePhase", { enumerable: true, get: function () { return host_1.LifecyclePhase; } });
+Object.defineProperty(exports, "Host", { enumerable: true, get: function () { return host_1.Host; } });
+Object.defineProperty(exports, "UnitStatus", { enumerable: true, get: function () { return host_1.UnitStatus; } });
+Object.defineProperty(exports, "UnitType", { enumerable: true, get: function () { return host_1.UnitType; } });
+Object.defineProperty(exports, "getDAOUnit", { enumerable: true, get: function () { return host_1.getDAOUnit; } });
+const daos_1 = require("./storage/daos");
+Object.defineProperty(exports, "daos", { enumerable: true, get: function () { return daos_1.daos; } });
+const daoMetaData_1 = require("./storage/daoMetaData");
+Object.defineProperty(exports, "daoMetaData", { enumerable: true, get: function () { return daoMetaData_1.daoMetaData; } });
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@stabilitydao/host",
+  "version": "0.2.1",
+  "description": "Host library",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "repository": "https://github.com/stabilitydao/host.git",
+  "author": "Host Dev",
+  "license": "GPL-3.0",
+  "private": false,
+  "scripts": {
+    "host": "ts-node tools/overview.ts",
+    "overview": "ts-node tools/overview.ts",
+    "build": "tsc",
+    "test": "jest",
+    "coverage": "jest --collect-coverage",
+    "postbuild": "shx cp src/tokenlist.json out/"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "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"
+  }
+}

package/src/activity/builder.ts

@@ -0,0 +1,141 @@
+/**
+ BUILDER activity.
+ BUILDER is a team of engineers managed by DAOs.
+ */
+
+import { UnitComponentCategory } from "../host";
+
+/**
+ BUILDER data.
+
+ @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;
+  }[];
+}
+
+/**
+ Engineer hired by a DAO. Can be human or machine (AI agent).
+
+ @alpha
+ @interface
+ */
+export interface IWorker {
+  /** Github username */
+  github: string;
+  /** USD hourly rate */
+  rate?: number;
+  /** USD xTOKEN hourly rate */
+  xRate?: number;
+}
+
+/**
+ * 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 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: 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 {
+  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",
+}
+
+export interface IConveyorStep {
+  name: string;
+  issues: {
+    repo: string;
+    taskList?: string[];
+    issueTemplate?: string;
+    body?: string;
+    generator?: string;
+  }[];
+  artifacts?: ArtifactType[];
+  result?: string;
+  guide?: string;
+}
+
+export interface IBuildersMemory {
+  [tokenSymbol: string]: {
+    openIssues: {
+      total: { [repo: string]: number };
+      pools: { [poolName: string]: IGithubIssue[] };
+    };
+    conveyors: {
+      [conveyorName: string]: {
+        [taskId: string]: {
+          [stepName: string]: IGithubIssue[];
+        };
+      };
+    };
+  };
+}

package/src/activity/index.ts

@@ -0,0 +1,34 @@
+import { UnitType } from "../host";
+
+/** Organization activities supported by OS. */
+export enum Activity {
+  /** Owner of Decentralized Finance protocols */
+  DEFI = "DEFI",
+  /** Owner of Maximum Extractable Value tools */
+  MEV = "MEV",
+  /** BUILDER is a team of engineers managed by DAOs. */
+  BUILDER = "BUILDER",
+  /** Owner of Software as a Service business */
+  //SAAS_OPERATOR = "SAAS_OPERATOR",
+}
+
+export const activities: {
+  [activity in Activity]: {
+    title: string;
+    unitTypes: UnitType[];
+    description?: string;
+  };
+} = {
+  [Activity.DEFI]: {
+    title: "Decentralized Finance Protocol Operator",
+    unitTypes: [UnitType.DEFI_PROTOCOL],
+  },
+  [Activity.MEV]: {
+    title: "Maximum Extractable Value tools",
+    unitTypes: [UnitType.MEV_SEARCHER],
+  },
+  [Activity.BUILDER]: {
+    title: "Team of engineers with multisig wallet.",
+    unitTypes: [],
+  },
+};

package/src/agents.ts

@@ -0,0 +1,31 @@
+/*
+ * Agent is highly abstract and high-level entity that follow role directives.
+ * Agents are owned by DAOs built on Host.
+ */
+
+export interface IAgent {
+  api: string[];
+  roles: AgentRole[];
+  name: string;
+  directives?: string[];
+  image?: string;
+  telegram?: `@${string}`;
+}
+
+export const enum AgentRole {
+  OPERATOR = "OPERATOR",
+}
+
+export interface IAgentRuntime {
+  machineIDs: string[];
+  providers: {
+    name: string;
+    image: string;
+    queries: number;
+  }[];
+}
+
+export const emptyRuntime: IAgentRuntime = {
+  machineIDs: [],
+  providers: [],
+};

package/src/api.ts

@@ -0,0 +1,51 @@
+import { IBuildersMemory } from "./activity/builder";
+
+/**
+ Hot memory with indexed and aggregated data. OS API reply.
+ @interface
+ */
+export interface IOSMemory {
+  /** Prices of assets */
+  prices: Prices;
+
+  /** Total Value Locked in blockchains */
+  chainTvl: { [chainId: string]: number };
+
+  /** DAO runtime data. Updates each minute or faster. */
+  daos: {
+    [symbol: string]: IDAOAPIData;
+  };
+
+  /** Instant Updates by subscribing to github application webhooks */
+  builders: IBuildersMemory;
+}
+
+export interface IDAOAPIData {
+  /** Price from Stability interchain oracle */
+  oraclePrice: string;
+  /** Coingecko price */
+  coingeckoPrice?: string;
+  /** Data for total revenue chart */
+  revenueChart: RevenueChart;
+  /** Extracted on-chain data */
+  onChainData: {
+    [chainId: string]: {
+      stakingAPR: number;
+      staked: number;
+      units: {
+        [unitId: string]: {
+          pendingRevenue: number;
+        };
+      };
+    };
+  };
+}
+
+export type Prices = {
+  [symbol: string]: {
+    price: string;
+    priceChange: number;
+  };
+};
+
+export type RevenueChart = Record<number, string>;