symmetry-cli 1.0.0

package/dist/websocket-server.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsServer = void 0;
+const http_1 = require("http");
+const ws_1 = require("ws");
+class WsServer {
+    constructor(port, peerRepository, swarm) {
+        this.wssListeners = () => {
+            var _a;
+            (_a = this._wss) === null || _a === void 0 ? void 0 : _a.on("connection", (ws) => {
+                this.sendStats(ws);
+                const interval = setInterval(() => this.sendStats(ws), 5000);
+                ws.on("close", () => {
+                    clearInterval(interval);
+                });
+            });
+        };
+        this._peerRepository = peerRepository;
+        this._swarm = swarm;
+        this.start(port);
+    }
+    start(port) {
+        const server = (0, http_1.createServer)();
+        this._wss = new ws_1.WebSocketServer({ server });
+        server.listen(port);
+        this.wssListeners();
+    }
+    async sendStats(ws) {
+        const stats = await this.getStats(this._swarm);
+        ws.send(JSON.stringify(stats));
+    }
+    async broadcastStats() {
+        var _a;
+        const stats = await this.getStats(this._swarm);
+        (_a = this._wss) === null || _a === void 0 ? void 0 : _a.clients.forEach((client) => {
+            if (client.readyState === ws_1.WebSocket.OPEN) {
+                client.send(JSON.stringify(stats));
+            }
+        });
+    }
+    async getStats(swarm) {
+        const activePeers = await this._peerRepository.getActivePeerCount();
+        const activeModels = await this._peerRepository.getActiveModelCount();
+        const swarmConnections = swarm.connections.size;
+        return {
+            activePeers,
+            activeModels,
+            swarmConnections,
+        };
+    }
+}
+exports.WsServer = WsServer;

package/global.d.ts

@@ -0,0 +1,51 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+declare module "b4a"
+
+declare module "hyperswarm" {
+  import { EventEmitter } from "events";
+
+  export interface Swarm {
+    flushed(): Promise<void>;
+  }
+
+  export interface JoinOptions {
+    client?: boolean;
+    server?: boolean;
+  }
+
+  export interface SwarmOptions {
+    keyPair?: any;
+    seed?: Buffer;
+    maxPeers?: number;
+    firewall?: (remotePublicKey: string) => boolean;
+    dht?: any;
+    maxConnections: number;
+  }
+
+  export default class Hyperswarm extends EventEmitter {
+    constructor(opts?: SwarmOptions);
+    join(topic: string | Buffer, opts?: JoinOptions): Swarm;
+    on: (key: string, cb: (data: any) => void) => void;
+    once: (key: string, cb: (data: any) => void) => void;
+    flush: () => void;
+    leave(topic: Buffer): void;
+    destroy(): Promise<void>;
+    peers: Map<string, any>;
+    connecting: boolean;
+  }
+}
+
+declare module "hypercore-crypto" {
+  const hyperCoreCrypto: {
+    keyPair: (seed?: Buffer) => { publicKey: Buffer; secretKey: Buffer };
+    discoveryKey: (publicKey: Buffer) => Buffer;
+    randomBytes: (n?: number) => Buffer;
+    verify: (
+      challenge: Buffer,
+      signature: Buffer,
+      publicKey: Buffer
+    ) => boolean;
+  };
+
+  export = hyperCoreCrypto;
+}

package/install.ps1

