Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/block-core/blockcore-notes

Notes app for decentralized infrastructures (Nostr and Web5)
https://github.com/block-core/blockcore-notes

nostr web5

Last synced: about 1 month ago
JSON representation

Notes app for decentralized infrastructures (Nostr and Web5)

Awesome Lists containing this project

README 

        


  


    Blockcore

  


  


    Blockcore Notes

  


  


    Notes app for decentralized infrastructures (Nostr and Web5)

  


  


      

  



Blockcore Notes is an app for your public and personal notes. It is built to support the Nostr and Web5 (coming in the future).



![](/src/assets/blockcore-notes-screenshot.png)



## Nostr



The Nostr support for Blockcore Notes relies on using your Nostr identity (public key) and uses a set of relays to publish and store your notes. You can run your own personal relay to always keep a backup of your notes.



## Web5



The Web5 support for Blockcore Notes relies on using your DID and use your DWN (Decentralized Web Nodes) to publish and store your notes. The Blockcore Wallet already supports and hosts an internal DWN within the extension, this can be used to store a local copy of all your notes.



## Connect using extension



Blockcore Notes require that you use an extension that keeps your keys secure and is responsible for performing signing of your notes, and performs encryption and decryption for private notes.



We suggest using [Blockcore Wallet](https://github.com/block-core/blockcore-wallet) ([Chrome Web Store](https://chrome.google.com/webstore/detail/blockcore-wallet/peigonhbenoefaeplkpalmafieegnapj)), but other options are available such as [nos2x](https://github.com/fiatjaf/nos2x) and [Alby](https://github.com/getAlby/lightning-browser-extension).



# Features



A goal of Blockcore Notes is to be feature rich and have functionality that goes beyond the NIP-specifications.



- Mobile and Desktop

- Organize people and circles

- Activity Feed (Notifications)

- Following Feed

- Reactions (turn off in Settings)

- Rich Media Support, videos, music, podcast and YouTube.

- Thread View

- Profile View and Edit

- Infinity Scroll (go far back on user posts)

- Import and Export of backup (JSON file)

- Import and Export of contacts (publish)

- Identify Verification

- Browser Extension and Private Key Import supported

- Advanced Relay Management

- Profile Edit

- Notes Management (save notes)

- Media Player (listen to podcasts, music or watch videos while reading feeds)



## NIPs



- [x] [NIP-01: Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md)

- [x] [NIP-02: Contact List and Petnames](https://github.com/nostr-protocol/nips/blob/master/02.md)

- [ ] [NIP-04: Encrypted Direct Message](https://github.com/nostr-protocol/nips/blob/master/04.md)

- [x] [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](https://github.com/nostr-protocol/nips/blob/master/05.md)

- [x] [NIP-06: Basic key derivation from mnemonic seed phrase](https://github.com/nostr-protocol/nips/blob/master/06.md)

- [x] [NIP-07: `window.nostr` capability for web browsers](https://github.com/nostr-protocol/nips/blob/master/07.md)

- [ ] [NIP-08: Handling Mentions](https://github.com/nostr-protocol/nips/blob/master/08.md)

- [ ] [NIP-09: Event Deletion](https://github.com/nostr-protocol/nips/blob/master/09.md)

- [x] [NIP-10: Conventions for clients' use of `e` and `p` tags in text events](https://github.com/nostr-protocol/nips/blob/master/10.md)

- [x] [NIP-11: Relay Information Document](https://github.com/nostr-protocol/nips/blob/master/11.md)

- [ ] [NIP-14: Subject tag in text events.](https://github.com/nostr-protocol/nips/blob/master/14.md)

- [x] [NIP-19: bech32-encoded entities](https://github.com/nostr-protocol/nips/blob/master/19.md)

- [x] [NIP-21: `nostr:` URL scheme](https://github.com/nostr-protocol/nips/blob/master/21.md)

- [x] [NIP-23: Long-form Content](https://github.com/nostr-protocol/nips/blob/master/23.md)

- [x] [NIP-25: Reactions](https://github.com/nostr-protocol/nips/blob/master/25.md)

- [ ] [NIP-26: Delegated Event Signing](https://github.com/nostr-protocol/nips/blob/master/26.md)

- [x] [NIP-27: Text Note References](https://github.com/nostr-protocol/nips/blob/master/27.md)

- [ ] [NIP-28: Public Chat](https://github.com/nostr-protocol/nips/blob/master/28.md)

- [ ] [NIP-36: Sensitive Content](https://github.com/nostr-protocol/nips/blob/master/36.md)

- [ ] [NIP-40: Expiration Timestamp](https://github.com/nostr-protocol/nips/blob/master/40.md)

- [ ] [NIP-42: Authentication of clients to relays](https://github.com/nostr-protocol/nips/blob/master/42.md)

- [ ] [NIP-50: Keywords filter](https://github.com/nostr-protocol/nips/blob/master/50.md)

- [ ] [NIP-56: Reporting](https://github.com/nostr-protocol/nips/blob/master/56.md)

- [x] [NIP-57: Lightning Zaps](https://github.com/nostr-protocol/nips/blob/master/57.md)

- [x] [NIP-58: Badges](https://github.com/nostr-protocol/nips/blob/master/58.md)

- [x] [NIP-65: Relay List Metadata](https://github.com/nostr-protocol/nips/blob/master/65.md)



# Development



## Development server



Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.



## Code scaffolding



Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.



## Build



Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.



## Running unit tests



Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).



## Running end-to-end tests



Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.



## Further help



To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.



## Notes



Thoughts and ideas:



- Validate the content of certain limit and don't render at all if content is too long, or at least cut the content and only render X length. Then allow users to manually retrieve

  that exact event upon request.



Data Flow:



- Event received from relays... pushed into an event processor, which pushes events into individual services based upon the type.

- Individual services grabs existing event from StateService, if available, updates (if replaceable event or profile) or simply ignores. Maybe log "observed on relay".

- If not available, push into the StateService and schedule a database put.

- StateService should always keep some items in-memory: Profiles, Circles and more.



## Security



There are many ways a web app can be exploited when it allow user contributed content. Any and all measurements to avoid exploits should be done, like sanitizing the input.



[XSS Filter Evasion Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/XSS_Filter_Evasion_Cheat_Sheet.html)