sdk: add Client::sync and Client::sync_with methods

* Deprecate `Client::reconcile` and `Client::reconcile_with`

Signed-off-by: Yuki Kishimoto <[email protected]>

CHANGELOG.md

@@ -41,6 +41,7 @@
 * sdk: deprecate `Client::get_events_of` and `Client::get_events_from` methods ([Yuki Kishimoto])
 * sdk: use `Events` instead of `Vec<Event>` in fetch and query methods ([Yuki Kishimoto])
 * sdk: rename `stream_events_of` to `stream_events` ([Yuki Kishimoto])
+* sdk: deprecate `Client::reconcile` and `Client::reconcile_with` ([Yuki Kishimoto])
 * signer: auto enable `nip44` feature if `nip59` is enabled ([Yuki Kishimoto])
 * database: improve `BTreeCappedSet` ([Yuki Kishimoto])
 * database: not save invalid event deletion ([Yuki Kishimoto])
@@ -76,10 +77,11 @@
 * relay-builder: handle ephemeral events ([Yuki Kishimoto])
 * pool: add `RelayPool::force_remove_relay` method ([Yuki Kishimoto])
 * pool: add `RelayFiltering::overwrite_public_keys` method ([Yuki Kishimoto])
-* pool: add `RelayPool::reconcile_targeted` ([Yuki Kishimoto])
+* pool: add `RelayPool::sync_targeted` ([Yuki Kishimoto])
 * pool: add `Relay::reconcile_multi` ([Yuki Kishimoto])
 * sdk: add `Client::fetch_events` and `Client::fetch_events_from` methods ([Yuki Kishimoto])
-* sdk: add gossip support to `Client::reconcile` ([Yuki Kishimoto])
+* sdk: add `Client::sync` and `Client::sync_with` methods ([Yuki Kishimoto])
+* sdk: add gossip support to `Client::sync` ([Yuki Kishimoto])
 * signer: add `NostrSigner::gift_wrap` ([Yuki Kishimoto])
 * zapper: add `WebLNZapper` struct (moved from `nostr-webln` crate) ([Yuki Kishimoto])
 * ffi(nostr): add `tag_kind_to_string` func ([Yuki Kishimoto])

bindings/nostr-sdk-ffi/bindings-python/examples/custom-database.py

@@ -75,7 +75,7 @@ async def wipe(self):
     # Negentropy reconciliation
     f = Filter().author(keys.public_key())
     opts = NegentropyOptions()
-    await client.reconcile(f, opts)
+    await client.sync(f, opts)
 
     # Query events from database
     f = Filter().author(keys.public_key()).limit(10)

bindings/nostr-sdk-ffi/bindings-python/examples/database.py

@@ -24,7 +24,7 @@ async def main():
     # Negentropy reconciliation
     f = Filter().author(keys.public_key())
     opts = NegentropyOptions()
-    await client.reconcile(f, opts)
+    await client.sync(f, opts)
 
     # Query events from database
     f = Filter().author(keys.public_key()).limit(10)

bindings/nostr-sdk-ffi/src/client/mod.rs

@@ -339,6 +339,24 @@ impl Client {
         self.inner.unsubscribe_all().await
     }
 
+    /// Sync events with relays (negentropy reconciliation)
+    ///
+    /// If `gossip` is enabled (see `Options`) the events will be reconciled also with
+    /// NIP65 relays (automatically discovered) of public keys included in filters (if any).
+    ///
+    /// <https://github.com/hoytech/negentropy>
+    pub async fn sync(
+        &self,
+        filter: Arc<Filter>,
+        opts: Arc<NegentropyOptions>,
+    ) -> Result<ReconciliationOutput> {
+        Ok(self
+            .inner
+            .sync(filter.as_ref().deref().clone(), **opts)
+            .await?
+            .into())
+    }
+
     /// Fetch events from relays
     ///
     /// If `gossip` is enabled (see `Options`) the events will be requested also to
@@ -621,24 +639,6 @@ impl Client {
             .into())
     }
 