@@ -0,0 +1,88 @@
+$ErrorActionPreference = "Stop"
+
+# Colors for output
+$RED = "`e[31m"
+$GREEN = "`e[32m"
+$YELLOW = "`e[33m"
+$NC = "`e[0m"
+
+function Print-Color($color, $message) {
+    Write-Host "$color$message$NC"
+}
+
+# Check if npm is installed
+if (!(Get-Command npm -ErrorAction SilentlyContinue)) {
+    Print-Color $RED "Error: npm is not installed. Please install Node.js and npm first."
+    exit 1
+}
+
+# Install symmetry-cli globally
+Print-Color $YELLOW "Installing symmetry-cli globally..."
+try {
+    npm install -g symmetry-cli
+    Print-Color $GREEN "symmetry-cli installed successfully!"
+}
+catch {
+    Print-Color $RED "Failed to install symmetry-cli. Please check your npm configuration and try again."
+    exit 1
+}
+
+# Prompt for API provider
+Print-Color $YELLOW "Please select an API provider:"
+$providers = @{
+    1 = @{name = "LiteLLM"; value = "litellm"}
+    2 = @{name = "LlamaCpp"; value = "llamacpp"}
+    3 = @{name = "LMStudio"; value = "lmstudio"}
+    4 = @{name = "Ollama"; value = "ollama"}
+    5 = @{name = "Oobabooga"; value = "oobabooga"}
+    6 = @{name = "OpenWebUI"; value = "openwebui"}
+}
+
+$providers.GetEnumerator() | ForEach-Object {
+    Write-Host "$($_.Key): $($_.Value.name)"
+}
+
+do {
+    $selection = Read-Host "Enter the number of your choice"
+    $api_provider = $providers[$selection].value
+} while (-not $api_provider)
+
+# Prompt for model name
+Print-Color $YELLOW "Please enter the model name you want to use:"
+$model_name = Read-Host
+
+# Create config directory and provider.yaml file
+$config_dir = "$env:USERPROFILE\.config\symmetry"
+$provider_yaml = "$config_dir\provider.yaml"
+
+New-Item -ItemType Directory -Force -Path $config_dir | Out-Null
+
+if (!(Test-Path $provider_yaml)) {
+    Print-Color $YELLOW "Creating provider.yaml file..."
+    @"
+# Symmetry Configuration
+apiHostname: localhost
+apiKey: 
+apiPath: /v1/chat/completions
+apiPort: 11434
+apiProtocol: http
+apiProvider: $api_provider
+dataCollectionEnabled: true
+maxConnections: 10
+modelName: $model_name
+name: $env:USERNAME
+path: $config_dir
+public: true
+serverKey: 4b4a9cc325d134dee6679e9407420023531fd7e96c563f6c5d00fd5549b77435
+"@ | Set-Content $provider_yaml
+    Print-Color $GREEN "provider.yaml created successfully at $provider_yaml"
+}
+else {
+    Print-Color $YELLOW "provider.yaml already exists at $provider_yaml"
+}
+
+Print-Color $GREEN "Installation complete! You can now run 'symmetry-cli' to start your node."
+Print-Color $YELLOW "Please edit $provider_yaml to customize your provider settings, especially:"
+Print-Color $YELLOW "  - apiKey: Add your API key if required"
+Print-Color $YELLOW "  - name: Currently set to your system username, change if needed"
+Print-Color $YELLOW "  - public: Set to true by default, change to false if you don't want to be publicly accessible"

package/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+.tsx?$": ["ts-jest", {}],
+  },
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "symmetry-cli",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/symmetry.js",
+  "bin": "dist/symmetry.js",
+  "author": "rjmacarthy",
+  "license": "ISC",
+  "scripts": {
+    "test": "jest",
+    "build": "tsc",
+    "package": "pkg ./dist/symmetry.js",
+    "start": "node dist/symmetry.js",
+    "dev": "ts-node src/symmetry.ts",
+    "debug": "ts-node --inspect src/symmetry.ts",
+    "lint": "eslint . --ext .ts,.js --fix"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "hypercore-crypto": "^3.4.2",
+    "hyperdht": "^6.15.4",
+    "hyperswarm": "^4.8.0",
+    "js-yaml": "^4.1.0",
+    "sqlite3": "^5.1.7",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.14.10",
+    "@types/ws": "^8.5.11",
+    "@typescript-eslint/eslint-plugin": "^7.16.1",
+    "@typescript-eslint/parser": "^7.16.1",
+    "eslint": "^8.57.0",
+    "globals": "^15.8.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4"
+  },
+  "types": "types/twinnymind.d.ts"
+}

package/readme.md

