ci: merge staging to master

.eslintrc

@@ -10,8 +10,7 @@
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "prettier"
+    "plugin:prettier/recommended"
   ],
   "plugins": [
     "import"

.github/workflows/codesee-arch-diagram.yml

@@ -1,87 +1,23 @@
+# This workflow was added by CodeSee. Learn more at https://codesee.io/
+# This is v2.0 of this workflow file
 on:
   push:
     branches:
-      - master
+      - staging
   pull_request_target:
     types: [opened, synchronize, reopened]
 
-name: CodeSee Map
+name: CodeSee
+
+permissions: read-all
 
 jobs:
-  test_map_action:
+  codesee:
     runs-on: ubuntu-latest
     continue-on-error: true
-    name: Run CodeSee Map Analysis
+    name: Analyze the repo with CodeSee
     steps:
-      - name: checkout
-        id: checkout
-        uses: actions/checkout@v2
-        with:
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          ref: ${{ github.event.pull_request.head.ref }}
-          fetch-depth: 0
-
-      # codesee-detect-languages has an output with id languages.
-      - name: Detect Languages
-        id: detect-languages
-        uses: Codesee-io/codesee-detect-languages-action@latest
-
-      - name: Configure JDK 16
-        uses: actions/setup-java@v2
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).java }}
-        with:
-          java-version: '16'
-          distribution: 'zulu'
-
-      # CodeSee Maps Go support uses a static binary so there's no setup step required.
-
-      - name: Configure Node.js 14
-        uses: actions/setup-node@v2
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).javascript }}
-        with:
-          node-version: '14'
-
-      - name: Configure Python 3.x
-        uses: actions/setup-python@v2
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).python }}
-        with:
-          python-version: '3.10'
-          architecture: 'x64'
-
-      - name: Configure Ruby '3.x'
-        uses: ruby/setup-ruby@v1
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).ruby }}
-        with:
-          ruby-version: '3.0'
-
-      # We need the rust toolchain because it uses rustc and cargo to inspect the package
-      - name: Configure Rust 1.x stable
-        uses: actions-rs/toolchain@v1
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).rust }}
-        with:
-          toolchain: stable
-
-      - name: Generate Map
-        id: generate-map
-        uses: Codesee-io/codesee-map-action@latest
-        with:
-          step: map
-          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
-          github_ref: ${{ github.ref }}
-          languages: ${{ steps.detect-languages.outputs.languages }}
-
-      - name: Upload Map
-        id: upload-map
-        uses: Codesee-io/codesee-map-action@latest
-        with:
-          step: mapUpload
-          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
-          github_ref: ${{ github.ref }}
-
-      - name: Insights
-        id: insights
-        uses: Codesee-io/codesee-map-action@latest
+      - uses: Codesee-io/codesee-action@v2
         with:
-          step: insights
-          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
-          github_ref: ${{ github.ref }}
+          codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
+          codesee-url: https://app.codesee.io

.gitlab-ci.yml

@@ -302,7 +302,7 @@ integration:deployment:
     - echo 'Deploying ECS service to testnet'
     - >
       nix-shell --run $'
-      ./scripts/deploy-service.sh \'polykey-testnet\' \'polykey-testnet\';
+      ./scripts/deploy-service.sh \'polykey-testnet\';
       '
   after_script:
     - rm -f "$REGISTRY_AUTH_FILE"
@@ -402,8 +402,8 @@ integration:linux:
     - job: integration:deployment
       optional: true
   tags:
