cojson 0.0.1 → 0.0.2

package/.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+    ],
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    parserOptions: {
+        project: './tsconfig.json',
+    },
+    root: true,
+    rules: {
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }],
+        "@typescript-eslint/no-floating-promises": "error",
+    },
+
+  };

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright 2023, Garden Computing, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# CoJSON
+
+CoJSON ("Collaborative JSON") will be a minimal protocol and implementation for collaborative values (CRDTs + public-key cryptography).
+
+CoJSON is developed by [Garden Computing](https://gcmp.io) as the underpinnings of [Jazz](https://jazz.tools), a framework for building apps with telepathic data.
+
+The protocol and implementation will cover:
+
+- how to represent collaborative values internally
+- the APIs collaborative values expose
+- how to sync and query for collaborative values between peers
+- how to enforce access rights within collaborative values locally and at sync boundaries
+
+THIS IS WORK IN PROGRESS
+
+## Core Value Types
+
+### `Immutable` Values (JSON)
+- null
+- boolean
+- number
+- string
+  - stringly-encoded CoJSON identifiers & data (`CoValueID`, `AgentID`, `SessionID`, `SignatoryID`, `SignatorySecret`, `Signature`, `RecipientID`, `RecipientSecret`, `Sealed`, `Hash`, `ShortHash`, `KeySecret`, `KeyID`, `Encrypted`, `Role`)
+
+- array
+- object
+
+### `Collaborative` Values
+- CoMap (`string` → `Immutable`, last-writer-wins per key)
+  - Team (`AgentID` → `Role`)
+- CoList (`Immutable[]`, addressable positions, insertAfter semantics)
+  - Agent (`{signatoryID, recipientID}[]`)
+- CoStream (independent per-session streams of `Immutable`s)
+- Static (single addressable `Immutable`)
+
+## Implementation Abstractions
+- CoValue
+  - Session Logs
+  - Transactions
+    - Private (encrypted) transactions
+    - Trusting (unencrypted) transactions
+  - Rulesets
+- CoValue Content Types
+- LocalNode
+  - Peers
+  - AgentCredentials
+- Peer
+
+## Extensions & higher-level protocols
+
+### More complex datastructures
+- CoText: a clean way to collaboratively mark up rich text with CoJSON
+- CoJSON Tree: a clean way to represent collaborative tree structures with CoJSON

package/package.json

@@ -1,8 +1,31 @@
 {
-  "name": "cojson",
-  "version": "0.0.1",
-  "description": "Collaborative JSON",
-  "main": "index.js",
-  "author": "Garden Computing, Inc.",
-  "license": "MIT"
+    "name": "cojson",
+    "module": "src/index.ts",
+    "type": "module",
+    "license": "MIT",
+    "version": "0.0.2",
+    "devDependencies": {
+        "@types/jest": "^29.5.3",
+        "@typescript-eslint/eslint-plugin": "^6.2.1",
+        "@typescript-eslint/parser": "^6.2.1",
+        "eslint": "^8.46.0",
+        "jest": "^29.6.2",
+        "ts-jest": "^29.1.1",
+        "typescript": "5.0.2"
+    },
+    "dependencies": {
+        "@noble/ciphers": "^0.1.3",
+        "@noble/curves": "^1.1.0",
+        "@noble/hashes": "^1.3.1",
+        "@scure/base": "^1.1.1",
+        "fast-json-stable-stringify": "^2.1.0",
+        "isomorphic-streams": "https://github.com/sgwilym/isomorphic-streams.git#aa9394781bfc92f8d7c981be7daf8af4b4cd4fae"
+    },
+    "scripts": {
+        "test": "jest"
+    },
+    "jest": {
+        "preset": "ts-jest",
+        "testEnvironment": "node"
+    }
 }

package/src/coValue.test.ts

@@ -0,0 +1,135 @@
+import {
+    CoValue,
+    Transaction,
+    getAgent,
+    getAgentID,
+    newRandomAgentCredential,
+    newRandomSessionID,
+} from "./coValue";
+import { LocalNode } from "./node";
+import { sign } from "./crypto";
+
+test("Can create coValue with new agent credentials and add transaction to it", () => {
+    const agentCredential = newRandomAgentCredential("agent1");
+    const node = new LocalNode(
+        agentCredential,
+        newRandomSessionID(getAgentID(getAgent(agentCredential)))
+    );
+
+    const coValue = node.createCoValue({
+        type: "costream",
+        ruleset: { type: "unsafeAllowAll" },
+        meta: null,
+    });
+
+    const transaction: Transaction = {
+        privacy: "trusting",
+        madeAt: Date.now(),
+        changes: [
+            {
+                hello: "world",
+            },
+        ],
+    };
+
+    const { expectedNewHash } = coValue.expectedNewHashAfter(
+        node.ownSessionID,
+        [transaction]
+    );
+
+    expect(
+        coValue.tryAddTransactions(
+            node.ownSessionID,
+            [transaction],
+            expectedNewHash,
+            sign(agentCredential.signatorySecret, expectedNewHash)
+        )
+    ).toBe(true);
+});
+
+test("transactions with wrong signature are rejected", () => {
+    const wrongAgent = newRandomAgentCredential("wrongAgent");
+    const agentCredential = newRandomAgentCredential("agent1");
+    const node = new LocalNode(
+        agentCredential,
+        newRandomSessionID(getAgentID(getAgent(agentCredential)))
+    );
+
+    const coValue = node.createCoValue({
+        type: "costream",
+        ruleset: { type: "unsafeAllowAll" },
+        meta: null,
+    });
+
+    const transaction: Transaction = {
+        privacy: "trusting",
+        madeAt: Date.now(),
+        changes: [
+            {
+                hello: "world",
+            },
+        ],
+    };
+
+    const { expectedNewHash } = coValue.expectedNewHashAfter(
+        node.ownSessionID,
+        [transaction]
+    );
+
+    expect(
+        coValue.tryAddTransactions(
+            node.ownSessionID,
+            [transaction],
+            expectedNewHash,
+            sign(wrongAgent.signatorySecret, expectedNewHash)
+        )
+    ).toBe(false);
+});
+
+test("transactions with correctly signed, but wrong hash are rejected", () => {
+    const agentCredential = newRandomAgentCredential("agent1");
+    const node = new LocalNode(
+        agentCredential,
+        newRandomSessionID(getAgentID(getAgent(agentCredential)))
+    );
+
+    const coValue = node.createCoValue({
+        type: "costream",
+        ruleset: { type: "unsafeAllowAll" },
+        meta: null,
+    });
+
+    const transaction: Transaction = {
+        privacy: "trusting",
+        madeAt: Date.now(),
+        changes: [
+            {
+                hello: "world",
+            },
+        ],
+    };
+
+    const { expectedNewHash } = coValue.expectedNewHashAfter(
+        node.ownSessionID,
+        [
+            {
+                privacy: "trusting",
+                madeAt: Date.now(),
+                changes: [
+                    {
+                        hello: "wrong",
+                    },
+                ],
+            },
+        ]
+    );
+
+    expect(
+        coValue.tryAddTransactions(
+            node.ownSessionID,
+            [transaction],
+            expectedNewHash,
+            sign(agentCredential.signatorySecret, expectedNewHash)
+        )
+    ).toBe(false);
+});