Skip to content

Latest commit

 

History

History
594 lines (496 loc) · 32.1 KB

CHANGELOG.md

File metadata and controls

594 lines (496 loc) · 32.1 KB
Raw

Changelog

Unreleased

Summary

Changed

Added

  • pool: add RelayPool::force_remove_relay method (Yuki Kishimoto)
  • zapper: add WebLNZapper struct (moved from nostr-webln crate) (Yuki Kishimoto)

Fixed

Removed

v0.35.0

Summary

Add gossip model support, deprecate SQLite database in favor of LMDB (fork of pocket database), add support to negentropy v1 (old version is still supported!), add MockRelay (a local disposable relay for tests), allow usage of embedded tor client on mobile devices, many improvements, bugs fix and more!

Changed

  • nostr: bump bitcoin to v0.32 (Yuki Kishimoto)
  • nostr: bump base64 to v0.22 (Yuki Kishimoto)
  • nostr: deprecate Event::from_value (Yuki Kishimoto)
  • nostr: deprecate Tag::as_vec (Yuki Kishimoto)
  • nostr: re-write RawRelayMessage parsing (Yuki Kishimoto)
  • nostr: update Event fields (Yuki Kishimoto)
  • nostr: deprecate Event::is_* kind related methods (Yuki Kishimoto)
  • nostr: change TryIntoUrl::Err to Infallible for Url (Yuki Kishimoto)
  • nostr: change Event::verify_id and Event::verify_signature fingerprint (Yuki Kishimoto)
  • nostr: impl custom Debug, PartialEq and Eq for Keys (Yuki Kishimoto)
  • nostr: impl PartialOrd, Ord and Hash for Keys (Yuki Kishimoto)
  • nostr: change Keys::secret_key and Keys::sign_schnorr methods fingerprint (Yuki Kishimoto)
  • nostr: deprecate Keys::generate_without_keypair (Yuki Kishimoto)
  • nostr: change NIP-26 functions fingerprint (Yuki Kishimoto)
  • nostr: improve NostrWalletConnectURI parsing (Yuki Kishimoto)
  • nostr: update EventBuilder::job_feedback method fingerprint (Yuki Kishimoto)
  • nostr: deprecate EventBuilder::to_pow_event (Yuki Kishimoto)
  • nostr: impl Display for MachineReadablePrefix (Yuki Kishimoto)
  • nostr: improve Keys docs (Yuki Kishimoto)
  • nostr: change visibility of public_key field in Keys struct (Yuki Kishimoto)
  • nostr: deprecate Keys::public_key_ref (Yuki Kishimoto)
  • nostr: use OsRng instead of ThreadRng for SECP256K1 global context and schnorr signing (Yuki Kishimoto)
  • nostr: improve Timestamp::to_human_datetime performance (Yuki Kishimoto)
  • nostr: deprecate EventId::owned (Yuki Kishimoto)
  • nostr: convert EventId::all_zeroes to const function (Yuki Kishimoto)
  • nostr: convert Timestamp::from_secs to const function (Yuki Kishimoto)
  • nostr: deprecate Kind::as_u32 and Kind::as_u64 (Yuki Kishimoto)
  • database: update NostrDatabase supertraits (Yuki Kishimoto)
  • database: impl Clone for MemoryDatabase (Yuki Kishimoto)
  • database: update NostrDatabase::event_by_id fingerprint (Yuki Kishimoto)
  • relay-builder: bump tokio-tungstenite to v0.24 (Yuki Kishimoto)
  • pool: bump async-wsocket to v0.8 (Yuki Kishimoto)
  • pool: avoid unnecessary Url and Relay clone in RelayPool methods (Yuki Kishimoto)
  • pool: avoid Relay clone in RelayPool::connect_relay method (Yuki Kishimoto)
  • pool: RelayPool::send_event and RelayPool::batch_event send only to relays with WRITE flag (Yuki Kishimoto)
  • pool: RelayPool::subscribe_with_id, RelayPool::get_events_of and RelayPool::stream_events_of REQ events only to relays with READ flag (Yuki Kishimoto)
  • pool: bump async-wsocket to v0.9 (Yuki Kishimoto)
  • pool: improve Relay::support_negentropy method (Yuki Kishimoto)
  • pool: change handle relay message log level from error to warn (Yuki Kishimoto)
  • signer: update NIP-04 and NIP-44 methods signature (Yuki Kishimoto)
  • webln: bump webln to v0.3 (Yuki Kishimoto)
  • sqlite: deprecate SQLiteDatabase in favor of LMDB (Yuki Kishimoto)
  • sdk: bump lnurl-pay to v0.6 (Yuki Kishimoto)
  • sdk: update Client::gift_wrap and Client::gift_wrap_to methods signature (Yuki Kishimoto)
  • sdk: document and rename Client::metadata to Client::fetch_metadata ([Janek])
  • sdk: update Client::shutdown method fingerprint (Yuki Kishimoto)
  • sdk: deprecate Client::add_relay_with_opts and Client::add_relays (Yuki Kishimoto)
  • sdk: deprecate RelayPool::send_msg and RelayPool::batch_msg (Yuki Kishimoto)
  • sdk: inherit pool subscriptions only when calling Client::add_relay or Client::add_read_relay methods (Yuki Kishimoto)
  • ffi(nostr): impl Display for Coordinate (Yuki Kishimoto)
  • ffi(sdk): change Connection::embedded_tor fingerprint for android and ios targets (Yuki Kishimoto)
  • cli: rename open command to shell (Yuki Kishimoto)
  • cli: rename serve-signer command to bunker (Yuki Kishimoto)

