Skip to content
This repository was archived by the owner on Jul 21, 2025. It is now read-only.

Commit 21ebf8d

Browse files
authored
feat: add nip-17 encryption support (#30)
1 parent c3375c1 commit 21ebf8d

56 files changed

Lines changed: 2294 additions & 739 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.changeset/grumpy-rats-spend.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ jobs:
2323
run: bun test
2424

2525
- name: Check formatting
26-
run: bun run format --check
26+
run: bun run fmt --check

README.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,43 @@ Shared utilities and components used across DVMCP packages.
1111
## Installation & Usage
1212
**Prerequisite:** Ensure you have [Bun](https://bun.sh/) installed.
1313

14-
### Quick Start with NPX (No Installation)
15-
You can run the packages directly using `npx` without installing them:
14+
### Quick Start with Bunx (No Installation)
15+
You can run the packages directly using `bunx` without installing them:
1616
```bash
1717
# Run the bridge
18-
npx @dvmcp/bridge
18+
bunx dvmcp-bridge
1919
# Run the discovery service
20-
npx @dvmcp/discovery
20+
bunx dvmcp-discovery
2121
```
2222
The interactive CLI will guide you through configuration setup on first run.
23+
2324
### Global Installation
2425
```bash
2526
# Install the packages globally
26-
npm install -g @dvmcp/bridge @dvmcp/discovery
27+
bun install -g @dvmcp/bridge @dvmcp/discovery
2728
# Run the commands
2829
dvmcp-bridge
2930
dvmcp-discovery
3031
```
32+
3133
## Setting Up a Bridge
3234
To expose your MCP server as a DVM on Nostr:
3335
1. Navigate to the directory where you want to configure the bridge
34-
2. Run: `npx @dvmcp/bridge`
36+
2. Run: `bunx dvmcp-bridge`
3537
3. Follow the interactive setup to configure:
36-
- Your MCP server path
37-
- Nostr private key (or generate a new one)
38-
- Relays to connect to
38+
- Your MCP server path
39+
- Nostr private key (or generate a new one)
40+
- Relays to connect to
3941
4. The bridge will start and begin proxying requests between Nostr and your MCP server
42+
4043
## Setting Up a Discovery Service
4144
To aggregate MCP tools from DVMs:
4245
1. Navigate to your desired directory
43-
2. Run: `npx @dvmcp/discovery`
46+
2. Run: `bunx dvmcp-discovery`
4447
3. Follow the setup to configure:
45-
- Nostr private key
46-
- Relays to monitor
48+
- Nostr private key
49+
- Relays to monitor
50+
4751
## Development
4852
For contributors to this repository:
4953
```bash
@@ -56,16 +60,4 @@ bun install
5660
bun run dev --cwd packages/dvmcp-bridge
5761
# Start the discovery service in development mode
5862
bun run dev --cwd packages/dvmcp-discovery
59-
```
60-
## Documentation
61-
- [DVMCP Specification](./docs/dvmcp-spec.md)
62-
- [Bridge Package](./packages/dvmcp-bridge/README.md)
63-
- [Discovery Package](./packages/dvmcp-discovery/README.md)
64-
- [Commons Package](./packages/dvmcp-commons/README.md)
65-
## Contributing
66-
Contributions are welcome! Please feel free to submit pull requests or create issues.
67-
## License
68-
[MIT License](LICENSE)
69-
## Related Projects
70-
- [Model Context Protocol](https://modelcontextprotocol.io)
71-
- [Nostr Protocol](https://github.com/nostr-protocol/nips)
63+
```

ROADMAP.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
- [x] Add flag `--config-path` to cli
22
- [x] Add one command, configless, quick run mode in discovery package
3-
- [ ] Review for 2025-03-26
4-
- [ ] Add payments (#10)
5-
- [ ] Add env variables(#7)
6-
- [ ] Add resources to bridge package
7-
- [ ] Add sessions
8-
- [ ] Add encryption
9-
- [ ] Discovery cli to bootstrap configuration
3+
- [x] Review for 2025-03-26
4+
- [x] Add payments (#10)
5+
- [x] Add env variables(#7)
6+
- [x] Add resources to bridge package
7+
- [x] Add encryption
8+
- [x] Discovery cli to bootstrap configuration
9+
- [ ] Unannounced/Private servers
10+
- [ ] Improve docs

bun.lock

Lines changed: 5 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)