dignity.js 0.5.2 → 0.5.4

package/docs/openapi-like.json

@@ -15,7 +15,8 @@
         }
       },
       "read": {
-        "method": "read(collection, id)"
+        "method": "read(collection, id)",
+        "returns": "active record or null; see recordShape"
       },
       "update": {
         "method": "update(collection, id, patch, options)",
@@ -33,7 +34,8 @@
       },
       "pushRecordSnapshot": {
         "method": "pushRecordSnapshot(collection, id, options)",
-        "description": "broadcast full record for late joiners who missed the initial create"
+        "description": "broadcast full record for late joiners who missed the initial create",
+        "returns": "active record; see recordShape"
       },
       "getRecordPeerIds": {
         "method": "getRecordPeerIds(collection, id, options)",
@@ -46,7 +48,8 @@
     },
     "collections/{collection}": {
       "list": {
-        "method": "list(collection, options)"
+        "method": "list(collection, options)",
+        "returns": "active records with hash; deleted stubs omit hash when includeDeleted is true"
       }
     },
     "peers": {
@@ -60,11 +63,35 @@
   "events": {
     "change": "object create/update/delete/snapshot applied",
     "conflict": "local or remote version mismatch",
-    "warning": "orphan-operation, peer-connect-failed, presence failures",
+    "warning": "orphan-operation, peer-connect-failed, presence failures, content-hash-mismatch",
     "peerdiscovered": "peer joined discovery scope",
     "peerleft": "peer left or timed out",
     "message": "custom decrypted message received"
   },
+  "recordShape": {
+    "active": {
+      "id": "string",
+      "ownerId": "string",
+      "collaboratorIds": [
+        "peer-id"
+      ],
+      "data": "application payload object",
+      "hash": "sha512:<hex>; computed from canonicalized data only",
+      "createdAt": "unix ms timestamp",
+      "updatedAt": "unix ms timestamp",
+      "version": "monotonic integer"
+    },
+    "deletedStub": {
+      "id": "string",
+      "ownerId": "string",
+      "deletedAt": "unix ms timestamp",
+      "version": "monotonic integer"
+    },
+    "notes": [
+      "hash uses stableStringify(data) so object key order does not change the digest",
+      "restoreRecord recomputes hash locally and emits warning.type=content-hash-mismatch on mismatch"
+    ]
+  },
   "persistence": {
     "IndexedDBPersistence": {
       "method": "attach(node)",

package/examples/decentralized-chess-lite.js

@@ -1,3 +1,12 @@
+/**
+ * Node.js chess example.
+ *
+ * Run this example with:
+ *   npm run example:chess
+ *
+ * For the browser-based demo, see:
+ *   docs/chess/
+ */
 const { DignityP2P, InMemoryNetworkHub, InMemoryNetworkAdapter } = require('../src');
 
 function initialBoard() {

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "dignity.js",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "P2P object API for decentralized JavaScript applications",
+  "homepage": "https://jose-compu.github.io/dignity.js/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jose-compu/dignity.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jose-compu/dignity.js/issues"
+  },
   "main": "dist/dignity.cjs.js",
   "module": "dist/dignity.esm.js",
   "browser": "dist/dignity.esm.js",
@@ -20,9 +28,14 @@
     }
   },
   "files": [
+    "README.md",
+    "LICENSE",
     "dist",
     "src",
-    "docs",
+    "docs/index.html",
+    "docs/openapi-like.json",
+    "docs/favicon.ico",
+    "docs/assets",
     "examples"
   ],
   "scripts": {

package/src/core/dignity-p2p.js

@@ -1,5 +1,15 @@
+const nacl = require('tweetnacl');
+const naclUtil = require('tweetnacl-util');
 const EventEmitter = require('../utils/event-emitter');
-const { MessageSecurityService } = require('../security/message-security-service');
+const { MessageSecurityService, stableStringify } = require('../security/message-security-service');
+
+function computeContentHash(data) {
+  const canonical = stableStringify(data || {});
+  const bytes = naclUtil.decodeUTF8(canonical);
+  const hash = nacl.hash(bytes);
+  const hex = Array.from(hash, (b) => b.toString(16).padStart(2, '0')).join('');
+  return `sha512:${hex}`;
+}
 
 /**
  * Core node API for replicated object collections.
@@ -101,6 +111,8 @@ class DignityP2P extends EventEmitter {
       return null;
     }
 
+    const normalizedData = { ...(record.data || {}) };
+
     return {
       id: record.id,
       ownerId: record.ownerId,
@@ -108,7 +120,8 @@ class DignityP2P extends EventEmitter {
       createdAt: record.createdAt,
       updatedAt: record.updatedAt,
       version: record.version,
-      data: { ...record.data }
+      hash: record.hash || computeContentHash(normalizedData),
+      data: normalizedData
     };
   }
 
@@ -204,7 +217,7 @@ class DignityP2P extends EventEmitter {
       ownerId: this.nodeId,
       collaboratorIds,
       timestamp,
-      payload: { ...data }
+      payload: { ...(data || {}) }
     };
 
     this.applyOperation(operation);
@@ -855,11 +868,24 @@ class DignityP2P extends EventEmitter {
       return false;
     }
 
+    const restoredData = { ...(record.data || {}) };
+    const computedHash = computeContentHash(restoredData);
+    if (record.hash && record.hash !== computedHash) {
+      this.emit('warning', {
+        type: 'content-hash-mismatch',
+        collection: collectionName,
+        id: record.id,
+        advertisedHash: record.hash,
+        computedHash
+      });
+    }
+
     collection.set(record.id, {
       id: record.id,
       ownerId: record.ownerId,
       collaboratorIds: this.normalizeCollaboratorIds(record.collaboratorIds),
-      data: { ...(record.data || {}) },
+      data: restoredData,
+      hash: computedHash,
       createdAt: record.createdAt,
       updatedAt: record.updatedAt,
       deletedAt: record.deletedAt || null,
@@ -881,7 +907,8 @@ class DignityP2P extends EventEmitter {
       id: raw.id,
       ownerId: raw.ownerId,
       collaboratorIds: Array.isArray(raw.collaboratorIds) ? [...raw.collaboratorIds] : [],
-      data: { ...raw.data },
+      data: { ...(raw.data || {}) },
+      hash: raw.hash || computeContentHash(raw.data || {}),
       createdAt: raw.createdAt,
       updatedAt: raw.updatedAt,
       deletedAt: raw.deletedAt || null,
@@ -917,7 +944,8 @@ class DignityP2P extends EventEmitter {
         id: operation.id,
         ownerId: operation.ownerId,
         collaboratorIds: this.normalizeCollaboratorIds(operation.collaboratorIds),
-        data: { ...operation.payload },
+        data: { ...(operation.payload || {}) },
+        hash: computeContentHash(operation.payload || {}),
         createdAt: operation.timestamp,
         updatedAt: operation.timestamp,
         deletedAt: null,
@@ -1035,6 +1063,7 @@ class DignityP2P extends EventEmitter {
         ...current.data,
         ...operation.payload
       };
+      current.hash = computeContentHash(current.data);
 
       if (Array.isArray(operation.collaboratorIds) && operation.actorId === current.ownerId) {
         current.collaboratorIds = this.normalizeCollaboratorIds(operation.collaboratorIds);

package/src/persistence/indexeddb-persistence.js

@@ -73,6 +73,7 @@ class IndexedDBPersistence {
       ownerId: record.ownerId,
       collaboratorIds: Array.isArray(record.collaboratorIds) ? [...record.collaboratorIds] : [],
       data: { ...record.data },
+      hash: record.hash || null,
       createdAt: record.createdAt,
       updatedAt: record.updatedAt,
       deletedAt: record.deletedAt,
@@ -143,6 +144,7 @@ class IndexedDBPersistence {
         ownerId: stored.ownerId,
         collaboratorIds: stored.collaboratorIds,
         data: stored.data,
+        hash: stored.hash || null,
         createdAt: stored.createdAt,
         updatedAt: stored.updatedAt,
         deletedAt: stored.deletedAt,

package/src/security/sloth-vdf.js

@@ -6,6 +6,12 @@ class SlothPermutation {
   static p = BigInt(
     '170082004324204494273811327264862981553264701145937538369570764779791492622392118654022654452947093285873855529044371650895045691292912712699015605832276411308653107069798639938826015099738961427172366594187783204437869906954750443653318078358839409699824714551430573905637228307966826784684174483831608534979'
   );
+  // precompute values for optimization:
+  // (p - 1) / 2
+  static pHalf = (SlothPermutation.p - BigInt(1)) >> BigInt(1);
+  // (p + 1) / 4
+  // p ≡ 3 (mod 4) ⇒ (p+1) divisible by 4
+  static pQuarter = (SlothPermutation.p + BigInt(1)) >> BigInt(2);
 
   fastPow(base, exponent, modulus) {
     if (modulus === BigInt(1)) {
@@ -17,11 +23,11 @@ class SlothPermutation {
     let powExponent = exponent;
 
     while (powExponent > 0) {
-      if (powExponent % BigInt(2) === BigInt(1)) {
+      if ((powExponent & BigInt(1)) === BigInt(1)) {
         result = (result * powBase) % modulus;
       }
 
-      powExponent = powExponent / BigInt(2);
+      powExponent = powExponent >> BigInt(1);
       powBase = (powBase * powBase) % modulus;
     }
 
@@ -29,7 +35,7 @@ class SlothPermutation {
   }
 
   quadRes(x) {
-    return this.fastPow(x, (SlothPermutation.p - BigInt(1)) / BigInt(2), SlothPermutation.p) === BigInt(1);
+    return this.fastPow(x, SlothPermutation.pHalf, SlothPermutation.p) === BigInt(1);
   }
 
   modSqrtOp(x) {
@@ -37,10 +43,10 @@ class SlothPermutation {
     let value = x;
 
     if (this.quadRes(value)) {
-      y = this.fastPow(value, (SlothPermutation.p + BigInt(1)) / BigInt(4), SlothPermutation.p);
+      y = this.fastPow(value, SlothPermutation.pQuarter, SlothPermutation.p);
     } else {
       value = (-value + SlothPermutation.p) % SlothPermutation.p;
-      y = this.fastPow(value, (SlothPermutation.p + BigInt(1)) / BigInt(4), SlothPermutation.p);
+      y = this.fastPow(value, SlothPermutation.pQuarter, SlothPermutation.p);
     }
 
     return y;

package/src/signaling/websocket-signaling-provider.js

@@ -1,3 +1,12 @@
+function randomBase36(length) {
+  let value = '';
+  while (value.length < length) {
+    const chunk = Math.random().toString(36).slice(2);
+    value += chunk.length > 0 ? chunk : '0';
+  }
+  return value.slice(0, length);
+}
+
 class WebSocketSignalingProvider {
   constructor({ id, url, WebSocketImpl, priority = 0 }) {
     if (!url) {
@@ -50,8 +59,8 @@ class WebSocketSignalingProvider {
       return this.url;
     }
 
-    const connectionId = `dignityjs_${Math.random().toString(36).slice(2, 12)}`;
-    const token = Math.random().toString(36).slice(2, 12);
+    const connectionId = `dignityjs_${randomBase36(10)}`;
+    const token = randomBase36(10);
     const hasQuery = this.url.includes('?');
     const hasId = /[?&]id=/.test(this.url);
     const hasToken = /[?&]token=/.test(this.url);