Added

Fixed

Removed

v0.34.0

Summary

Add embedded tor client support, allow to open databases with a limited capacity (automatically discard old events when max capacity is reached), add Client::stream_events_of as alternative method to Client::get_events_of (stream events instead of waiting for EOSE and collect into a list), add search capability (NIP-50) support to Filter::match_event and databases, add NIP-31 and NIP-70 support, add option to autoconnect relay on Client::add_relay method call (currently disabled by default), rework the get_events_of methods behaviour for better consistency (RelayPool::get_events_of and Relay::get_events_of get events only from remote relay/s while Client::get_events_of allow to choose the source of events: database, relays or both), bugs fix and more!

Changed

  • Bump MSRV to v1.70.0 (Yuki Kishimoto)
  • Bump toolchain channel to 1.80.1 (Yuki Kishimoto)
  • nostr: deprecate Event::author_ref and Event::iter_tags (Yuki Kishimoto)
  • nostr: calculate EventId in EventBuilder::to_unsigned_event_with_supplier (Yuki Kishimoto)
  • nostr: ensure that NIP-59 rumor has EventId (Yuki Kishimoto)
  • nostr: update PartialEvent methods (Yuki Kishimoto)
  • nostr: change EventBuilder::award_badge fingerprint (Yuki Kishimoto)
  • nostr: add NIP-50 support to Filter::match_event method (Yuki Kishimoto)
  • nostr: remove Arc<T> from OnceCell<T> in Event and Tag (Yuki Kishimoto)
  • nostr: move sig field from PartialEvent to MissingPartialEvent (Yuki Kishimoto)
  • nostr: better Debug trait impl for EventId, PublicKey and Tag (Yuki Kishimoto)
  • nostr: improve SubscriptionId::generate_with_rng (Yuki Kishimoto)
  • pool: take mutex ownership instead of clone in InternalRelayPool::get_events_from (Yuki Kishimoto)
  • pool: remove IDs collection from InternalRelayPool::get_events_from (Yuki Kishimoto)
  • pool: better checks before perform queries or send messages to relays (Yuki Kishimoto)
  • pool: bump async-wsocket to v0.7 (Yuki Kishimoto)
  • pool: get events only from remote relay when calling get_events_of or get_events_from (Yuki Kishimoto)
  • database: avoid to copy EventId in Event::decode (Yuki Kishimoto)
  • database: use Vec instead of BTreeSet as inner value for TagIndexValues (Yuki Kishimoto)
  • database: rework DatabaseIndexes and rename to DatabaseHelper (Yuki Kishimoto)
  • database: allow to set max capacity to DatabaseHelper (Yuki Kishimoto)
  • database: speedup helper bulk load (Yuki Kishimoto)
  • database: set a default logic for NostrDatabase::negentropy_items (Yuki Kishimoto)
  • sdk: rename Proxy and ProxyTarget to Connection and ConnectionTarget (Yuki Kishimoto)
  • sdk: allow to skip slow relays (Yuki Kishimoto)
  • sdk: allow to specify the source of events for Client::get_events_of method (Yuki Kishimoto)
  • sdk: deprecate Client::get_events_of_with_opts (Yuki Kishimoto)
  • sqlite: use ValueRef instead of owned one (Yuki Kishimoto)
  • cli: improve sync command (Yuki Kishimoto)
  • cli: allow to specify relays in open command (Yuki Kishimoto)

Added

Fixed

  • pool: fix Event notification variant sent also for events sent by the SDK (Yuki Kishimoto)
  • database: fix indexes QueryPattern (Yuki Kishimoto)
  • database: fix query issue due to wrong tag value order (Yuki Kishimoto)

Removed

v0.33.0

Summary

Better outputs for send/batch/reconcile methods (ex. you can now easily know where a message/event is successfully published and where/why failed), allow to change NIP-42 option after client initialization, increase max stack size for JS bindings to prevent "memory access out of bounds" error, expose more objects/methods for JS bindings, dry run option for negentropy reconciliation, get NIP-46 relay from NIP-05 profile, bug fixes (NIP-42 auth not works correctly, NIP-46 "ACK" message not handled, ...) and more!