@@ -0,0 +1,167 @@
+#  Symmetry
+
+In the vast lands of the Internet, where bits and bytes flow like the rivers of old, there arose a tool of great power and purpose. Symmetry the enchanted mirror. With Symmetry, users of the digital realm could offer their computational strength to others, allowing seekers of knowledge to tap into the wisdom of distant machines.
+
+## Features
+
+- **Network**: A decentralized network, of interconnected peers.
+- **Configuration**: A scroll of YAML, easily inscribed to bend Symmetry to one's will.
+- **Privacy**: A choice between openness and secrecy.
+- **Data collection**: An option to gather tales of interactions, should the provider wish it so.
+
+## Installation
+
+To call forth Symmetry into your realm, speak these words of power:
+
+Linux and MacOs
+```
+curl -fsSL https://raw.githubusercontent.com/twinnydotdev/symmetry/main/install.sh | sh
+```
+
+Windows
+```
+iwr -useb https://raw.githubusercontent.com/twinnydotdev/symmetry/main/install.ps1 | iex
+```
+
+## Usage
+
+To awaken Symmetry, utter this command:
+
+```
+symmetry-cli
+```
+
+Symmetry will seek its tome of knowledge in the halls of `~/.config/symmetry/provider.yaml`. Should you wish to direct it to another scroll, speak thus:
+
+```
+symmetry -c /path/to/your/sacred/provider.yaml
+```
+
+## Configuration
+
+Inscribe your `provider.yaml` with these mystical runes:
+
+```yaml
+apiHostname: localhost # The dwelling of your local oracle
+apiKey: # The secret word to commune with your oracle
+apiPath: /v1/chat/completions # The path to wisdom
+apiPort: 11434 # The gate through which knowledge flows
+apiProtocol: http # The method of communion
+apiProvider: ollama # The lineage of your oracle
+dataCollectionEnabled: true # Whether to gather lore
+maxConnections: 10 # The limit of simultaneous seekers
+modelName: llama3:8b # The true name of your oracle
+name: # Your title in this realm
+path: /home/richard/.config/symmetry/default # The dwelling for data
+public: true # Whether your services are open to all
+serverKey: 4b4a9cc325d134dee6679e9407420023531fd7e96c563f6c5d00fd5549b77435 # The key of the central tower
+```
+
+Adjust these runes to align with your own preferences.
+
+## Architecture
+
+```mermaid
+graph TB
+    S[Symmetry Server]
+    
+    subgraph "Inference Providers"
+        P1[Provider 1]
+        P2[Provider 2]
+        P3[Provider 3]
+    end
+    
+    subgraph "Clients"
+        C1[Client 1<br/>Requests Model B]
+        C2[Client 2<br/>Requests Model C]
+    end
+    
+    P1 <--> |"1. Connect & Auth & Register Model"| S
+    P2 <--> |"1. Connect & Auth & Register Model"| S
+    P3 <--> |"1. Connect & Auth & Register Model"| S
+    
+    C1 -- "2. Connect" --> S
+    C2 -- "2. Connect" --> S
+    
+    S -- "3. Assign Provider<br/>based on Model" --> C1
+    S -- "3. Assign Provider<br/>based on Model" --> C2
+    
+    C1 <--> |"4. Inference<br/>Request/Response"| P2
+    C2 <--> |"4. Inference<br/>Request/Response"| P3
+
+    style S fill:#ff9900,stroke:#333,stroke-width:4px
+    style P1 fill:#00ccff,stroke:#333,stroke-width:2px
+    style P2 fill:#00ccff,stroke:#333,stroke-width:2px
+    style P3 fill:#00ccff,stroke:#333,stroke-width:2px
+    style C1 fill:#333,stroke:#fff,stroke-width:2px
+    style C2 fill:#333,stroke:#fff,stroke-width:2px
+```
+
+### Server, Providers and Clients:
+- **Central Server**: Symmetry Server, a beacon of order in the chaotic digital winds.
+- **Providers**: Inference Providers, keepers of knowledge and computational might.
+- **Client**: Clients, adventurers in search of answers from the oracles of data.
+
+### Connection:
+
+1. The Providers approach the Central Tower, proving their worth and declaring their specialties.
+2. Seekers call out to the Tower, their questions echoing in the digital void.
+3. The Tower, in its wisdom, guides each Seeker to a suitable Provider.
+4. Seeker and Provider join in a dance of query and response, their connection direct and true.
+
+### Communication:
+
+- All messages between Seekers and Providers are cloaked in unbreakable encryption, safe from prying eyes.
+- The Providers may choose to remember the tales told to them, a choice they must declare openly.
+- Seekers are granted the wisdom to choose their Providers based on these declarations of memory.
+
+### Features:
+
+- **Adaptability**: As changeable as the seasons, ready for new knowledge and new seekers.
+- **Swiftness**: Direct connections ensure that wisdom flows like the rapids of a mountain stream.
+- **Guardianship**: Only the worthy may enter this circle of trust.
+- **Balance**: The Tower ensures no single Provider bears too heavy a burden.
+- **Growth**: New Providers may join the circle, expanding the realm of possibility.
+
+Thus does Symmetry weave its web of connections, bringing together the seekers and keepers of digital wisdom in a grand tapestry of knowledge and computation.
+
+## Forging of Symmetry
+
+For those who wish to shape Symmetry with their own hands:
+
+1. Summon the essence:
+   ```
+   git clone https://github.com/twinnydotdev/symmetry.git
+   cd symmetry
+   ```
+
+2. Gather the necessary elements:
+   ```
+   npm install
+   ```
+
+3. Forge the tool:
+   ```
+   npm run build
+   ```
+
+4. Awaken:
+   ```
+   npm start
+   ```
+
+## Call for Heroes
+
+Brave souls willing to improve upon this grand design are most welcome. Present your [scrolls of change](https://github.com/twinnydotdev/symmetry/pulls) for consideration.
+
+## Covenant
+
+This work is protected under the [Oath of MIT](https://github.com/twinnydotdev/symmetry/blob/main/LICENSE), a sacred bond between creator and user.
+
+## Council of Elders
+
+Should you face trials or seek guidance, bring your [queries](https://github.com/twinnydotdev/symmetry/issues) before the Council on GitHub.
+
+## A Nod to the Ancients
+
+We pay homage to [Hyperswarm](https://github.com/holepunchto/hyperswarm), the tool that makes our connections possible.

package/src/config.ts

@@ -0,0 +1,51 @@
+import { ProviderConfig  } from "./types";
+import fs from "fs";
+import yaml from "js-yaml";
+
+export class ConfigManager {
+  private config: ProviderConfig;
+
+  constructor(configPath: string) {
+    const configFile = fs.readFileSync(configPath, "utf8");
+    const config = yaml.load(configFile) as ProviderConfig;
+    this.config = config
+    this.validate();
+  }
+
+  public getAll () {
+    return this.config;
+  }
+
+  private validate(): void {
+    const requiredFields: (keyof ProviderConfig)[] = [
+      "apiHostname",
+      "apiPath",
+      "apiPort",
+      "apiProtocol",
+      "apiProvider",
+      "modelName",
+      "path",
+      "public",
+      "serverKey",
+    ];
+
+    for (const field of requiredFields) {
+      if (!(field in this.config)) {
+        throw new Error(
+          `Missing required field in client configuration: ${field}`
+        );
+      }
+    }
+
+    if (typeof this.config.public !== "boolean") {
+      throw new Error(
+        'The "public" field in client configuration must be a boolean'
+      );
+    }
+  }
+
+  get<K extends keyof ProviderConfig>(key: K): ProviderConfig[K];
+  get(key: string): unknown {
+    return this.config[key as keyof ProviderConfig];
+  }
+}

package/src/constants.ts

@@ -0,0 +1,29 @@
+export const NORMALIZE_REGEX = /\s*\r?\n|\r/g;
+
+export const serverMessageKeys = {
+  challenge: "challenge",
+  conectionSize: "conectionSize",
+  heartbeat: "heartbeat",
+  inference: "inference",
+  inferenceEnded: "inferenceEnded",
+  join: "join",
+  joinAck: "joinAck",
+  leave: "leave",
+  newConversation: "newConversation",
+  ping: "ping",
+  pong: "pong",
+  providerDetails: "providerDetails",
+  reportCompletion: "reportCompletion",
+  requestProvider: "requestProvider",
+  sessionValid: "sessionValid",
+  verifySession: "verifySession",
+} as const;
+
+export const apiProviders = {
+  LiteLLM: 'litellm',
+  LlamaCpp: 'llamacpp',
+  LMStudio: 'lmstudio',
+  Ollama: 'ollama',
+  Oobabooga: 'oobabooga',
+  OpenWebUI: 'openwebui',
+} as const

package/src/logger.ts

@@ -0,0 +1,47 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import chalk from "chalk";
+
+export enum LogLevel {
+  DEBUG,
+  ERROR,
+  INFO,
+  WARNING,
+}
+
+export class Logger {
+  private static instance: Logger;
+  private logLevel: LogLevel = LogLevel.INFO;
+
+  private constructor() {}
+
+  public static getInstance(): Logger {
+    if (!Logger.instance) {
+      Logger.instance = new Logger();
+    }
+    return Logger.instance;
+  }
+
+  public setLogLevel(level: LogLevel): void {
+    this.logLevel = level;
+  }
+
+  public info(message: string, ...args: any[]): void {
+    if (this.logLevel <= LogLevel.INFO) {
+      console.log(chalk.blue("ℹ️ INFO:"), message, ...args);
+    }
+  }
+
+  public warning(message: string, ...args: any[]): void {
+    console.log(chalk.yellow("⚠️ WARNING:"), message, ...args);
+  }
+
+  public error(message: string, ...args: any[]): void {
+    console.error(chalk.red("❌ ERROR:"), message, ...args);
+  }
+
+  public debug(message: string, ...args: any[]): void {
+    console.log(chalk.gray("🐛 DEBUG:"), message, ...args);
+  }
+}
+
+export const logger = Logger.getInstance();