Struct nostr_sdk::EventBuilder

pub struct EventBuilder { /* private fields */ }

Event builder

Implementations

impl EventBuilder

pub fn new<S>(kind: Kind, content: S, tags: &[Tag]) -> EventBuilderwhere S: Into<String>,

New EventBuilder

pub fn to_event_with_ctx<C, R, T>( self, secp: &Secp256k1<C>, rng: &mut R, supplier: &T, keys: &Keys ) -> Result<Event, Error>where C: Signing, R: Rng + CryptoRng, T: TimeSupplier,

Build Event

pub fn to_unsigned_event_with_supplier<T>( self, supplier: &T, pubkey: XOnlyPublicKey ) -> UnsignedEventwhere T: TimeSupplier,

Build UnsignedEvent

pub fn to_pow_event_with_ctx<C, R, T>( self, secp: &Secp256k1<C>, rng: &mut R, supplier: &T, keys: &Keys, difficulty: u8 ) -> Result<Event, Error>where C: Signing, R: Rng + CryptoRng, T: TimeSupplier,

Build POW Event

pub fn to_unsigned_pow_event_with_supplier<T>( self, supplier: &T, pubkey: XOnlyPublicKey, difficulty: u8 ) -> UnsignedEventwhere T: TimeSupplier,

Build unsigned POW Event

impl EventBuilder

pub fn to_event(self, keys: &Keys) -> Result<Event, Error>

Build Event

pub fn to_unsigned_event(self, pubkey: XOnlyPublicKey) -> UnsignedEvent

Build UnsignedEvent

pub fn to_pow_event(self, keys: &Keys, difficulty: u8) -> Result<Event, Error>

Build POW Event

pub fn to_unsigned_pow_event( self, pubkey: XOnlyPublicKey, difficulty: u8 ) -> UnsignedEvent

Build unsigned POW Event

impl EventBuilder

pub fn set_metadata(metadata: Metadata) -> EventBuilder

Set metadata

https://github.com/nostr-protocol/nips/blob/master/01.md

Example

use nostr::url::Url;
use nostr::{EventBuilder, Metadata};

let metadata = Metadata::new()
    .name("username")
    .display_name("My Username")
    .about("Description")
    .picture(Url::parse("https://example.com/avatar.png").unwrap())
    .nip05("username@example.com")
    .lud16("yuki@getalby.com");

let builder = EventBuilder::set_metadata(metadata);

pub fn add_recommended_relay(url: &Url) -> EventBuilder

Add recommended relay

pub fn new_text_note<S>(content: S, tags: &[Tag]) -> EventBuilderwhere S: Into<String>,

Text note

https://github.com/nostr-protocol/nips/blob/master/01.md

Example

use nostr::EventBuilder;

let builder = EventBuilder::new_text_note("My first text note from Nostr SDK!", &[]);

pub fn long_form_text_note<S>(content: S, tags: &[Tag]) -> EventBuilderwhere S: Into<String>,

Long-form text note (generally referred to as “articles” or “blog posts”).

https://github.com/nostr-protocol/nips/blob/master/23.md

Example

use std::str::FromStr;

use nostr::{EventBuilder, Tag, Timestamp, EventId, UncheckedUrl};

let event_id = EventId::from_hex("b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87").unwrap();
let content: &str = "Lorem [ipsum][4] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at #[3].";
let tags = &[
    Tag::Identifier("lorem-ipsum".to_string()),
    Tag::Title("Lorem Ipsum".to_string()),
    Tag::PublishedAt(Timestamp::from(1296962229)),
    Tag::Hashtag("placeholder".to_string()),
    Tag::Event(event_id, Some(UncheckedUrl::from("wss://relay.example.com")), None),
];
let builder = EventBuilder::long_form_text_note("My first text note from Nostr SDK!", &[]);

pub fn set_contact_list(list: Vec<Contact, Global>) -> EventBuilder

Set contact list

pub fn new_encrypted_direct_msg<S>( sender_keys: &Keys, receiver_pubkey: XOnlyPublicKey, content: S, reply_to: Option<EventId> ) -> Result<EventBuilder, Error>where S: Into<String>,

Create encrypted direct msg event

pub fn repost(event_id: EventId, public_key: XOnlyPublicKey) -> EventBuilder

Repost event

pub fn delete<S>(ids: Vec<EventId, Global>, reason: Option<S>) -> EventBuilderwhere S: Into<String>,

Create delete event

pub fn new_reaction<S>( event_id: EventId, public_key: XOnlyPublicKey, content: S ) -> EventBuilderwhere S: Into<String>,

Add reaction (like/upvote, dislike/downvote or emoji) to an event

pub fn new_channel(metadata: Metadata) -> EventBuilder

