Expose remove relay methods for Client

Author: yukibtc

CHANGELOG.md

@@ -42,6 +42,7 @@
 * Expose `UnsignedEvent` ([Yuki Kishimoto])
 * Expose `EventBuilder` ([Yuki Kishimoto])
 * Expose add relay method for `Client` ([Yuki Kishimoto])
+* Expose remove relay methods for `Client` ([Yuki Kishimoto])
 * Expose `Client::send_event_builder` ([Yuki Kishimoto])
 * Expose `Client::automatic_authentication` ([Yuki Kishimoto])
 * Expose `Client::reset` ([Yuki Kishimoto])

lib/src/rust/api/client.dart

@@ -58,11 +58,35 @@ abstract class Client implements RustOpaqueInterface {
   /// Connect to all added relays
   Future<void> connect();
 
+  /// Disconnect and force remove all relays
+  Future<void> forceRemoveAllRelays();
+
+  /// Force remove and disconnect relay
+  ///
+  /// Note: this method will remove the relay, also if it's in use for the gossip model or other service!
+  Future<void> forceRemoveRelay({required String url});
+
   /// Check if signer is configured
   Future<bool> hasSigner();
 
   factory Client() => NostrSdk.instance.api.crateApiClientClientNew();
 
+  /// Disconnect and remove all relays
+  ///
+  /// Some relays used by some services could not be disconnected with this method
+  /// (like the ones used for gossip).
+  /// Use [`Client::force_remove_all_relays`] to remove every relay.
+  Future<void> removeAllRelays();
+
+  /// Remove and disconnect relay
+  ///
+  /// If the relay has [`RelayServiceFlags::GOSSIP`], it will not be removed from the pool and its
+  /// flags will be updated (remove [`RelayServiceFlags::READ`],
+  /// [`RelayServiceFlags::WRITE`] and [`RelayServiceFlags::DISCOVERY`] flags).
+  ///
+  /// To force remove the relay, use [`Client::force_remove_relay`].
+  Future<void> removeRelay({required String url});
+
   /// Reset client
   ///
   /// This method reset the client to simplify the switch to another account.