https://github.com/lnbits/arduino-nostr

https://github.com/lnbits/arduino-nostr

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lnbits/arduino-nostr
• Owner: lnbits
• License: mit
• Created: 2023-03-15T16:19:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-14T16:58:29.000Z (11 months ago)
• Last Synced: 2024-02-17T05:33:01.098Z (10 months ago)
• Language: C++
• Size: 11 MB
• Stars: 42
• Watchers: 2
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nostr - arduino-nostr - nostr.svg?style=social) - An Arduino nostr library. (Libraries / Client reviews and/or comparisons)

README

        
# Arduino Nostr Library

Nostr: A simple, open protocol that enables a truly censorship-resistant and global social network.

This library gives the ability to interact with Nostr relays with Arduino microcontrollers.

## Features

+ NostrEvent - For creation of NIP01 and NIP04 notes

+ NostrRelayManager - For management of multiple relays and message broadcasting and receiving

+ NostrQueueProcessor - For queueing up relay messages

+ NostrRequestOptions - For creating a request object that can be sent to relays

+ Send notes and private messages with support for NIP01 kind 1 and NIP04 kind 4.

+ Receieve and decrypt NIP04 messages.

+ Broadcast messages to multiple relays with the ability to specify custom callbacks for NIP01, NIP04, and OK messages.

+ Add messages to a queue for broadcasting once relays are connected.

+ Subscribe to relay events using REQ messages.

+ Specify a minimum number of relays required for broadcasting and specify a timeout to ensure messages are broadcast even if the minimum number of relays is not reached.

## Usage

See the example scripts in `examples/` for simple examples of how to use this library.