yakmesh 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +120 -0
- package/assets/yakmesh-logo.svg +80 -0
- package/database/replication.js +318 -0
- package/package.json +2 -2
- package/security/mesh-auth.js +0 -123
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
<
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
Thank you for your interest in contributing to **YAKMESH** — the **Yielding Atomic Kernel Modular Encryption Secured Hub**.
|
|
9
|
+
|
|
10
|
+
We are building a "Sturdy & Secure" foundation for the post-quantum era.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 📋 Before You Contribute
|
|
15
|
+
|
|
16
|
+
1. **Read the documentation** at [yakmesh.dev](https://yakmesh.dev)
|
|
17
|
+
2. **Check existing issues** to avoid duplicates
|
|
18
|
+
3. **Follow our code of conduct** — be respectful and constructive
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 🔐 Engineering Standards
|
|
23
|
+
|
|
24
|
+
### Cryptographic Requirements
|
|
25
|
+
|
|
26
|
+
All contributions involving cryptographic primitives **MUST**:
|
|
27
|
+
|
|
28
|
+
- ✅ Use **NIST-standardized Post-Quantum Cryptography** (ML-DSA-65 / FIPS 204)
|
|
29
|
+
- ✅ Use libraries from the `@noble` family (`@noble/hashes`, `@noble/post-quantum`)
|
|
30
|
+
- ❌ **NO legacy ECDSA/RSA** in security-critical paths
|
|
31
|
+
- ❌ **NO `Math.random()`** for security-sensitive operations (use `randomBytes()`)
|
|
32
|
+
|
|
33
|
+
### Timing & Synchronization
|
|
34
|
+
|
|
35
|
+
Changes to the timing/oracle layer must:
|
|
36
|
+
|
|
37
|
+
- Support precision hardware timestamps (PCIe atomic clocks, PTP, GPS)
|
|
38
|
+
- Maintain backward compatibility with NTP-only deployments
|
|
39
|
+
- Include tests for phase epoch calculations
|
|
40
|
+
|
|
41
|
+
### Code Quality
|
|
42
|
+
|
|
43
|
+
- All PRs must pass existing tests (`npm test`)
|
|
44
|
+
- Include tests for new functionality
|
|
45
|
+
- Follow existing code style (ES modules, async/await)
|
|
46
|
+
- Document public APIs with JSDoc comments
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 🏷️ Branding & Trademark
|
|
51
|
+
|
|
52
|
+
**YAKMESH** is a trademark of the YAKMESH Project (PeerQuanta).
|
|
53
|
+
|
|
54
|
+
### If You Fork This Project
|
|
55
|
+
|
|
56
|
+
| ❌ You MUST | ✅ You MAY |
|
|
57
|
+
|-------------|------------|
|
|
58
|
+
| Remove the official YAKMESH logo | State "Based on YAKMESH technology" |
|
|
59
|
+
| Remove YAKMESH branding | State "Powered by YAKMESH" |
|
|
60
|
+
| Rename your software | Use the "Powered by" badge below |
|
|
61
|
+
|
|
62
|
+
### "Powered by YAKMESH" Badge
|
|
63
|
+
|
|
64
|
+
```markdown
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Full policy: [yakmesh.dev/docs/trademark-policy.html](https://yakmesh.dev/docs/trademark-policy.html)
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 🚨 Security Vulnerabilities
|
|
73
|
+
|
|
74
|
+
**Please do NOT open public issues for security flaws.**
|
|
75
|
+
|
|
76
|
+
Instead, email **security@peerquanta.com** directly so we can coordinate a responsible disclosure and hardened patch.
|
|
77
|
+
|
|
78
|
+
We follow a 90-day disclosure policy and will credit researchers in our security acknowledgments.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 📝 Pull Request Process
|
|
83
|
+
|
|
84
|
+
1. **Fork** the repository
|
|
85
|
+
2. **Create a branch** (`git checkout -b feature/my-feature`)
|
|
86
|
+
3. **Make your changes** following the standards above
|
|
87
|
+
4. **Test** your changes (`npm test`)
|
|
88
|
+
5. **Commit** with clear messages
|
|
89
|
+
6. **Push** and open a Pull Request
|
|
90
|
+
|
|
91
|
+
### PR Title Format
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
[category] Brief description
|
|
95
|
+
|
|
96
|
+
Examples:
|
|
97
|
+
[oracle] Add GPS time source detection
|
|
98
|
+
[mesh] Fix WebSocket reconnection logic
|
|
99
|
+
[docs] Update API reference
|
|
100
|
+
[security] Patch hash exposure in /status endpoint
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 💬 Questions?
|
|
106
|
+
|
|
107
|
+
- **General:** Open a GitHub Discussion
|
|
108
|
+
- **Security:** security@peerquanta.com
|
|
109
|
+
- **Legal/Trademark:** legal@peerquanta.com
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
<div align="center">
|
|
114
|
+
<sub>Built with quantum principles. Secured by math.</sub>
|
|
115
|
+
<br><br>
|
|
116
|
+
<strong><a href="https://yakmesh.dev">yakmesh.dev</a></strong>
|
|
117
|
+
<br><br>
|
|
118
|
+
<sub>© 2026 YAKMESH Project. Sturdy & Secure.</sub>
|
|
119
|
+
</div>
|
|
120
|
+
]]>
|