Flutter IPFS交互插件dart_ipfs的使用

欢迎来到Flutter中使用dart_ipfs插件与IPFS网络进行交互的指南！本项目旨在提供一个健壮且生产就绪的服务器，利用Dart实现与IPFS网络的无缝集成。

🚀 功能

🌐 核心IPFS功能

• 🔗 使用CIDv0和CIDv1支持的内容寻址
• 🌲 支持HAMT和trickle-dag的Merkle DAG
• 📦 支持可插拔数据存储块存储
• 📁 使用UnixFS处理目录

📡 网络和通信

• 👥 基于libp2p的P2P通信，使用p2plib
• 🌍 配置参数可调的Kademlia DHT
• 🖥️ 基于主题的消息传递的PubSub
• 🔄 NAT穿越的电路中继

🧭 内容路由

• 🎯 基于DHT的内容路由及回退策略
• 🖇️ DNSLink解析并缓存
• 🔍 提供商记录管理

📋 数据管理

• ⏳ 配置后端的持久存储
• 🛠️ 支持多种编解码器的IPLD
• 📡 图形同步协议实现
• 🗂️ CAR导入导出功能

🔒 安全

• 🔐 自定义安全配置的TLS
• 🔑 IPNS密钥管理和签名
• 🛡️ 输入验证和清理
• 📏 可配置的配额管理

📈 监控和管理

• 📊 与Prometheus兼容的指标
• 📝 日志级别结构化日志记录
• 🛠️ 全面的节点管理API

🏗 架构

服务器遵循模块化架构，职责分离明确。核心组件包括：

核心组件

// 示例节点初始化
final node = await IPFS.create(config);
await node.start();

关键组件包括：

• IPFSNode：管理所有子系统的中央协调器
• DHTHandler：实现Kademlia DHT协议
• BitswapHandler：处理块交换协议
• PubSubHandler：管理发布/订阅消息
• NetworkHandler：协调P2P通信
• DatastoreHandler：管理持久存储

数据结构

系统使用几个关键的数据结构：

• CID：带多哈希支持的内容标识符
• Block：带有CID关联的原始数据
• MerkleDAGNode：带链接的DAG节点
• UnixFSNode：文件系统表示

配置

系统高度可配置：

final config = IPFSConfig(
  enableDHT: true,
  enablePubSub: true,
  maxConnections: 100,
  datastorePath: './ipfs_data'
);

🛠 开始使用

1. 添加依赖

在pubspec.yaml文件中添加以下依赖项：

dependencies:
  dart_ipfs: 1.0.0

2. 基本用法

import 'package:dart_ipfs/dart_ipfs.dart';

void main() async {
  final node = await IPFS.create();
  await node.start();

  // 添加文件内容
  final cid = await node.addFile(Uint8List.fromList(utf8.encode('Hello IPFS!')));
  print('Added file with CID: $cid');

  // 获取文件内容
  final data = await node.get(cid);
  print('Content: ${utf8.decode(data!)}');

  await node.stop();
}

🤝 贡献

欢迎贡献！请先阅读我们的贡献指南。

1. 分叉仓库
2. 创建功能分支：git checkout -b feature/amazing-feature
3. 提交更改：git commit -m 'Add amazing feature'
4. 推送到分支：git push origin feature/amazing-feature
5. 打开Pull Request

📜 许可证

本项目采用MIT许可证 - 详情请参阅LICENSE文件。

示例代码

main.dart

// ipfs/example/main.dart

import 'dart:convert';
import 'dart:typed_data';

import 'package:dart_ipfs/dart_ipfs.dart';

void main() async {
  final config = IPFSConfig(
    debug: true,
    verboseLogging: true,
    // ... 其他配置选项 ...
  );

  print('Creating IPFS node with debug logging enabled...');
  final ipfs = await IPFS.create(config: config);

  print('Starting IPFS node...');
  await ipfs.start();

  // 1. 添加文件
  // 将字符串转换为字节并添加到IPFS，接收CID（内容标识符）
  final cid =
      await ipfs.addFile(Uint8List.fromList(utf8.encode('Hello IPFS!')));
  print('Added file with CID: $cid');

  // 2. 获取文件内容
  // 使用CID获取之前添加的数据
  final data = await ipfs.get(cid);
  print('File content: ${utf8.decode(data!)}');

  // 3. 固定文件
  // 确保文件不会在垃圾回收时被删除
  await ipfs.pin(cid);
  print('Pinned CID: $cid');

  // --- Bitswap交互 ---
  // 在IPFS网络内共享和检索块的交互

  // 4. 查找CID的提供者
  // 识别拥有指定CID内容副本的对等方
  final providers = await ipfs.findProviders(cid);
  print('Providers for CID $cid: $providers');

  // 5. 向提供者请求块（如果有的话）
  // 尝试从已知提供者之一检索块
  if (providers.isNotEmpty) {
    final providerPeerId =
        providers.first; // 选择第一个可用的提供者
    try {
      await ipfs.requestBlock(cid, providerPeerId);
      print('Requested block $cid from peer $providerPeerId');
    } catch (e) {
      print('Error requesting block: $e');
    }
  }

  // 6. 从目录检索文件
  // 使用给定目录CID访问特定文件
  final directoryContent = {
    'myFolder/file1.txt': Uint8List.fromList(utf8.encode('Content of file1')),
    'myFolder/file2.txt': Uint8List.fromList(utf8.encode('Content of file2')),
  };
  final dirCid = await ipfs.addDirectory(directoryContent);
  print('Added directory with CID: $dirCid');

  // 现在，使用dirCid检索file2.txt
  final file2Data = await ipfs.get(dirCid, path: 'myFolder/file2.txt');
  if (file2Data != null) {
    print('Retrieved file2.txt content: ${utf8.decode(file2Data)}');
  } else {
    print('Failed to retrieve file2.txt content.');
  }

  // 7. 解析IPNS名称
  // 将IPNS名称转换为其当前CID映射
  try {
    final resolvedCid = await ipfs
        .resolveIPNS('your-ipns-name'); // 替换为实际的IPNS名称
    print('Resolved IPNS name to CID: $resolvedCid');
  } catch (e) {
    print('Failed to resolve IPNS name: $e');
  }

  // 8. 发布IPNS记录（如果你已经实现了密钥管理）
  // 更新IPNS名称以指向新CID
  try {
    await ipfs.publishIPNS(cid, keyName: 'my-key');
    print('Published IPNS record for CID: $cid');
  } catch (e) {
    print('Failed to publish IPNS record: $e');
  }

  // 9. 订阅PubSub主题
  // 加入PubSub主题以在网络中接收和发送消息
  try {
    await ipfs.subscribe('some_topic');
    print('Subscribed to topic: some_topic');

    // 监听已订阅主题上的新消息
    ipfs.onNewContent.listen((cid) {
      print('Received new content notification: $cid');
    });
  } catch (e) {
    print('Failed to subscribe to topic: $e');
  }

  // 10. 获取节点统计信息
  // 获取有关节点性能和使用的统计数据
  final stats = await ipfs.stats();
  print('Node stats: $stats');

  // 11. 停止节点
  // 平稳关闭IPFS节点
  await ipfs.stop();
}