-    /// Negentropy reconciliation
-    ///
-    /// If `gossip` is enabled (see `Options`) the events will be reconciled also with
-    /// NIP65 relays (automatically discovered) of public keys included in filters (if any).
-    ///
-    /// <https://github.com/hoytech/negentropy>
-    pub async fn reconcile(
-        &self,
-        filter: Arc<Filter>,
-        opts: Arc<NegentropyOptions>,
-    ) -> Result<ReconciliationOutput> {
-        Ok(self
-            .inner
-            .reconcile(filter.as_ref().deref().clone(), **opts)
-            .await?
-            .into())
-    }
-
     /// Handle notifications
     pub async fn handle_notifications(&self, handler: Arc<dyn HandleNotification>) -> Result<()> {
         Ok(self

bindings/nostr-sdk-ffi/src/pool/mod.rs

@@ -376,17 +376,15 @@ impl RelayPool {
             .into())
     }
 
-    /// Negentropy reconciliation
-    ///
-    /// Use events stored in database
-    pub async fn reconcile(
+    /// Sync events with relays (negentropy reconciliation)
+    pub async fn sync(
         &self,
         filter: &Filter,
         opts: &NegentropyOptions,
     ) -> Result<ReconciliationOutput> {
         Ok(self
             .inner
-            .reconcile(filter.deref().clone(), **opts)
+            .sync(filter.deref().clone(), **opts)
             .await?
             .into())
     }

bindings/nostr-sdk-ffi/src/relay/mod.rs

@@ -354,23 +354,17 @@ impl Relay {
         Ok(self.inner.count_events(filters, timeout).await? as u64)
     }
 
-    /// Negentropy reconciliation
-    ///
-    /// Use events stored in database
-    pub async fn reconcile(
-        &self,
-        filter: &Filter,
-        opts: &NegentropyOptions,
-    ) -> Result<Reconciliation> {
+    /// Sync events with relays (negentropy reconciliation)
+    pub async fn sync(&self, filter: &Filter, opts: &NegentropyOptions) -> Result<Reconciliation> {
         Ok(self
             .inner
-            .reconcile(filter.deref().clone(), **opts)
+            .sync(filter.deref().clone(), **opts)
             .await?
             .into())
     }
 
-    /// Negentropy reconciliation with custom items
-    pub async fn reconcile_with_items(
+    /// Sync events with relays (negentropy reconciliation)
+    pub async fn sync_with_items(
         &self,
         filter: &Filter,
         items: Vec<NegentropyItem>,
@@ -382,7 +376,7 @@ impl Relay {
             .collect();
         Ok(self
             .inner
-            .reconcile_with_items(filter.deref().clone(), items, **opts)
+            .sync_with_items(filter.deref().clone(), items, **opts)
             .await?
             .into())
     }

bindings/nostr-sdk-js/examples/negentropy.js

@@ -17,7 +17,7 @@ async function main() {
     let direction = NegentropyDirection.Down;
     let opts = new NegentropyOptions().direction(direction);
     let filter = new Filter().kind(1).limit(1000);
-    await client.reconcile(filter, opts);
+    await client.sync(filter, opts);
 }
 
 main();

bindings/nostr-sdk-js/examples/webapp/src/App.js

@@ -52,7 +52,7 @@ class App extends Component {
     try {
       let filter = new Filter().author(this.state.public_key);
       let opts = new NegentropyOptions();
-      await this.state.client.reconcile(filter, opts);
+      await this.state.client.sync(filter, opts);
     } catch (error) {
         console.log(error) 
     }

bindings/nostr-sdk-js/src/client/mod.rs

@@ -332,6 +332,24 @@ impl JsClient {
         self.inner.unsubscribe_all().await;
     }
 
+    /// Sync events with relays (negentropy reconciliation)
+    ///
+    /// If `gossip` is enabled (see `Options`) the events will be reconciled also with
+    /// NIP65 relays (automatically discovered) of public keys included in filters (if any).
+    ///
+    /// <https://github.com/hoytech/negentropy>
+    pub async fn sync(
+        &self,
+        filter: &JsFilter,
+        opts: &JsNegentropyOptions,
+    ) -> Result<JsReconciliationOutput> {
+        self.inner
+            .sync(filter.deref().clone(), **opts)
+            .await
+            .map_err(into_err)
+            .map(|o| o.into())
+    }
+
     /// Fetch events from relays
     ///
     /// If `gossip` is enabled (see `Options`) the events will be requested also to
@@ -755,24 +773,6 @@ impl JsClient {
             .into())
     }
 
-    /// Negentropy reconciliation
-    ///
-    /// If `gossip` is enabled (see `Options`) the events will be reconciled also with
-    /// NIP65 relays (automatically discovered) of public keys included in filters (if any).
-    ///
-    /// <https://github.com/hoytech/negentropy>
-    pub async fn reconcile(
-        &self,
-        filter: &JsFilter,
-        opts: &JsNegentropyOptions,
-    ) -> Result<JsReconciliationOutput> {
-        self.inner
-            .reconcile(filter.deref().clone(), **opts)
-            .await
-            .map_err(into_err)
-            .map(|o| o.into())
-    }
-
     /// Handle notifications
     ///
     /// **This method spawn a thread**, so ensure to keep up the app after calling this (if needed).

bindings/nostr-sdk-js/src/pool/mod.rs

@@ -418,13 +418,13 @@ impl JsRelayPool {
     /// Negentropy reconciliation
     ///
     /// Use events stored in database
-    pub async fn reconcile(
+    pub async fn sync(
         &self,
         filter: &JsFilter,
         opts: &JsNegentropyOptions,
     ) -> Result<JsReconciliationOutput> {
         self.inner
-            .reconcile(filter.deref().clone(), **opts)
+            .sync(filter.deref().clone(), **opts)
             .await
             .map_err(into_err)
             .map(|o| o.into())

bindings/nostr-sdk-js/src/relay/mod.rs

@@ -300,13 +300,13 @@ impl JsRelay {
     /// Use events stored in database
     ///
     /// <https://github.com/hoytech/negentropy>
-    pub async fn reconcile(
+    pub async fn sync(
         &self,
         filter: &JsFilter,
         opts: &JsNegentropyOptions,
     ) -> Result<JsReconciliation> {
         self.inner
-            .reconcile(filter.deref().clone(), **opts)
+            .sync(filter.deref().clone(), **opts)
             .await
             .map_err(into_err)
             .map(|o| o.into())

crates/nostr-cli/src/main.rs

@@ -188,7 +188,7 @@ async fn handle_command(command: ShellCommand, client: &Client) -> Result<()> {
 
             // Dry run
             let output: Output<Reconciliation> = client
-                .reconcile_with(list.iter(), filter.clone(), opts.dry_run())
+                .sync_with(list.iter(), filter.clone(), opts.dry_run())
                 .await?;
 
             println!(
@@ -198,7 +198,7 @@ async fn handle_command(command: ShellCommand, client: &Client) -> Result<()> {
             );
 
             // Reconcile
-            let output: Output<Reconciliation> = client.reconcile_with(list, filter, opts).await?;
+            let output: Output<Reconciliation> = client.sync_with(list, filter, opts).await?;
 
             println!("Reconciliation terminated:");
             println!("- Sent {} events", output.sent.len());