feat: add NIP-43 invite code foundation#650
Open
Anshumancanrock wants to merge 1 commit into
Open
Conversation
🦋 Changeset detectedLatest commit: 0119664 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
afbfc55 to
1c4b970
Compare
Collaborator
|
Coverage is 67.099% — feat/nip43-invite-codes into main. No base build found for |
- Add event kinds 8000, 8001, 13534, 28934, 28935, 28936 and tags (member, claim) - Create InviteCode/DBInviteCode types and Nip43Settings interface - Add IInviteCodeRepository interface with create, findByCode, claimCode, findActiveCodes, deleteExpiredCodes - Implement InviteCodeRepository with atomic claimCode via single UPDATE - Add generateInviteCode() using crypto.randomBytes (128-bit entropy) - Create invite_codes migration with CHECK constraints and partial index - Add revokeAdmission() and findAllAdmitted() to UserRepository - Add 27 unit tests with full coverage
1c4b970 to
0119664
Compare
There was a problem hiding this comment.
Pull request overview
This PR introduces foundational invite-code infrastructure to support NIP-43 relay membership workflows, including a new repository for managing invite codes, schema/types to represent them, and constants/settings needed by upcoming join/leave handlers.
Changes:
- Added
InviteCodeRepositorywith code generation, creation, lookup, atomic claim, active-code listing, and expiry cleanup methods. - Added
invite_codesdatabase migration plus corresponding TypeScript types and repository interface. - Extended NIP-43-related event kind/tag constants and added
nip43settings shape.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/repositories/invite-code-repository.spec.ts | Adds unit tests covering the new repository behaviors and expected transformations. |
| src/repositories/invite-code-repository.ts | Implements invite-code persistence and atomic claiming logic over invite_codes. |
| src/constants/base.ts | Adds NIP-43 event kinds and tags used by relay access metadata/requests. |
| src/@types/settings.ts | Introduces Nip43Settings and wires it into the global Settings type. |
| src/@types/repositories.ts | Defines IInviteCodeRepository interface for the new repository. |
| src/@types/invite-code.ts | Adds InviteCode and DBInviteCode types for app/DB representations. |
| migrations/20260624_120000_create_nip43_invite_codes_table.js | Creates invite_codes table and adds check constraints + expiry index. |
| .knip.json | Ignores the new repository file in knip analysis. |
| .changeset/nip43-invite-codes.md | Adds a minor changeset describing the new NIP-43 invite-code foundation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| maxUses: number = 1, | ||
| client: DatabaseClient = this.dbClient, | ||
| ): Promise<InviteCode> { | ||
| logger('create invite code: %s (expires: %s, maxUses: %d)', code, expiresAt ?? 'never', maxUses) |
| code: string, | ||
| client: DatabaseClient = this.dbClient, | ||
| ): Promise<InviteCode | undefined> { | ||
| logger('find invite code: %s', code) |
| pubkey: Pubkey, | ||
| client: DatabaseClient = this.dbClient, | ||
| ): Promise<boolean> { | ||
| logger('claim invite code %s for %s', code, pubkey) |
| }) | ||
| .update({ | ||
| use_count: client.raw('use_count + 1'), | ||
| claimed_by: toBuffer(pubkey), |
Comment on lines
+43
to
+46
| afterEach(() => { | ||
| dbClient.destroy() | ||
| sandbox.restore() | ||
| }) |
cameri
reviewed
Jun 28, 2026
Comment on lines
+7
to
+8
| table.integer('max_uses').notNullable().defaultTo(1) | ||
| table.integer('use_count').notNullable().defaultTo(0) |
Owner
There was a problem hiding this comment.
I think these two fields could just be one called remaining_uses, once it gets to <= 0 the invite can no longer be used.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Invite code infrastructure for NIP-43 relay membership.
claimCode()uses a single atomic UPDATE with WHERE guards (not expired, uses remaining) so concurrent claims on the same code are safe without transactions.claimed_byhas no FK tousersso users don't exist yet at claim time.Related Issue
NIP-43 implementation
Motivation and Context
Need a data layer for NIP-43 join/leave handlers.
How Has This Been Tested?
25 unit tests, full suite 1322 passing.
Types of changes
Checklist: