Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tcheeric/nostr-java
A nostr library, written in java, for generating, signing and publishing events.
https://github.com/tcheeric/nostr-java
java nostr
Last synced: 26 days ago
JSON representation
A nostr library, written in java, for generating, signing and publishing events.
- Host: GitHub
- URL: https://github.com/tcheeric/nostr-java
- Owner: tcheeric
- License: mit
- Created: 2022-12-18T13:51:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T17:30:01.000Z (27 days ago)
- Last Synced: 2024-05-29T08:32:58.825Z (26 days ago)
- Topics: java, nostr
- Language: Java
- Homepage:
- Size: 1.4 MB
- Stars: 63
- Watchers: 4
- Forks: 18
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-nostr - nostr-java - java.svg?style=social) - A nostr client library, written in java, for generating, signing and publishing events. (Libraries / Client reviews and/or comparisons)
- Self-Hosting-Guide - nostr-java - A nostr client API written in java, for generating, signing and publishing events to relays. (Install from Source / Nostr)
README
# nostr-java
[](https://jitpack.io/#tcheeric/nostr-java)
Introducing the nostr-java library, a solution written in java for generating, signing, and publishing nostr events to relays.
## Requirements
- Maven
- Java 19+
## Usage
To use the library in your project, add the following dependency to your pom.xml file:
```xml
com.github.tcheeric.nostr-java
nostr-java-api
${nostr.java.version}
```
I recommend having a look at the [nostr-example](https://github.com/tcheeric/nostr-java/tree/main/nostr-java-examples) module and the [nostr-client](https://github.com/tcheeric/nostr-client/) project for a simple example on how to use the library.
## Supported NIPs
The following NIPs are supported by the API out-of-the-box:
- [NIP-1](https://github.com/nostr-protocol/nips/blob/master/01.md)
- [NIP-2](https://github.com/nostr-protocol/nips/blob/master/02.md)
- [NIP-3](https://github.com/nostr-protocol/nips/blob/master/03.md)
- [NIP-4](https://github.com/nostr-protocol/nips/blob/master/04.md)
- [NIP-5](https://github.com/nostr-protocol/nips/blob/master/05.md)
- [NIP-8](https://github.com/nostr-protocol/nips/blob/master/08.md)
- [NIP-9](https://github.com/nostr-protocol/nips/blob/master/09.md)
- [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md)
- [NIP-14](https://github.com/nostr-protocol/nips/blob/master/14.md)
- [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md)
- [NIP-20](https://github.com/nostr-protocol/nips/blob/master/20.md)
- [NIP-23](https://github.com/nostr-protocol/nips/blob/master/23.md)
- [NIP-25](https://github.com/nostr-protocol/nips/blob/master/25.md)
- [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md)
- [NIP-30](https://github.com/nostr-protocol/nips/blob/master/30.md)
- [NIP-32](https://github.com/nostr-protocol/nips/blob/master/32.md)
- [NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)
- [NIP-42](https://github.com/nostr-protocol/nips/blob/master/42.md)
- [NIP-44](https://github.com/nostr-protocol/nips/blob/master/44.md)
- [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md)
- [NIP-57](https://github.com/nostr-protocol/nips/blob/master/57.md)
## Dev Discussion Group:
- Nostr Public Channel: nostr:nevent1qqszqdmxg26sehmnyrcu2ler8azz6wyj6fh0qg3ad5fnnm6xfqqvhzcppamhxue69uhkummnw3ezumt0d5pzpl7nwh45p66gvet2q28dhjpcyh6clux4cjsm5gh7waza9pzjnmgglv06ew