Skip to content

Commit e421579

Browse files
committed
docs: enhance documentation and update communication channels
- Add NIPs support status table and implementation details - Add comprehensive NIP-49 implementation documentation - Move security reporting to GitHub Security Advisory - Update Code of Conduct reporting to use GitHub Issues - Add Code of Conduct violation issue template - Remove email-based communications
1 parent 611ba6f commit e421579

File tree

5 files changed

+84
-7
lines changed

5 files changed

+84
-7
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Code of Conduct Violation
3+
about: Report a violation of our Code of Conduct
4+
title: '[CODE OF CONDUCT] '
5+
labels: 'code of conduct'
6+
assignees: ''
7+
8+
---
9+
10+
**IMPORTANT**: This issue will be handled with strict confidentiality.
11+
12+
## Description
13+
14+
Please provide a clear description of what occurred, including:
15+
- What happened
16+
- When it happened (date/time)
17+
- Where it happened (GitHub issue, PR, Discussion, etc.)
18+
- Links to any relevant public content (if applicable)
19+
20+
## Additional Context
21+
22+
Any additional context that you feel is important to share.
23+
24+
## Contact Information
25+
26+
How would you prefer to be contacted about this report? (Optional)

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ an individual is officially representing the community in public spaces.
5151
## Enforcement
5252

5353
Instances of abusive, harassing, or otherwise unacceptable behavior may be
54-
reported to the community leaders responsible for enforcement at
55-
[conduct@humanjavaenterprises.org](mailto:conduct@humanjavaenterprises.org).
54+
reported by creating a confidential issue at [https://github.com/humanjavaenterprises/nostr-nsec-seedphrase/issues/new/choose](https://github.com/humanjavaenterprises/nostr-nsec-seedphrase/issues/new/choose) using the "Code of Conduct Violation" template.
5655
All complaints will be reviewed and investigated promptly and fairly.
5756

5857
## Enforcement Guidelines

README.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,58 @@ A comprehensive TypeScript library for managing Nostr keys with seed phrases, in
2424
- ✅ Comprehensive test coverage
2525
- 🔒 Secure key management practices
2626

27+
## NIPs Support Status
28+
29+
🟢 Fully implemented 🟡 Partially implemented 🔴 Not implemented
30+
31+
| NIP | Status | Description |
32+
|-----|--------|-------------|
33+
| 01 | 🟢 | Basic protocol flow & event signing |
34+
| 06 | 🟢 | Basic key derivation and event signing |
35+
| 13 | 🟢 | Proof of Work support |
36+
| 19 | 🟢 | bech32-encoded entities |
37+
| 49 | 🟢 | Private Key Generation from Seed Phrases |
38+
39+
### NIP-49 Implementation Details
40+
41+
This package fully implements NIP-49, which specifies the use of BIP-39-style mnemonic seed phrases for generating private keys in the Nostr protocol. Our implementation ensures full compatibility with the NIP-49 specification while providing robust tooling for developers.
42+
43+
#### Key Features & Compliance
44+
45+
1. **Mnemonic Generation & Handling**:
46+
- Full BIP-39 compliance for seed phrase generation
47+
- Support for multiple languages and word lists
48+
- Secure entropy generation for new seed phrases
49+
50+
2. **Standardized Key Derivation**:
51+
- Implements the standard derivation path (m/44'/1237'/0'/0/0)
52+
- Ensures compatibility with other NIP-49 compliant tools and wallets
53+
- Supports custom derivation paths for advanced use cases
54+
55+
3. **Key Format & Encoding**:
56+
- Outputs Nostr-compatible `nsec` and `npub` keys
57+
- Supports conversion between different key formats
58+
- Maintains compatibility with existing Nostr infrastructure
59+
60+
4. **Security & Best Practices**:
61+
- Implements secure key generation and storage practices
62+
- Provides validation utilities for seed phrases
63+
- Follows cryptographic best practices for key management
64+
65+
#### Interoperability
66+
67+
This implementation ensures compatibility with:
68+
- Nostr wallets implementing NIP-49
69+
- Key management tools using BIP-39 mnemonics
70+
- Other Nostr clients and libraries following the specification
71+
72+
#### Validation & Testing
73+
74+
To verify compatibility, the package includes:
75+
- Comprehensive test suites against NIP-49 specifications
76+
- Validation against known test vectors
77+
- Integration tests with common Nostr tools and libraries
78+
2779
## Installation
2880

2981
```bash
@@ -199,5 +251,5 @@ Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
199251

200252
---
201253
<div align="center">
202-
Made with ❤️ by <a href="https://github.com/humanjavaenterprises">Human Java Enterprises</a>
254+
Made with ❤️ by <a href="https://github.com/humanjavaenterprises">Humanjava Enterprises</a>
203255
</div>

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ We release patches for security vulnerabilities. Which versions are eligible for
1111

1212
## Reporting a Vulnerability
1313

14-
Please report security vulnerabilities to security@humanjavaenterprises.com.
14+
Please report security vulnerabilities through GitHub's Security Advisory feature at [https://github.com/humanjavaenterprises/nostr-nsec-seedphrase/security/advisories/new](https://github.com/humanjavaenterprises/nostr-nsec-seedphrase/security/advisories/new).
1515

16-
The team will acknowledge your email within 48 hours, and will send a more detailed response within 72 hours indicating the next steps in handling your report.
16+
The team will acknowledge your report within 48 hours, and will send a more detailed response within 72 hours indicating the next steps in handling your report.
1717

1818
After the initial reply to your report, the security team will endeavor to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
1919

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nostr-nsec-seedphrase",
3-
"version": "0.4.0",
3+
"version": "0.4.1",
44
"description": "A TypeScript library for managing Nostr keys with seed phrases, including event signing, verification, and WebSocket utilities",
55
"type": "module",
66
"main": "./dist/index.js",
@@ -38,7 +38,7 @@
3838
"typescript",
3939
"websocket"
4040
],
41-
"author": "Vergel Evans",
41+
"author": "vveerrgg",
4242
"license": "MIT",
4343
"bugs": {
4444
"url": "https://github.com/humanjavaenterprises/nostr-nsec-seedphrase/issues"

0 commit comments

Comments
 (0)