Road Map and To-do

[0ceanSlim]

I'm removing the to-do list from the readme in preparation for the first release. Because of that, I'll be moving the current to-do list here and making a roadmap to keep track of ideas that come to mind from here.

To-do:

DONE ✅

• Reject Events
  • Older than
  • Newer than
• Design a more informative, cleaner frontend ui PLANNED LATER
• database storage limit tied into purging at a certain limit PLANNED LATER
  • purge events from non auth or whitelisted users only PLANNED LATER
  • notification on frontend. Here you can solicit to unpaid users that old notes are being deleted unless you're a paid subscriber. PLANNED LATER
• Blacklist
  • ~~add pubkeys from a pubkeys kind10000 mutelist to blacklist (must be stored on relay) MOVED TO IT'S OWN ISSUE~~
  • Blacklist domains NOT PLANNED
  • Blacklist Kind (This can already be done with a 0 rate limit) NOT PLANNED
  • by category
  • by kind int
• configurable event purging
  • by category
  • by kind
  • by time since latest
  • Purge Whitelisted Events: bool
• configurable resource limits (add to ~~size limiter and add cpu, ram and bandwidth limits)~~
• Add timeouts to config.yml
• Capture and handle more client info (IP, User-Agent, Origin)
• Configurable limits for max number of concurrent connections
• Configurable limits for max number of concurrent subscriptions
  • per client/connection
• create whitelist functionality for:
  • pubkey
  • npub
  • valid nip05 domain
  • list of allowable domains
  • kind integer
• Create blacklist functionality for pubkey/npub (kinds can be blacklisted with a 0 rate limit)
  • blacklist by wordlist
  • temporarily ban a pubkey if kind0 or kind1 event contains any word from temp word list
  • this will add a pubkey to the blacklist for a configurable amount of time and then remove them from the list
  • max temp ban (a pubkey will be permanently banned after a configurable amount of temp bans)
  • Permanant ban word list
  • add pubkeys from a pubkeys kind10000 mutelist to blacklist (must be stored on relay)
• Watch config.yml for changes
  • gracefully shutdown and restart the server to acquire the new configurations

[0ceanSlim]

User syncing. if when an event is stored, I want to search a set of relays for that pubkey's NIP65 and grab that relay list. Then search all those relays for any notes from that user and store them in grain.

configurable

• User Sync true/false

  Syc all can only be true if there is no sync kinds

  • sync all user notes - true
  • sync initial relays [ wss://relay.example ]
  • sync only kinds [ 0,3,10004]
  • sync user follows - true/false
  • kinds [ ]

[0ceanSlim]

server metrics

• resource usage
• database size
  • collection sizes on a pie chart
• accepted events per hour minute day average
• average size of accepted event
• uptime (separate app?) Add more robust logging

[0ceanSlim]

Multi Database support

• Add support for a local, non-sql database
• Add support for postgress sql and sqlite

I want to remove the dependency for mongo so users can work with the database their familiar with.

[0ceanSlim]

Support for eCash/Lighting payments for Relay Credit

• Configurable cost per kind insertion
  • A default amount for any kind insertion (1 sat per event)
  • Configuration for cost on a per kind basis (2 sats per kind1, 3 sats per kind0, etc)
• Frontend to top up credit
  • Fetch an invoice for a certain amount, receive payment, top up credit for pubkey

[0ceanSlim]

Auth with NIP07 to access configurations from the frontend and apply new configurations from the app.

• NIP07 pubkey just needs to match the relay operator pubkey in the relay_matadata.json

[0ceanSlim]

Note Blaster

• Configurations to blast any received and stored notes to a list of public relays
  • Perhaps I can use nostr.watch api for the list of public relays

[0ceanSlim]

Original list done and other comments moved to their own issues