Flutter未知功能探索插件nostr_tools的使用

Flutter未知功能探索插件nostr_tools的使用

介绍

nostr_tools 是一个Dart包，旨在简化与Nostr协议的交互，并帮助开发Nostr客户端。Nostr是一个去中心化的社交网络协议，允许用户通过中继服务器（relays）发布和接收事件（events）。nostr_tools 提供了生成密钥、创建和验证事件、与中继服务器交互等功能。

使用方法

1. 添加依赖

要使用 nostr_tools，首先需要在 pubspec.yaml 文件中添加依赖：

dependencies:
  nostr_tools: ^latest_version

替换 ^latest_version 为最新的版本号。

2. 生成私钥和公钥

nostr_tools 提供了生成私钥和公钥的功能。以下是一个简单的示例：

import 'package:nostr_tools/nostr_tools.dart';

void main() {
  final keyGenerator = KeyApi();

  // 生成私钥
  final privateKey = keyGenerator.generatePrivateKey();
  print('[+] privateKey: $privateKey');

  // 从私钥生成公钥
  final publicKey = keyGenerator.getPublicKey(privateKey);
  print('[+] publicKey: $publicKey');
}

3. 创建、签名和验证事件

Nostr中的事件是带有签名的消息。nostr_tools 提供了创建、签名和验证事件的功能。以下是一个完整的示例：

import 'package:nostr_tools/nostr_tools.dart';

void main() {
  final keyApi = KeyApi();
  final eventApi = EventApi();

  // 生成私钥和公钥
  final privateKey = keyApi.generatePrivateKey();
  final publicKey = keyApi.getPublicKey(privateKey);

  // 创建事件
  final event = Event(
    kind: 1, // 文本事件
    tags: [], // 标签
    content: 'content', // 事件内容
    created_at: DateTime.now().millisecondsSinceEpoch ~/ 1000, // 创建时间戳
    pubkey: publicKey, // 发布者的公钥
  );

  // 生成事件ID
  event.id = eventApi.getEventHash(event);

  // 签名事件
  event.sig = eventApi.signEvent(event, privateKey);

  // 验证签名
  if (eventApi.verifySignature(event)) {
    print('[+] sig is valid');
  }
}

4. 与单个中继服务器交互

nostr_tools 提供了与Nostr中继服务器交互的功能。以下是一个与单个中继服务器交互的示例：

void main() async {
  // 创建中继API实例
  final relay = RelayApi(relayUrl: 'wss://relay.damus.io');

  // 连接到中继服务器
  final stream = await relay.connect();

  // 监听连接事件
  relay.on((event) {
    if (event == RelayEvent.connect) {
      print('[+] connected to ${relay.relayUrl}');
    } else if (event == RelayEvent.error) {
      print('[!] failed to connect to ${relay.relayUrl}');
    }
  });

  // 订阅事件
  relay.sub([
    Filter(
      kinds: [1], // 只订阅文本事件
      limit: 10, // 最多获取10条事件
      since: DateTime.now().millisecondsSinceEpoch ~/ 1000, // 从当前时间开始
    )
  ]);

  // 监听接收到的事件
  stream.listen((Message message) {
    if (message.type == 'EVENT') {
      Event event = message.message;
      print('[+] Received event: ${event.content}');
    } else if (message.type == 'OK') {
      print('[+] Event Published: ${message.message}');
    }
  });

  // 发布新事件
  final privateKey = 'b2352adb186508e7f617105a6dc070df531f53b56cf8744816fdb838891dc9b7';
  final event = EventApi().finishEvent(
    Event(
      kind: 1,
      tags: [],
      content: 'hello world',
      created_at: DateTime.now().millisecondsSinceEpoch ~/ 1000,
    ),
    privateKey,
  );

  relay.publish(event);
}

5. 与多个中继服务器交互

nostr_tools 支持同时与多个中继服务器交互。以下是一个与多个中继服务器交互的示例：