Create new channel

https://github.com/nostr-protocol/nips/blob/master/28.md

pub fn set_channel_metadata( channel_id: ChannelId, relay_url: Option<Url>, metadata: Metadata ) -> EventBuilder

Set channel metadata

https://github.com/nostr-protocol/nips/blob/master/28.md

pub fn new_channel_msg<S>( channel_id: ChannelId, relay_url: Url, content: S ) -> EventBuilderwhere S: Into<String>,

New channel message

https://github.com/nostr-protocol/nips/blob/master/28.md

pub fn hide_channel_msg<S>( message_id: EventId, reason: Option<S> ) -> EventBuilderwhere S: Into<String>,

Hide message

https://github.com/nostr-protocol/nips/blob/master/28.md

pub fn mute_channel_user<S>( pubkey: XOnlyPublicKey, reason: Option<S> ) -> EventBuilderwhere S: Into<String>,

Mute channel user

https://github.com/nostr-protocol/nips/blob/master/28.md

pub fn auth<S>(challenge: S, relay: Url) -> EventBuilderwhere S: Into<String>,

Create an auth event

https://github.com/nostr-protocol/nips/blob/master/42.md

pub fn nostr_connect( sender_keys: &Keys, receiver_pubkey: XOnlyPublicKey, msg: Message ) -> Result<EventBuilder, Error>

Nostr Connect

https://github.com/nostr-protocol/nips/blob/master/46.md

pub fn live_event(live_event: LiveEvent) -> EventBuilder

Live Event

https://github.com/nostr-protocol/nips/blob/master/53.md

pub fn live_event_msg<S>( live_event_id: S, live_event_host: XOnlyPublicKey, content: S, relay_url: Option<Url>, tags: Vec<Tag, Global> ) -> EventBuilderwhere S: Into<String>,

Live Event Message

https://github.com/nostr-protocol/nips/blob/master/53.md

pub fn report<S>(tags: &[Tag], content: S) -> EventBuilderwhere S: Into<String>,

Create report event

https://github.com/nostr-protocol/nips/blob/master/56.md

pub fn new_zap_request(data: ZapRequestData) -> EventBuilder

Create zap request event

https://github.com/nostr-protocol/nips/blob/master/57.md

pub fn new_zap_receipt<S>( bolt11: S, preimage: Option<S>, zap_request: Event ) -> EventBuilderwhere S: Into<String>,

Create zap receipt event

https://github.com/nostr-protocol/nips/blob/master/57.md

pub fn define_badge<S>( badge_id: S, name: Option<S>, description: Option<S>, image: Option<UncheckedUrl>, image_dimensions: Option<ImageDimensions>, thumbnails: Option<Vec<(UncheckedUrl, Option<ImageDimensions>), Global>> ) -> EventBuilderwhere S: Into<String>,

Create a badge definition event

https://github.com/nostr-protocol/nips/blob/master/58.md

Example

use nostr::{EventBuilder, ImageDimensions, UncheckedUrl};

let badge_id = String::from("nostr-sdk-test-badge");
let name = Some(String::from("Nostr SDK test badge"));
let description = Some(String::from("This is a test badge"));
let image_url = Some(UncheckedUrl::from("https://nostr.build/someimage/1337"));
let image_size = Some(ImageDimensions::new(1024, 1024));
let thumbs = Some(vec![(
    UncheckedUrl::from("https://nostr.build/somethumbnail/1337"),
    Some(ImageDimensions::new(256, 256)),
)]);

let event_builder =
    EventBuilder::define_badge(badge_id, name, description, image_url, image_size, thumbs);

pub fn award_badge( badge_definition: &Event, awarded_pubkeys: Vec<Tag, Global> ) -> Result<EventBuilder, Error>

Create a badge award event

https://github.com/nostr-protocol/nips/blob/master/58.md

pub fn profile_badges( badge_definitions: Vec<Event, Global>, badge_awards: Vec<Event, Global>, pubkey_awarded: &XOnlyPublicKey ) -> Result<EventBuilder, Error>

Create a profile badges event

https://github.com/nostr-protocol/nips/blob/master/58.md

pub fn file_metadata<S>(description: S, metadata: FileMetadata) -> EventBuilderwhere S: Into<String>,

File metadata

https://github.com/nostr-protocol/nips/blob/master/94.md

pub fn http_auth(data: HttpData) -> EventBuilder

HTTP Auth

https://github.com/nostr-protocol/nips/blob/master/98.md

Trait Implementations

impl Clone for EventBuilder

fn clone(&self) -> EventBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq<EventBuilder> for EventBuilder

fn eq(&self, other: &EventBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EventBuilder

impl StructuralEq for EventBuilder

impl StructuralPartialEq for EventBuilder