Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slaninas/nostr-bot
Nostr bot library for Rust
https://github.com/slaninas/nostr-bot
bot nostr rust
Last synced: 26 days ago
JSON representation
Nostr bot library for Rust
- Host: GitHub
- URL: https://github.com/slaninas/nostr-bot
- Owner: slaninas
- License: mit
- Created: 2022-08-07T14:45:17.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-03T20:50:05.000Z (about 1 year ago)
- Last Synced: 2024-05-14T13:02:37.592Z (about 1 month ago)
- Topics: bot, nostr, rust
- Language: Rust
- Homepage:
- Size: 145 KB
- Stars: 41
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-nostr - nostr-bot - bot.svg?style=social) - a Rust library for writing bots (Libraries / Client reviews and/or comparisons)
- Self-Hosting-Guide - nostr-bot - a Rust library for writing bots. (Install from Source / Nostr)
README
# Nostr Bot
Do you want to run your own nostr bot? You've come to the right place.
This crate makes it easy to implement your own bot that reacts to [nostr](https://github.com/nostr-protocol/nostr) events, using [tokio](https://github.com/tokio-rs/tokio).
This crate is young and still being developed so there may be hiccups. If you find any issue, don't hesitate to create PR/issue on [GitHub](https://github.com/slaninas/nostr-bot).
Full documentation is available [here](https://docs.rs/nostr-bot/latest/nostr_bot/).
## Usage
This crate is on [crates.io](https://crates.io/crates/nostr-bot) and can be
used by adding `nostr-bot` to your dependencies in your project's `Cargo.toml`.
```toml
[dependencies]
nostr-bot = "0.2"
```
You can also use GitHub [repository](https://github.com/slaninas/nostr-bot):
```toml
[dependencies]
nostr-bot = { git = "https://github.com/slaninas/nostr-bot", rev = "v0.2.3" }
```
Or you can clone the [repository](https://github.com/slaninas/nostr-bot) and use it locally:
```toml
[dependency]
nostr-bot = { path = "your/path/to/nostr-bot" }
```
## Example
```rust
// Bot that reacts to '!yes', '!no' and '!results' commands.
use nostr_bot::*;
// Your struct that will be passed to the commands responses
struct Votes {
question: String,
yes: u64,
no: u64,
}
type State = nostr_bot::State;
fn format_results(question: &str, votes: &Votes) -> String {
format!(
"{}\n------------------\nyes: {}\nno: {}",
question, votes.yes, votes.no
)
}
// Following functions are command responses, you are getting nostr event
// and shared state as arguments and you are supposed to return non-signed
// event which is then signed using the bot's key and send to relays
async fn yes(event: Event, state: State) -> EventNonSigned {
let mut votes = state.lock().await;
votes.yes += 1;
// Use formatted voting results to create new event
// that is a reply to the incoming command
get_reply(event, format_results(&votes.question, &votes))
}
async fn no(event: Event, state: State) -> EventNonSigned {
let mut votes = state.lock().await;
votes.no += 1;
get_reply(event, format_results(&votes.question, &votes))
}
async fn results(event: Event, state: State) -> EventNonSigned {
let votes = state.lock().await;
get_reply(event, format_results(&votes.question, &votes))
}
#[tokio::main]
async fn main() {
init_logger();
let relays = vec![
"wss://nostr-pub.wellorder.net",
"wss://relay.damus.io",
"wss://relay.nostr.info",
];
let keypair = keypair_from_secret(
// Your secret goes here, can be hex or bech32 (nsec1...)
"0000000000000000000000000000000000000000000000000000000000000001",
);
let question = String::from("Do you think Pluto should be a planet?");
// Wrap your object into Arc so it can be shared among command handlers
let shared_state = wrap_state(Votes {
question: question.clone(),
yes: 0,
no: 0,
});
// And now the Bot
Bot::new(keypair, relays, shared_state)
// You don't have to set these but then the bot will have incomplete profile info :(
.name("poll_bot")
.about("Just a bot.")
.picture("https://i.imgur.com/ij4XprK.jpeg")
.intro_message(&question)
// You don't have to specify any command but then what will the bot do? Nothing.
.command(Command::new("!yes", wrap!(yes)))
.command(Command::new("!no", wrap!(no)))
.command(Command::new("!results", wrap!(results)))
// And finally run it
.run()
.await;
}
```