@serfab/cadre-core 0.7.1 → 0.9.0

package/README.md

@@ -91,12 +91,14 @@ await node.stop();
 
 ## Node Profiles
 
-| Profile | Storage Role | Use Case | Ring Participation |
-|---------|--------------|----------|-------------------|
-| **transaction** | Ring Zulu only | Mobile devices, intermittent connectivity | Transaction verification, caching |
-| **storage** | Ring Zulu + Storage Rings | Servers, NAS, always-on nodes | Full archival storage |
+| Profile | Storage Role | Use Case | Ring Zulu |
+|---------|--------------|----------|-----------|
+| **transaction** | Arachnode disabled; transaction verification via FRET only | Mobile devices, intermittent connectivity | No |
+| **storage** | Ring Zulu + storage rings (storage rings not yet implemented — stub) | Servers, NAS, always-on nodes | Yes |
 
-Both profiles participate in transaction consensus. The distinction is long-term storage commitment.
+Transaction-profile nodes verify transactions via FRET only, with Arachnode disabled. Storage-profile nodes additionally join Ring Zulu and (when implemented) the concentric storage rings.
+
+> **Note:** The storage-ring subsystem is currently a no-op stub (`arachnode-stub.ts`). See [Node Profiles in `docs/architecture.md`](../../docs/architecture.md#node-profiles) for the full design.
 
 ## Strand Filtering
 
@@ -104,7 +106,7 @@ Mobile apps typically shouldn't participate in all strands. Use filters to contr
 
 ```typescript
 // Only participate in strands for a specific app
-strandFilter: { mode: 'appId', appId: 'com.example.chat' }
+strandFilter: { mode: 'sAppId', sAppId: 'com.example.chat' }
 
 // Only participate in one specific strand
 strandFilter: { mode: 'strandId', strandId: 'strand-abc123' }
@@ -124,9 +126,9 @@ Adding a new device to your cadre uses the Seed Bootstrap API:
 // On the new device: generate identity
 const enrollment = new EnrollmentService();
 const { peerId, privateKey } = await enrollment.createCadrePeer();
-// Store privateKey securely, send peerId + multiaddrs to authority
+// Store privateKey securely, send peerId + multiaddrs to owner
 
-// On authority device: authorize the new peer and create seed
+// On owner device: authorize the new peer and create seed
 await node.authorizePeer(newDevicePeerId, newDeviceMultiaddrs);
 const seed = await node.createSeed();
 
@@ -151,7 +153,7 @@ const { seed, encodedSeed } = await node.addDrone({
 });
 
 // Send to provider for drone initialization
-await provider.applySeed(droneInfo.containerId, encodedSeed);
+await provider.initializeNode(droneInfo.containerId, encodedSeed);
 ```
 
 ## API Reference
@@ -240,7 +242,6 @@ Available storage implementations:
 
 ## Related Packages
 
-- **[@serfab/strand-proto](../strand-proto/)** - Strand initialization protocol
 - **[@optimystic/db-core](https://github.com/gotchoices/optimystic)** - Distributed database core
 - **[@optimystic/db-p2p](https://github.com/gotchoices/optimystic)** - libp2p integration for Optimystic
 - **[@optimystic/db-p2p-storage-fs](https://github.com/gotchoices/optimystic)** - File system storage (Node.js)