Changed

  • Bump uniffi to v0.28.0 (Yuki Kishimoto)
  • nostr: rename NIP-51 EventBuilder set constructors and Kind variants (Yuki Kishimoto)
  • nostr: small adj. to NIP-47 ListTransactionsRequestParams and LookupInvoiceResponseResult structs (Yuki Kishimoto)
  • nostr: add identifier arg to NIP-51 EventBuilder set constructors (Yuki Kishimoto)
  • nostr: change nip65::extract_relay_list fingerprint (Yuki Kishimoto)
  • nostr: avoid allocation where possible in NIP-05 module (Yuki Kishimoto)
  • nostr: get NIP-46 relays from NIP-05 address (DanConwayDev)
  • nostr: deprecate EventBuilder::encrypted_direct_msg (Yuki Kishimoto)
  • pool: use per-purpose dedicated relay channels (Yuki Kishimoto)
  • pool: return relay urls to which messages/events have or not been sent for send_* and batch_* methods (Yuki Kishimoto)
  • pool: return relay urls to which subscription have or not been success for subscribe* methods (Yuki Kishimoto)
  • pool: rename Relay::terminate to Relay::disconnect (Yuki Kishimoto)
  • pool: always send RelayPoolNotification::Message variant (Yuki Kishimoto)
  • pool: return report for negentropy reconciliation (Yuki Kishimoto)
  • signer: use limit(0) instead of since for Nip46Signer subscription filter (Yuki Kishimoto)
  • signer: deprecate NostrConnectRemoteSigner::nostr_connect_uri and Nip46Signer::nostr_connect_uri (Yuki Kishimoto)
  • sdk: allow to change auto authentication to relays option (NIP-42) after client initialization (Yuki Kishimoto)
  • sdk: retrieve contact list public keys only from the latest events (Xiao Yu)
  • sdk: re-subscribe closed subscriptions after NIP-42 authentication (Yuki Kishimoto)
  • bindings(nostr): allow to specify coordinates in EventBuilder::delete constructor (Yuki Kishimoto)
  • ffi(sdk): convert RelayPool::handle_notifications method to async/future (Yuki Kishimoto)
  • js: increase max stack size to 0x1E84800 bytes (32 MiB) (Yuki Kishimoto)
  • js(nostr): adj. method names to camelcase format (Yuki Kishimoto)

Added

Fixed

  • nostr: fix NIP-47 list_transactions response deserialization (Yuki Kishimoto and lnbc1QWFyb24)
  • pool: fix shutdown notification sent to external channel on Relay::terminate method call (Yuki Kishimoto)
  • pool: fix RelayPool::reconcile_advanced method uses database items instead of the passed ones (Yuki Kishimoto)
  • signer: add missing NIP-46 connect "ACK" message handling (Yuki Kishimoto)
  • sdk: fix NIP-42 client authentication (Yuki Kishimoto)
  • js: fix "RuntimeError: memory access out of bounds" WASM error (Yuki Kishimoto)

Removed

v0.32.0

Summary

Added async/future support to Python, Kotlin and Swift, added automatic authentication to relays (NIP-42, can be deactivated in client options), improvements to relay limits, many bug fixes (relays not auto reconnect, wrong query order for SQLite, tokio panic when using SQLite database in bindings) and more!

Note for kotlin devs: from this release the packages will be published at org.rust-nostr instead of io.github.rust-nostr.

Changed

Added

Fixed

  • nostr: fix re-serialization of events that contains unknown keys during deserialization (Yuki Kishimoto)
  • nostr: fix Nip21::to_nostr_uri serialization (Yuki Kishimoto)
  • pool: fix relay doesn't auto reconnect in certain cases (Yuki Kishimoto)
  • nostr: add missing TagStandard::PublicKeyLiveEvent variant to Event::public_keys (Yuki Kishimoto)
  • sqlite: fix SQLite database panics when used outside the client context in bindings (Yuki Kishimoto)
  • sqlite: fix wrong event order when querying (Yuki Kishimoto)

Removed

  • nostr: remove verify_blocking and get_profile_blocking functions (Yuki Kishimoto)
  • nostr: remove RelayInformationDocument::get_blocking (Yuki Kishimoto)
  • nostr: remove blocking feature (Yuki Kishimoto)
  • sqlite: removed deadpool-sqlite dep (Yuki Kishimoto)
  • ffi(nostr): remove Keys::from_mnemonic_with_account and Keys::from_mnemonic_advanced (Yuki Kishimoto)

v0.31.0

Summary

Reworked Tag, added TagStandard enum, simplified the way to subscribe and/or reconcile to subset of relays (respectively, client.subscribe_to and client.reconcile_with), added blacklist support to mute public keys or event IDs, removed zap split from client.zap method, many improvements and more!

Changed

Added

Fixed

Removed

v0.30.0

Summary

Adapted NIP46 to last changes, added NostrConnectRemoteSigner to easily build remote signers (just construct it and call serve method), improved proxy options (allow to specify the proxy target: all relays or only .onion ones), improvements to NWC client, fixed equality operator for bindings (Python, Kotlin and Swift), added nostrdb storage backend, added NIP32 and completed NIP51 support and more!

Changed

Added

Fixed

Removed

v0.29.4

  • pool: fix InternalRelay::get_events_of_with_callback timeout (Yuki Kishimoto)

v0.29.3

  • pool: check filter limit in InternalRelayPool::get_events_from (Yuki Kishimoto)

v0.29.2

Fixed

v0.29.1

Fixed

  • nostr: fix deserialization issues for events with non-standard k and x tags (Yuki Kishimoto)
  • pool: fix spurious send_event timeout error (DanConwayDev in #375)