Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Gruruya/nmostr
Nim library for Nostr
https://github.com/Gruruya/nmostr
bech32 nim nostr
Last synced: 3 months ago
JSON representation
Nim library for Nostr
- Host: GitHub
- URL: https://github.com/Gruruya/nmostr
- Owner: Gruruya
- License: agpl-3.0
- Created: 2023-03-30T08:23:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-20T10:40:29.000Z (11 months ago)
- Last Synced: 2024-02-17T05:33:01.129Z (9 months ago)
- Topics: bech32, nim, nostr
- Language: Nim
- Homepage: https://gruruya.github.io/nmostr/
- Size: 658 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-nostr - nmostr - a Nim library for Nostr (Libraries / Client reviews and/or comparisons)
README
[
: Copyright © 2023 Gruruya
: SPDX-License-Identifier: CC-BY-SA-4.0
]:#
# nmostr
Library for working with Nostr.
Contained modules:
* Events
* Messages
* Bech32
* Proof of work
Stability: Early days. Functional.
Usage
---
Compile with `-d:ssl` for `wss://` connections
Example uses [guzba's whisky](https://github.com/guzba/whisky) i.e. `nimble install whisky`
```nim
import pkg/[nmostr, whisky]
let keypair = random Keypair
echo "New secret key: " & keypair.seckey.toBech32
echo "The public key: " & keypair.pubkey.toBech32
# Post a note
let socket = newWebSocket("wss://nostr.bongbong.com") # Remember to build with -d:ssl
socket.send CMEvent(event: note(keypair, "Hello world from nmostr!")).toJson
let response = socket.receiveMessage().get.data
echo response
# Read the note back
unpack fromMessage(response), msg:
when msg is SMOk:
socket.send CMRequest(id: randomID(), filter: Filter(ids: @[msg.id.hex])).toJson
echo socket.receiveMessage().get.data
```
For more, see the reference client [niomo](https://github.com/Gruruya/niomo) and [tests](tests/tbasic.nim).
What is Nostr?
---
[Nostr](https://nostr.com) is a simple decentralized protocol. It defines a standard for sending and receiving messages between users identified by their public keys using generic servers or "relays" that handle storage and logic.
Its popularity grew with the goal of creating a decentralized alternative to Twitter and an alternative to the [Fediverse](https://www.fediverse.to) ([Mastodon](https://joinmastodon.org)/[Pleroma](https://pleroma.social)) that doesn't constrain users to one server that can be shut down or blocked.
---
[](../../actions/workflows/build.yml)
[](https://nim-lang.org)
[](LICENSE.md)