[ Add ] exposed the tlc module

anasfik · Aug 9, 2023 · 46ff665 · 46ff665
1 parent 03e3024
commit 46ff665
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/lib/nostr/dart_nostr.dart b/lib/nostr/dart_nostr.dart
@@ -4,6 +4,7 @@ import 'package:dart_nostr/nostr/instance/relays/relays.dart';
 import 'base/nostr.dart';
 import 'core/utils.dart';
 import 'instance/keys/keys.dart';
+import 'instance/tlv/tlv_utils.dart';
 import 'instance/utils/utils.dart';
 
 /// {@template nostr_service}
@@ -39,4 +40,7 @@ class Nostr implements NostrServiceBase {
 
   /// {@macro nostr_utils}
   final utilsService = NostrUtils();
+
+  /// {@macro nostr_tlv}
+  final tlv = NostrTLV();
 }
diff --git a/lib/nostr/instance/relays/relays.dart b/lib/nostr/instance/relays/relays.dart
@@ -25,10 +25,12 @@ class NostrRelays implements NostrRelaysBase {
   /// This is the controller which will receive all notices from all relays.
   final _noticeStreamController = StreamController<NostrNotice>.broadcast();
 
+  /// Represents a registry of all relays that you did registered with the [init] method.
   @override
   Map<String, WebSocket> get relaysWebSocketsRegistry =>
       NostrRegistry.relaysWebSocketsRegistry;
 
+  /// Represents a registry of all events you received from all relays so far.
   @override
   Map<NostrEventKey, NostrEvent> get eventsRegistry =>
       NostrRegistry.eventsRegistry;

diff --git a/lib/nostr/instance/tlv/tlv_utils.dart b/lib/nostr/instance/tlv/tlv_utils.dart
@@ -3,6 +3,9 @@ import 'package:dart_nostr/nostr/model/tlv.dart';
 
 import 'base/base.dart';
 
+/// {@template nostr_tlv}
+/// This class is responsible for handling the tlv.
+/// {@endtemplate}
 class NostrTLV implements TLVBase {
   /// Decode list bytes to list tlv model
   @override