Skip to content

Latest commit

 

History

History
76 lines (66 loc) · 5.59 KB

TODO.md

File metadata and controls

76 lines (66 loc) · 5.59 KB
Raw

TODO

Required

  • Change unreachable() at line 80 of relay.rs. Whenever someone sends something that cannot be parsed as EVENT, REQUEST or CLOSE, it breaks
  • Fix close message closing the connection even with different id
  • Verify PoisonError when client closes connection with Ctrl C
  • Should not allow a client to close the connection of another client (subscription_id)
  • Fix relay line 203 and above not sending message to matched filters
  • Add received event message to the struct of the ClientConnectionInfo
  • Create a way of storing also the pubkeys of clients
  • Filters must be related to the subscription_id because we need to have a way of deleting them when CLOSE message is sent
  • Client REQ message can have multiple filters
  • [RELAY] Should save all events (disconnected clients) in another structure because in the case a client disconnects from the relay, we won't have ClientConnectionInfo anymore (because the client is not connected anymore) and, therefore, if we want to preserve the events and send to someone else afterwards, we will need to have this info, otherwise it will be lost.
  • [RELAY] Check what #[serde(untagged)] does to enum in event.rs -> It removes the enum key and prints only the value.
  • [CLIENT/RELAY] One thing no note is that the Tags and the content are dependent on the Kind.
  • [RELAY] Use limit from filter on first request of events and return the most recent ones up until the number defined by this value
  • [CLIENT/RELAY] Tests!
  • [CLIENT] Change this serialization to transform a vector into a spread of objects (...filter). NEED TO TEST
  • [RELAY] When sending events requested to client, do not send it as a vector.
  • [RELAY] Verify UnboundedSender<Message> for tips on dealing with closed connection.
  • [RELAY] Add listener to CTRL C.
  • [RELAY] Fix JSON as_json and from_json of communications.
  • [RELAY] Check filter function on REQ message. I suppose it is not working OR the database is not saving events properly. Example:
["EVENT",{"kind":1,"content":"Hello modafoca","tags":[],"created_at":1684144532,"pubkey":"5081ce98f7da142513444079a55e2d1676559a908d4f694d299057f8abddf835","id":"2c53b58e0882b75b6540659ec0f4217d41000a12497ecbcabe9574384839273c","sig":"054a5e289356e5b0cb3a5b5e71e07e91b178c67c236bc2c77f98faeef418439fb9a944f054f0f010d08dfbc8fb68e36afaf485be24f1526f38134df61a58c311"}]

["REQ","5968712077837064",{"authors":["5081ce98f7da142513444079a55e2d1676559a908d4f694d299057f8abddf835"],"kinds":[1,6]}]

It is working. The problem was with sending the message as BINARY to the client.

  • [RELAY] I believe I'm sending too many events at a time. Need to check. No, I'm doing fine.
  • [RELAY] Add nginx.conf to the repository -> remember also when setting up a new nginx server that if certbot is not finding it, is because probably because you are using www.<domain> and not only <domain>. Also, remember about the Proxied thing of cloudfare.
  • [CLIENT/RELAY] Improve error and normal functioning logging/handling (env::logger, tracing).
  • [ALL] Create Makefiles (just like the relay one) and change githooks to use them.
  • [CLIENT/RELAY] Check why GithubActions is failing. Didn't do anything. Just worked again.
  • [RELAY] Maybe I can close a channel by sending tx.unbounded_send(Message::Close()).unwrap().
  • [RELAY] Should check event to verify if the signature is valid.
  • [RELAY] Fix Dockerfile. Take a look at this for an example.
  • [RELAY] Generate binary release with Github Actions. See this example
  • [CLIENT] Should sign events properly.
  • [CLIENT] Send METADATA when connecting to RELAY.
  • [CLIENT] The first time it runs (without a DB created, it is throwing an err that table keys does not exist).
  • [CLIENT] When client is sending message, it is alternating between different relays <--.
  • [CLIENT] Clients should NOT be allowed to open more than one connection to the same server.
  • [CLIENT] Should save its own filters in order to request data from different relays.
  • [CLIENT] Must validate signature.
  • [CLIENT] Disconnect from relay.
  • [CLIENT] Add reply/comment function.
  • [CLIENT] Add retweet function.
  • [CLIENT/RELAY] Finish the implementation of all the required NIPs (just NIP01)
  • [CLIENT] Bug connecting two times to relay: once when add_relay() and another when connect().
  • [CLIENT] When remove_relay() from pool should close its connection as well.
  • [ALL] Create integration tests.
  • [ALL] Check publicity of modules.
  • [ALL] Remove unnecessary dependencies.
  • [-] [CLIENT] Should have a way of handling duplicated events, since a client can be connected to multiple relays To be used when calling from a frontend or whatnot.

Improvements

  • [CLIENT/RELAY/SDK] Use cargo workspaces (maybe).
  • [CLIENT] Create abstraction function to follow someone(i.e.: send a new REQ message with a filter requiring its pubkey).
  • [CLIENT] Should save its own events.
  • [RELAY] Improve cross-compilation to darwin and windows.
  • [RELAY] Change the way Relay reads from DB (putting all that data in memory is not the best case scenario).
  • [CLIENT/RELAY] Add data validation to prevent panics.
  • [CLIENT/RELAY] Check tracing.
  • [CLIENT/RELAY] Implement optional NIPs

NIPs implemented

  • NIP01
  • NIP10