Flutter通信协议插件xmtp_proto的使用

在本教程中，我们将展示如何在Flutter项目中使用xmtp_proto插件。该插件提供了基于XTPM协议的通信功能。

xmtp_proto简介

xmtp_proto 是一个用于实现XTPM协议的插件，它包含以下内容：

• 协议概述文件 <a href="https://github.com/xmtp/proto/blob/main/PROTOCOL.md" rel="ugc">PROTOCOL.md</a>。
• 协议中所有元素的protobuf定义 <a href="https://github.com/xmtp/proto/blob/main/proto" rel="ugc">/proto</a>。
• 从protobuf定义生成的代码 <a href="https://github.com/xmtp/proto/blob/main/go" rel="ugc">go/</a>。

注意：生成的typescript代码未提交到此仓库，而是动态生成并在发布到npm时使用 <a href="https://www.npmjs.com/package/@xmtp/proto" rel="ugc">proto包</a>。

概述文件和protobuf文件共同构成了协议的定义。概述文件依赖于protobuf文件，并作为查找相关内容的指南。

在Flutter项目中使用xmtp_proto

1. 添加依赖

首先，在pubspec.yaml文件中添加xmtp_proto依赖：

dependencies:
  xmtp_proto: ^0.1.0

然后运行以下命令安装依赖：

flutter pub get

2. 初始化客户端

创建一个新的Flutter项目并初始化xmtp客户端。以下是初始化的示例代码：

import 'package:xmtp_proto/xmtp_proto.dart';

void main() {
  // 初始化XMTP客户端
  final client = XmtpClient(
    walletAddress: "your_wallet_address",
    privateKey: "your_private_key",
  );

  // 连接到XMTP网络
  client.connect().then((_) {
    print("Connected to XMTP network");
  }).catchError((error) {
    print("Failed to connect: $error");
  });
}

3. 发送消息

使用sendMessage方法发送消息：

Future<void> sendMessage(String recipientAddress, String messageText) async {
  try {
    // 创建消息
    final message = Message(
      content: messageText,
      sender: "your_wallet_address",
      recipient: recipientAddress,
    );

    // 发送消息
    await client.sendMessage(message);

    print("Message sent successfully");
  } catch (error) {
    print("Failed to send message: $error");
  }
}

4. 接收消息

使用listenForMessages方法监听新消息：

void listenForMessages() {
  client.listenForMessages().listen((message) {
    print("Received message: ${message.content}");
  }).onError((error) {
    print("Error while listening for messages: $error");
  });
}

5. 关闭客户端

在应用程序退出时关闭客户端连接：

void closeClient() {
  client.disconnect().then((_) {
    print("Disconnected from XMTP network");
  }).catchError((error) {
    print("Failed to disconnect: $error");
  });
}

完整示例代码

以下是完整的示例代码，展示了如何初始化客户端、发送消息和接收消息：

import 'package:flutter/material.dart';
import 'package:xmtp_proto/xmtp_proto.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('XMTP Example')),
        body: Center(child: Text('XMTP Client Running')),
      ),
    );
  }
}

class XmtpExample extends StatefulWidget {
  [@override](/user/override)
  _XmtpExampleState createState() => _XmtpExampleState();
}

class _XmtpExampleState extends State<XmtpExample> {
  final XmtpClient client = XmtpClient(
    walletAddress: "your_wallet_address",
    privateKey: "your_private_key",
  );

  [@override](/user/override)
  void initState() {
    super.initState();
    initializeClient();
  }

  Future<void> initializeClient() async {
    await client.connect();
    print("Connected to XMTP network");

    // 监听消息
    client.listenForMessages().listen((message) {
      print("Received message: ${message.content}");
    }).onError((error) {
      print("Error while listening for messages: $error");
    });

    // 发送消息
    sendMessage("recipient_wallet_address", "Hello from Flutter!");
  }

  Future<void> sendMessage(String recipientAddress, String messageText) async {
    try {
      final message = Message(
        content: messageText,
        sender: "your_wallet_address",
        recipient: recipientAddress,
      );
      await client.sendMessage(message);
      print("Message sent successfully");
    } catch (error) {
      print("Failed to send message: $error");
    }
  }

  [@override](/user/override)
  void dispose() {
    client.disconnect().then((_) {
      print("Disconnected from XMTP network");
    }).catchError((error) {
      print("Failed to disconnect: $error");
    });
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Container();
  }
}