-    - shared-macos-amd64
-  image: macos-11-xcode-12
+    - saas-macos-medium-m1
+  image: macos-12-xcode-14
   script:
     - for f in ./builds/*-macos-x64*; do "$f"; done
   rules:

ADDITIONAL_TERMS

@@ -0,0 +1,11 @@
+ADDITIONAL TERMS
+
+This file contains additional terms and conditions that apply to the use of this project.
+
+1. Trademark Use. The trademarks and branding assets associated with this project are the exclusive property of MATRIX AI PTY. LTD. ("Owner") and may not be used or displayed in any manner without Owner's express written permission.
+
+2. Derivative Works. Users may not distribute derivative works based on this project that incorporate any of the Owner's trademarks or branding assets, except in the case of a complete, unmodified copy of the original work.
+
+3. Enforcement. Owner reserves the right to enforce these additional terms and conditions, including through legal action if necessary.
+
+4. Disclaimer. This file does not grant any additional rights or permissions beyond those granted by the GPL-3.0 license. Any conflict between the terms of this file and the GPL-3.0 license shall be resolved in favor of the GPL-3.0 license.

README.md

@@ -3,32 +3,40 @@
 staging:[![pipeline status](https://gitlab.com/MatrixAI/open-source/Polykey/badges/staging/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/Polykey/commits/staging)
 master:[![pipeline status](https://gitlab.com/MatrixAI/open-source/Polykey/badges/master/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/Polykey/commits/master)
 
-Secrets management for today's decentralized world of people, services and devices.
+Polykey is an open-source decentralized secrets management and sharing system. It is made for today's decentralized world of people, services and devices.
 
-Use Polykey to share secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure
+* Decentralized Encrypted Storage - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes.
+* Secure Peer-to-Peer Communications - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub).
+* Secure Computational Workflows - Share secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure.
 
-Polykey is an open-source peer to peer decentralized application for secrets management. It is intended to be used by both humans and machines. It synthesizes a unified workflow between interactive password management and infrastructure key management.
+<p align="center">
+  <img src="./images/cli_demo.gif" alt="Polykey CLI Demo"/>
+</p>
+
+Polykey synthesizes a unified workflow between interactive password management and infrastructure key management.
 
 You have complete end-to-end control and privacy over your secrets, with no third-party data collection.
 
-Polykey runs on distributed keynodes referred to as "nodes". Any computing system can run multiple keynodes. Each node manages one or more vaults which are encrypted filesystems with automatic version history. Vaults are shared between the nodes.
+Polykey runs on distributed keynodes referred to as "nodes". Any computing system can run multiple keynodes. Each node manages one or more vaults which are encrypted filesystems with automatic version history. Vaults can be shared between the nodes.
 
-This is the core library for running PolyKey. It provides a CLI `polykey` or `pk` for interacting with the PolyKey system.
+This repository is the core library for Polykey.
 
-For tutorials, how-to guides, reference and theory, see the [wiki](https://github.com/MatrixAI/Polykey/wiki).
+The Polykey project is split up into these main repositories:
 
-* [Polykey](https://github.com/MatrixAI/Polykey) - Polykey core library
-* ~[Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI) - CLI of Polykey~ - TBD
+* [Polykey](https://github.com/MatrixAI/Polykey) - Polykey Core Library
+* [Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI) - CLI of Polykey
 * [Polykey-Desktop](https://github.com/MatrixAI/Polykey-Desktop) - Polykey Desktop (Windows, Mac, Linux) application
 * [Polykey-Mobile](https://github.com/MatrixAI/Polykey-Mobile) - Polykey Mobile (iOS & Android) Application
 
+At the moment, the CLI is embedded in this Polykey Core Library repository. This means it provides the CLI `polykey` or `pk` for interacting with the Polykey system. In the future these will be moved to [Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI).
+
 Have a bug or a feature-request? Please submit it the issues of the relevant subproject above.
 
-Have a question? Join our discussion board: https://github.com/MatrixAI/Polykey/discussions
+For tutorials, how-to guides, reference and theory, see the [docs](https://polykey.io/docs).
 
-Want to learn the theory of secret management? Or how to start using Polykey? Check out our wiki: https://github.com/MatrixAI/Polykey/wiki
+Have a question? Join our [discussion board](https://github.com/MatrixAI/Polykey/discussions).
 
-See our website https://polykey.io for more details!
+Our main website is https://polykey.io
 
 ## Installation
 

benches/index.ts

@@ -1,34 +1,39 @@
 #!/usr/bin/env ts-node
 
+import type { Summary } from 'benny/lib/internal/common-types';
 import fs from 'fs';
 import path from 'path';
 import si from 'systeminformation';
-import gitgc from './gitgc';
+import { fsWalk, resultsPath, suitesPath } from './utils';
 
 async function main(): Promise<void> {
   await fs.promises.mkdir(path.join(__dirname, 'results'), { recursive: true });
-  await gitgc();
-  const resultFilenames = await fs.promises.readdir(
-    path.join(__dirname, 'results'),
-  );
-  const metricsFile = await fs.promises.open(
-    path.join(__dirname, 'results', 'metrics.txt'),
-    'w',
-  );
+  // Running all suites
+  for await (const suitePath of fsWalk(suitesPath)) {
+    // Skip over non-ts and non-js files
+    const ext = path.extname(suitePath);
+    if (ext !== '.ts' && ext !== '.js') {
+      continue;
+    }
+    const suite: () => Promise<Summary> = (await import(suitePath)).default;
+    await suite();
+  }
+  // Concatenating metrics
+  const metricsPath = path.join(resultsPath, 'metrics.txt');
+  await fs.promises.rm(metricsPath);
   let concatenating = false;
-  for (const resultFilename of resultFilenames) {
-    if (/.+_metrics\.txt$/.test(resultFilename)) {
-      const metricsData = await fs.promises.readFile(
-        path.join(__dirname, 'results', resultFilename),
-      );
-      if (concatenating) {
-        await metricsFile.write('\n');
-      }
-      await metricsFile.write(metricsData);
-      concatenating = true;
+  for await (const metricPath of fsWalk(resultsPath)) {
+    // Skip over non-metrics files
+    if (!metricPath.endsWith('_metrics.txt')) {
+      continue;
+    }
+    const metricData = await fs.promises.readFile(metricPath);
+    if (concatenating) {
+      await fs.promises.appendFile(metricsPath, '\n');
     }
+    await fs.promises.appendFile(metricsPath, metricData);
+    concatenating = true;
   }
-  await metricsFile.close();
   const systemData = await si.get({
     cpu: '*',
     osInfo: 'platform, distro, release, kernel, arch',

benches/results/basic/buffer_encoding_decoding.chart.html

@@ -0,0 +1,116 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta http-equiv="X-UA-Compatible" />
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/chart.min.js"></script>
+    <title>basic.buffer_encoding_decoding</title>
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+        background: #ddd;
+      }
+
+      .container {
+        box-sizing: border-box;
+        height: 96vh;
+        width: 96vw;
+        margin: 2vh 2vw;
+        resize: both;
+        overflow: hidden;
+        padding: 20px;
+        background: white;
+        box-shadow: 0 0 15px #aaa;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <canvas id="chart1666662556031" width="16" height="9"></canvas>
+    </div>
+    <script>
+      const format = (num) => {
+        const [whole, fraction] = String(num).split('.')
+        const chunked = []
+        whole
+          .split('')
+          .reverse()
+          .forEach((char, index) => {
+            if (index % 3 === 0) {
+              chunked.unshift([char])
+            } else {
+              chunked[0].unshift(char)
+            }
+          })
+
+        const fractionStr = fraction !== undefined ? '.' + fraction : ''
+
+        return (
+          chunked.map((chunk) => chunk.join('')).join(' ') + fractionStr
+        )
+      }
+      const ctx1666662556031 = document
+        .getElementById('chart1666662556031')
+        .getContext('2d')
+      const chart1666662556031 = new Chart(ctx1666662556031, {
+        type: 'bar',
+        data: {
+          labels: ["JSON stringify and parse buffer","Base64 encode and decode buffer","Base64url encode and decode buffer"],
+          datasets: [
+            {
+              data: [172634,1385074,1327362],
+              backgroundColor: ["hsl(14.951999999999991, 85%, 55%)","hsl(120, 85%, 55%)","hsl(114.996, 85%, 55%)"],
+              borderColor: ["hsl(14.951999999999991, 85%, 55%)","hsl(120, 85%, 55%)","hsl(114.996, 85%, 55%)"],
+              borderWidth: 2,
+            },
+          ],
+        },
+        options: {
+          maintainAspectRatio: false,
+          plugins: {
+            title: {
+              display: true,
+              text: 'basic.buffer_encoding_decoding',
+              font: { size: 20 },
+              padding: 20,
+            },
+            legend: {
+              display: false,
+            },
+            tooltip: {
+              callbacks: {
+                label: (context) => {
+                  return format(context.parsed.y) + ' ops/s'
+                },
+              },
+              displayColors: false,
+              backgroundColor: '#222222',
+              padding: 10,
+              cornerRadius: 5,
+              intersect: false,
+            },
+          },
+          scales: {
+            x: {
+              grid: {
+                color: '#888888',
+              },
+            },
+            y: {
+              title: {
+                display: true,
+                text: 'Operations per second',
+                padding: 10,
+              },
+              grid: {
+                color: '#888888',
+              },
+            },
+          },
+        },
+      })
+    </script>
+  </body>
+</html>