void main() async {
  // 定义中继服务器列表
  final relaysList = [
    'wss://relay.damus.io',
    'wss://relay.nostr.info',
    'wss://eden.nostr.land',
    'wss://nostr-pub.wellorder.net',
    'wss://nos.lol'
  ];

  // 创建中继池API实例
  final relayPool = RelayPoolApi(relaysList: relaysList);

  // 连接到所有中继服务器
  final stream = await relayPool.connect();

  // 监听连接事件
  relayPool.on((event) {
    if (event == RelayEvent.connect) {
      print('[+] connected to: ${relayPool.connectedRelays}');
    } else if (event == RelayEvent.error) {
      print('[!] failed to connect to: ${relayPool.failedRelays}');
    }
  });

  // 订阅事件
  relayPool.sub([
    Filter(
      kinds: [1], // 只订阅文本事件
      limit: 10, // 最多获取10条事件
      since: DateTime.now().millisecondsSinceEpoch ~/ 1000, // 从当前时间开始
    )
  ]);

  // 监听接收到的事件
  stream.listen((Message message) {
    if (message.type == 'EVENT') {
      Event event = message.message;
      print('[+] Received event: ${event.content}');
    }
  });

  // 发布新事件
  final privateKey = 'ccbe92bd853e3661bace63df5b8338dcbaa2c766e2dbb0b90d45b2dd58efaae4';
  final event = EventApi().finishEvent(
    Event(
      kind: 1,
      tags: [],
      content: 'hello world',
      created_at: DateTime.now().millisecondsSinceEpoch ~/ 1000,
    ),
    privateKey,
  );

  relayPool.publish(event);
}

6. 查询NIP-05地址的个人资料数据

NIP-05 是一种将Nostr公钥与人类可读的标识符关联的标准。nostr_tools 提供了查询NIP-05地址的个人资料数据的功能。以下是一个示例：

void main() async {
  var nip05 = Nip05();
  var profile = await nip05.queryProfile('anipy@aniketambore.github.io');

  print('[+] Pubkey: ${profile?.pubkey}');
  print('[+] Relays: ${profile?.relays}');
}

7. 编码和解码NIP-19代码

NIP-19 是一种用于编码Nostr公钥、私钥和配置文件指针的格式。nostr_tools 提供了编码和解码NIP-19代码的功能。以下是一个示例：

void main() {
  final keyGenerator = KeyApi();
  final nip19 = Nip19();

  // 生成私钥
  final sk = keyGenerator.generatePrivateKey();

  // 编码私钥为nsec格式
  final nsec = nip19.nsecEncode(sk);
  final nsecDecoded = nip19.decode(nsec);
  assert(nsecDecoded['type'] == 'nsec');
  assert(nsecDecoded['data'] == sk);

  // 生成公钥
  final pk = keyGenerator.getPublicKey(sk);

  // 编码公钥为npub格式
  final npub = nip19.npubEncode(pk);
  final npubDecoded = nip19.decode(npub);
  assert(npubDecoded['type'] == 'npub');
  assert(npubDecoded['data'] == pk);

  // 编码配置文件指针为nprofile格式
  final relays = [
    'wss://relay.nostr.example.mydomain.example.com',
    'wss://nostr.banana.com'
  ];
  final nprofile = nip19.nprofileEncode(ProfilePointer(pubkey: pk, relays: relays));
  final nprofileDecode = nip19.decode(nprofile);
  assert(nprofileDecode['type'] == 'nprofile');
  assert(nprofileDecode['data']['pubkey'] == pk);
  assert(nprofileDecode['data']['relays'].length == 2);
}

8. 加密和解密直接消息

nostr_tools 提供了加密和解密直接消息的功能。以下是一个示例：

void main() {
  final keyGenerator = KeyApi();
  final nip04 = Nip04();

  // 生成Alice和Bob的私钥和公钥
  final aliceSK = keyGenerator.generatePrivateKey();
  final alicePK = keyGenerator.getPublicKey(aliceSK);
  final bobSK = keyGenerator.generatePrivateKey();
  final bobPK = keyGenerator.getPublicKey(bobSK);

  // Alice向Bob发送加密消息
  var aliceMessageToBob = 'Hello Bob!';
  var cipherText = nip04.encrypt(aliceSK, bobPK, aliceMessageToBob);
  print('[+] cipherText: $cipherText');

  // Bob解密消息
  var bobDecodingMessage = nip04.decrypt(bobSK, alicePK, cipherText);
  print('[+] plainText: $bobDecodingMessage');
}