Documentation

npm install dignity.js

npm install dignity.js react react-dom

const {
  DignityP2P,
  InMemoryNetworkHub,
  InMemoryNetworkAdapter
} = require('dignity.js');

const hub = new InMemoryNetworkHub();

const alice = new DignityP2P({
  nodeId: 'alice',
  networkAdapter: new InMemoryNetworkAdapter(hub),
  security: {
    appPassword: 'shared-out-of-band-password',
    powSteps: 22
  }
});

const bob = new DignityP2P({
  nodeId: 'bob',
  networkAdapter: new InMemoryNetworkAdapter(hub),
  security: {
    appPassword: 'shared-out-of-band-password',
    powSteps: 22
  }
});

await alice.start();
await bob.start();

await alice.joinDiscovery('main', { metadata: { nickname: 'alice' } });
await bob.joinDiscovery('main', { metadata: { nickname: 'bob' } });

await alice.create('notes', { title: 'hello decentralized world' }, {
  id: 'note-1',
  broadcastScope: 'main'
});

console.log(bob.read('notes', 'note-1'));

await alice.leaveDiscovery('main');
await bob.leaveDiscovery('main');
await alice.stop();
await bob.stop();

<script src="https://unpkg.com/dignity.js/dist/dignity.min.js"></script>
<script>
  const { DignityP2P } = DignityJS;
</script>

await node.create('matches', { mode: 'coop' }, {
  id: 'm-1',
  broadcastScope: 'coop:red'
});

await node.joinDiscovery('team:red', {
  metadata: { nickname: 'alice' },
  heartbeatIntervalMs: 15000,
  ttlMs: 45000
});

const peers = node.listPeers('team:red', { includeSelf: false });

await node.leaveDiscovery('team:red');

alice.registerPeerPublicKey('bob', bob.getPublicKey());
bob.registerPeerPublicKey('alice', alice.getPublicKey());

await alice.sendDirectMessage('bob', 'dm', { text: 'private payload' });

node.on('conflict', (event) => {
  // event.phase: 'local' | 'remote'
  console.log(event.expectedVersion, event.currentVersion);
});

// Fail fast on stale local writes
await node.update('games', 'g1', { score: 10 }, { expectedVersion: 3 });

// Automatic retry for read-modify-write loops
await node.updateWithRetry('games', 'g1', (current) => ({
  score: current.data.score + 1
}));

const node = new DignityP2P({
  nodeId: 'alice',
  networkAdapter,
  security: {
    appPassword: 'shared-out-of-band-password',
    broadcastPasswords: {
      'coop:red': 'red-team-secret',
      'coop:blue': 'blue-team-secret'
    },
    powSteps: 22,
    kdfIterations: 100000,
    banDurationMs: 48 * 60 * 60 * 1000
  }
});

const { DignityP2P, IndexedDBPersistence } = require('dignity.js');

const node = new DignityP2P({ nodeId, networkAdapter, security });
const persistence = new IndexedDBPersistence({
  dbName: 'my-app',
  collections: ['games', 'matches']  // omit to persist all collections
});

await node.start();
await persistence.attach(node);

// Later
await persistence.detach();

import { useDignity, useCollection, usePeers } from 'dignity.js/react';

function Room() {
  const { node, status, error } = useDignity(config);
  const games = useCollection(node, 'games');
  const peers = usePeers(node, 'room:chess', { includeSelf: false });

  if (status === 'starting') return <p>Connecting…</p>;
  if (error) return <p>Error: {error.message}</p>;

  return (
    <pre>{JSON.stringify({ status, games, peers }, null, 2)}</pre>
  );
}

const {
  createDefaultSignalingPool,
  WebSocketSignalingProvider
} = require('dignity.js');

const pool = createDefaultSignalingPool({
  cloudflareUrls: ['wss://your-endpoint.example/peerjs?key=peerjs'],
  fallbackUrls: ['wss://relay-a.example', 'wss://relay-b.example'],
  customProviders: [
    new WebSocketSignalingProvider({
      id: 'local-dev',
      url: 'ws://localhost:3001',
      priority: 99
    })
  ]
});

new DignityP2P({
  nodeId,           // required — unique peer identifier
  networkAdapter,   // required — transport implementation
  security,         // optional — MessageSecurityService options
  now,              // optional — clock injection (tests)
  idGenerator       // optional — custom operation id factory
})

# Run tests (177+ passing, ~99.5% line coverage)
npm test

# Build browser + Node bundles
npm run build

# Serve docs locally
npm run docs:serve

# Run examples
npm run example:tictactoe
npm run example:chess