Introducing vault sharing and the restrictions of pulling and cloning with vault permissions

.eslintrc

@@ -4,8 +4,7 @@
     "commonjs": true,
     "es6": true,
     "node": true,
-    "jest": true,
-    "jasmine": true
+    "jest": true
   },
   "parser": "@typescript-eslint/parser",
   "extends": [
@@ -19,6 +18,9 @@
     "sourceType": "module",
     "ecmaVersion": 2020
   },
+  "globals": {
+    "fail": "readonly"
+  },
   "rules": {
     "linebreak-style": ["error", "unix"],
     "no-empty": 1,
@@ -40,13 +42,20 @@
     "@typescript-eslint/no-namespace": 0,
     "@typescript-eslint/no-explicit-any": 0,
     "@typescript-eslint/explicit-module-boundary-types": 0,
-    "@typescript-eslint/no-unused-vars": "warn",
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "varsIgnorePattern": "^_",
+        "argsIgnorePattern": "^_"
+      }
+    ],
     "@typescript-eslint/no-inferrable-types": 0,
     "@typescript-eslint/no-non-null-assertion": 0,
     "@typescript-eslint/no-this-alias": 0,
     "@typescript-eslint/no-var-requires": 0,
     "@typescript-eslint/ban-ts-comment": 0,
     "@typescript-eslint/no-empty-function": 0,
+    "@typescript-eslint/no-empty-interface": 0,
     "@typescript-eslint/naming-convention": [
       "error",
       {
@@ -64,6 +73,7 @@
       {
         "selector": "parameter",
         "format": ["camelCase"],
+        "leadingUnderscore": "allow",
         "trailingUnderscore": "allowSingleOrDouble"
       },
       {

package.json

@@ -68,8 +68,12 @@
     "polykey": "ts-node -r tsconfig-paths/register src/bin/polykey.ts"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.2.5",
+    "@grpc/grpc-js": "1.3.7",
+    "@matrixai/async-init": "^1.0.0",
+    "@matrixai/db": "^1.0.1",
+    "@matrixai/id": "^2.1.0",
     "@matrixai/logger": "^2.0.1",
+    "@matrixai/workers": "^1.2.3",
     "ajv": "^7.0.4",
     "async-mutex": "^0.2.4",
     "bip39": "^3.0.3",
@@ -79,7 +83,7 @@
     "commander": "^7.1.0",
     "cross-fetch": "^3.0.6",
     "cross-spawn": "^7.0.3",
-    "encryptedfs": "^2.1.3",
+    "encryptedfs": "^3.2.0",
     "fast-fuzzy": "^1.10.8",
     "fd-lock": "^1.2.0",
     "google-protobuf": "^3.14.0",
@@ -88,7 +92,6 @@
     "jose": "^3.12.3",
     "level": "^7.0.0",
     "lexicographic-integer": "^1.1.0",
-    "monotonic-lexicographic-timestamp": "^1.0.0",
     "node-forge": "^0.10.0",
     "pako": "^1.0.11",
     "prompts": "^2.4.1",
@@ -99,8 +102,8 @@
     "threads": "^1.6.5",
     "ts-custom-error": "^3.2.0",
     "utp-native": "^2.5.3",
-    "uuid": "^8.3.0",
-    "virtualfs": "^2.2.0"
+    "multiformats": "^9.4.8",
+    "uuid": "^8.3.0"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.13.10",

src/GenericIdTypes.ts

@@ -0,0 +1,119 @@
+import { utils as idUtils } from '@matrixai/id';
+import { ErrorInvalidId } from './errors';
+import { Id as InternalId } from '@matrixai/id/dist/Id';
+import type { Codec } from 'multiformats/bases/base';
+import { bases } from 'multiformats/basics';
+
+type MultibaseFormats = keyof typeof bases;
+/// This is the internal form of the Id.
+export type Id = InternalId;
+/// This is the user readable string form of the Id.
+export type IdString = string;
+// This is the number of bytes a valid Id has
+const idValidByteLength = 16;
+
+// Type guards for generic RandomId types.
+function isId<T extends Id>(arg: any): arg is T {
+  if (!(arg instanceof Uint8Array)) return false;
+  return arg.length === idValidByteLength;
+}
+
+/**
+ * This will return arg as a valid VaultId or throw an error if it can't be converted.
+ * This will take a multibase string of the ID or the raw Buffer of the ID.
+ * @param arg - The variable we wish to convert
+ * @throws vaultErrors.ErrorInvalidVaultId  if the arg can't be converted into a VaultId
+ * @returns VaultIdRaw
+ */
+function makeId<T extends Id>(arg: any): T {
+  let id = arg;
+  // Checking and converting a string
+  if (typeof arg === 'string') {
+    // Covert the string to the Buffer form.
+    try {
+      id = idUtils.fromMultibase(arg);
+      if (id == null) throw new ErrorInvalidId();
+    } catch (err) {
+      throw new ErrorInvalidId();
+    }
+  }
+
+  // If its a buffer we convert it to a Id.
+  if (arg instanceof Buffer) id = idUtils.fromBuffer(id);
+
+  // Checking if valid buffer.
+  if (isId<T>(id)) return id;
+  throw new ErrorInvalidId();
+}
+
+function isIdString<T extends IdString>(
+  arg: any,
+  validByteLength: number = idValidByteLength,
+): arg is T {
+  if (typeof arg !== 'string') return false;
+  const id = fromMultibase(arg);
+  if (id == null) return false;
+  return id.length === validByteLength;
+}
+
+function makeIdString<T extends IdString>(
+  arg: any,
+  validByteLength: number = idValidByteLength,
+  format: MultibaseFormats = 'base58btc',
+): T {
+  const id = arg;
+  if (id instanceof Uint8Array) {
+    if (id.length !== validByteLength) throw new ErrorInvalidId();
+    return toMultibase(arg, format) as T;
+  }
+  if (isIdString<T>(id, validByteLength)) return id;
+  throw new ErrorInvalidId();
+}
+
+function idToString(id: Id): IdString {
+  return id.toString();
+}
+
+function stringToId(idString: IdString): Id {
+  return idUtils.fromString(idString)!;
+}
+
+// Multibase helper functions.
+const basesByPrefix: Record<string, Codec<string, string>> = {};
+for (const k in bases) {
+  const codec = bases[k];
+  basesByPrefix[codec.prefix] = codec;
+}
+
+/**
+ * Encodes an multibase ID string
+ */
+function toMultibase(id: Uint8Array, format: MultibaseFormats): string {
+  const codec = bases[format];
+  return codec.encode(id);
+}
+
+/**
+ * Decodes a multibase encoded ID
+ * Do not use this for generic multibase strings
+ */
+function fromMultibase(idString: string): Uint8Array | undefined {
+  const prefix = idString[0];
+  const codec = basesByPrefix[prefix];
+  if (codec == null) {
+    return;
+  }
+  const buffer = codec.decode(idString);
+  return new Uint8Array(buffer);
+}
+
+export {
+  isId,
+  makeId,
+  isIdString,
+  makeIdString,
+  idToString,
+  stringToId,
+  toMultibase,
+  fromMultibase,
+};