silberengel
/
gitrepublic-web
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
164 Commits
1 Branch
0 Tags
13 MiB
 
 
 
 
 
Tree: 0ab1616068
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0ab1616068'
${ noResults }
gitrepublic-web/docs/specs.md

7.7 KiB
Raw Blame History

Specs Used

Complete list of Nostr Improvement Proposals (NIPs), GRASP specifications, and custom event kinds used by GitRepublic.

Standard NIPs

Core Protocol

Authentication & Identity

  • NIP-07: Browser Extension Authentication

    • window.nostr capability for browser extensions
    • Primary authentication method for GitRepublic web interface
    • Used for signing all repository-related events

  • NIP-19: bech32-encoded Entities

    • bech32 encoding (npub, nsec, note, nevent, naddr)
    • User-friendly display of pubkeys and event references
    • Used throughout the UI for repository URLs and search

  • NIP-98: HTTP Authentication

    • HTTP auth events (kind 27235)
    • Authenticates git operations (push, pull, clone)
    • Authenticates API requests
    • Ephemeral events for each request

Event Management

  • NIP-09: Event Deletion

    • Deletion requests (kind 5)
    • Used for cleaning up failed operations

  • NIP-10: Event References

    • Event references (e, p tags)
    • Used in patch series for threading patches
    • Used in PR updates and comments

  • NIP-22: Comments

    • Comment events (kind 1111)
    • Threaded discussions on PRs, issues, and patches
    • NIP-10 reply threading support

Git Collaboration

  • NIP-34: Git Repository Announcements
    • Complete git collaboration specification
    • 30617: Repository announcements (replaceable)
    • 30618: Repository state (replaceable, optional)
    • 1617: Patches
    • 1618: Pull requests
    • 1619: Pull request updates
    • 1621: Issues
    • 1630: Status Open
    • 1631: Status Applied/Merged
    • 1632: Status Closed
    • 1633: Status Draft

Relay & Discovery

  • NIP-02: Contact List

    • Contact list (kind 3)
    • Used for repository filtering
    • Fallback for relay discovery

  • NIP-65: Relay List Metadata

    • Relay list (kind 10002)
    • Discovers user's preferred relays for publishing events
    • Used to determine which relays to publish to

Content Features

  • NIP-84: Highlights
    • Highlight events (kind 9802)
    • Code selection and review features
    • Extended with file/line tags for code context

Payment Targets

  • NIP-A3: Payment Targets
    • Payment target events (kind 10133)
    • payto:// URI scheme (RFC-8905)
    • Supports multiple payment types (Lightning, Bitcoin, Ethereum, etc.)

See NIP-A3 documentation for complete details.

GRASP Specifications

GitRepublic provides minimal GRASP interoperability:

  • GRASP-01: Server identification and clone URL patterns

    • Detects GRASP servers from repository announcements
    • Identifies GRASP servers by URL pattern and relay tags

  • GRASP-02: Proactive synchronization (not implemented)

    • We don't do server-side hourly pulls
    • User-controlled via CLI pull-all command

  • GRASP-05: Archive mode (not implemented)

For GRASP documentation, see the GRASP specification repository.

Custom Event Kinds

GitRepublic uses custom event kinds not defined in any standard NIP:

Kind 1640: Commit Signature

Cryptographically sign git commits using Nostr keys.

Tags:

  • commit: Final commit hash
  • author: Author name (first occurrence)
  • author: Author email (second occurrence)
  • message: Commit message
  • e: Optional reference to NIP-98 auth event

Status: Custom implementation (may be proposed as NIP in future)

See Custom Event Kinds for complete documentation.

Kind 1641: Ownership Transfer

Transfer repository ownership from one pubkey to another.

Tags:

  • a: Repository address (30617:pubkey:repo)
  • p: New owner pubkey
  • d: Repository name
  • t: "self-transfer" marker (for initial ownership proof)

Status: Custom implementation (non-replaceable to maintain ownership chain)

See Custom Event Kinds for complete documentation.

Kind 30620: Branch Protection

Enforce branch protection rules (require PRs, reviews, status checks).

Tags:

  • d: Repository name
  • a: Repository identifier
  • branch: Branch name and protection settings

Status: Custom implementation (replaceable)

See Custom Event Kinds for complete documentation.

Event Kind Reference

Kind Name NIP Replaceable Documentation
1 Text Note NIP-01 No NIP-01
3 Contact List NIP-02 Yes NIP-02
5 Deletion Request NIP-09 No NIP-09
1111 Comment NIP-22 No NIP-22
1617 Patch NIP-34 No NIP-34
1618 Pull Request NIP-34 No NIP-34
1619 Pull Request Update NIP-34 No NIP-34
1621 Issue NIP-34 No NIP-34
1630 Status Open NIP-34 No NIP-34
1631 Status Applied NIP-34 No NIP-34
1632 Status Closed NIP-34 No NIP-34
1633 Status Draft NIP-34 No NIP-34
1640 Commit Signature Custom No CustomKinds.md
1641 Ownership Transfer Custom No CustomKinds.md
30617 Repo Announcement NIP-34 Yes NIP-34
30618 Repo State NIP-34 Yes NIP-34
30620 Branch Protection Custom Yes CustomKinds.md
9802 Highlight NIP-84 No NIP-84
10002 Relay List NIP-65 Yes NIP-65
10133 Payment Targets NIP-A3 Yes NIP-A3
27235 HTTP Auth NIP-98 No NIP-98

Complete Event Documentation

For complete event structure documentation with JSON examples, see:

Next Steps