@openvole/volenet 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenVole
+
+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,75 @@
+# @openvole/volenet
+
+Signed, post-quantum-sealed messaging between agents and people across machines they do not share.
+A library, not a framework: it runs a node, it does not run an agent.
+
+```bash
+npm install @openvole/volenet
+```
+
+```ts
+import { VoleNetManager, createEventBus, generateKeyPair } from '@openvole/volenet'
+
+const bus = createEventBus()
+bus.on('volenet:chat', (m) => console.log(`${m.fromName}: ${m.text}`))
+
+const net = new VoleNetManager(
+  { enabled: true, instanceName: 'my-node', port: 9700, keyPath: './data/net/vole_key' },
+  './data',
+)
+await net.start(undefined, bus)
+await net.sendChat('some-peer', 'hello')
+```
+
+## What it gives you
+
+- **Identity that is a keypair, not an account.** Hybrid Ed25519 + ML-DSA-65 signatures, so a
+  message is provably from a peer and nobody can speak as them.
+- **Envelopes sealed to the recipient.** Hybrid X25519 + ML-KEM-768, HKDF over both shared
+  secrets, AAD bound to the routing — confidentiality holds unless *both* KEMs break, which is
+  what closes the harvest-now-decrypt-later gap. Falls back to X25519-only for older peers, with
+  the scheme bound into the KDF so a downgrade fails the tag instead of weakening the envelope.
+- **Blind relay hubs.** A hub forwards ciphertext for peers that cannot dial each other and keeps
+  none of it. An undelivered message waits in the *sender's* outbox; the hub keeps a notice — who
+  tried, how often, when — and nothing more.
+- **Consent.** Nothing is trusted because it connected. A peer is paired directly, or consented to
+  through a hub, before it can say anything to you.
+- **Intermittent peers as a supported shape.** Senders hold what they could not deliver and flush
+  on reconnect, so a phone or an editor session that comes and goes loses nothing.
+
+## What it does not assume about you
+
+Three things a host may provide, and none of them are required:
+
+| you pass | you get | without it |
+|---|---|---|
+| an `EventSink` to `start()` | every event this node raises | it runs silently; `createEventBus()` is there if you have no bus |
+| a `ToolProvider` to `start()` | tools shareable with trusted peers | no tool sharing |
+| `persistPeer` in the config | peers learned at runtime survive a restart | they are live-only |
+
+`setLoggerFactory()` redirects the library's logging into your own logger. Left alone it writes to
+`VOLE_LOG_FILE` when that is set, and is silent otherwise.
+
+## Who uses it
+
+- [`openvole`](https://www.npmjs.com/package/openvole) — the agent framework this was extracted
+  from. Agents on a mesh, tool sharing, brain delegation.
+- [`@openvole/volenet-mcp`](https://www.npmjs.com/package/@openvole/volenet-mcp) — an MCP server
+  that gives a Claude Code session its own identity on the mesh.
+- The VoleNet phone app, whose Rust client speaks this protocol and is tested against this
+  implementation in both directions.
+
+## Protocol
+
+The wire format is documented from a client's point of view in
+[`PROTOCOL.md`](https://github.com/openvole/vole-chat/blob/main/PROTOCOL.md). Section numbers there
+are referenced from the Rust client's source.
+
+## Test
+
+```bash
+pnpm -C src/volenet test
+```
+
+204 tests, including end-to-end pairing, relay with consent, held messages, file transfer, and
+byte-level interop with the Rust client.