Flutter代理通信插件agent_dart的使用

agent_dart

一个为Internet Computer构建的代理库，是一个用于dart和flutter应用的插件包。开发者可以使用它直接与Dfinity的区块链进行交互。

社区: https://discord.gg/aNzRuePmUY

目录

1. 目录
2. 前置条件
3. 快速开始
4. 动机
5. 里程碑
6. 文档
7. 贡献
8. 参考和相关项目
9. 常见问题

前置条件

• Flutter 版本在 agent_dart/pubspec.yaml 中
• CMake v3.2.0 或更高版本
• Xcode (10.12) 或更高版本（运行在macOS或iOS上）
• Android NDK 版本 21.4.7075529 （运行在Android上）
• Rust 版本 1.51
• Node.js v15.0 或更高版本，待定

快速开始

1. 克隆git仓库

2. 安装前置条件，确保运行以下命令无错误：

   flutter doctor -v
   

3. 运行示例，遵循 example 文件夹下的说明：

   cd example
   flutter run
   

4. 运行测试：

   flutter test
   

动机

Internet Computer由区块链驱动，并且其主要影响在于将Web应用程序真正去中心化。然而，我们正处于移动互联网时代，即使我们可以使用Safari或Chrome在手机上浏览网页，但大多数普通人，不是加密爱好者，更可能使用原生移动应用。因此，吸引这些人使用Internet Computer的Dapps非常重要，这需要提供稳定、快速并且完全集成到Dfinity区块链的应用程序。首先，我们必须让移动原生应用工作。

agent-rs 和 agent-js 是实际的低级客户端SDK，就像Ethereum生态系统中的 ether.js 或 web3.js。此库旨在移植并复制它们的功能。该库主要用于移动应用连接canisters，而不是部署合约（如果你想这样做，可以直接使用dart）。

我们已经尽力迁移了大部分接口样式，就像JavaScript版本一样，但由于不同编程语言之间的限制和差异，我们将尽可能详细地记录这些差异。

里程碑

里程碑1：核心功能/库迁移

• agent，核心库，包含加密和编码/解码方法，封装了HTTP调用/查询，用于与canister交互。
• auth_client，一个用于flutter的弹出窗口，用于从身份提供商（例如Internet Identity）获取认证。
• authentication，支持 auth_client 的库。
• candid，candid库，用于编码/解码candid数据类型，并在dart-lang中使用。
• principal，principal库，用于生成各种用途的principal。
• protobuf，protobuf库，用于与 rosetta-node 在提交/查询交易时进行交互。
• utils，通用工具库，包括有用的扩展方法等。
• wallet，钱包库，集成了signer、rosetta和key-smith。

里程碑2：增强构建工具和更多示例应用

里程碑3：文档和社区驱动开发

文档

参考pub.dev上的文档

文档计划

一个独立的文档站点，提供用Flutter/Dart编写的Dfinity Dapps指南。

贡献

通过贡献到agent_dart，你同意你的贡献将根据MIT许可证发布。

1. 克隆此库并添加自己的分支

   {github_id}/{feat|fix|test|dep}-{detail}
   

2. 安装前置条件

3. 为所有受支持的平台（macOS、iOS、Android、Windows、Linux）构建rust依赖

   $ sh ./scripts/clean && ./scripts/init.sh && ./scripts/build.sh
   

4. 启动示例

   先阅读说明，然后运行：

   $ cd example
   $ flutter run
   

5. 测试（单元测试和集成测试）

   $ flutter test
   

6. **提交并发起拉取请求，过程目前待定。我们将使用CI自动化。

参考和相关项目

• 官方库来自Dfinity团队：

  • agent-rs
  • agent-js

• 其他项目在这里

常见问题

构建iOS/macOS的rust库

• 所有的rust方法必须写在 SwiftAgentDartPlugin.swift 中，以避免由XCode最新发行版树摇导致的问题。

• 当此仓库达到1.0.0时，应相应更改 agent_dart_podspec。

• 在MacOS的M1芯片组上，请安装 rosetta 2：

  $ sudo softwareupdate --install-rosetta --agree-to-license
  

iOS和macOS网络问题

• 如果你在运行示例或构建flutter应用时遇到问题：

  [macOS] SocketException: Connection failed (OS Error: Operation not permitted, errno = 1)
  

• 进入 macos/Runner/ 和 ios/Runner

• 编辑 DebugProfile.entitlements 和 ReleaseProfile.entitlements，添加以下内容：

  <key>com.apple.security.network.client</key>
  <true/>
  

示例代码

import 'package:flutter/material.dart';

import 'counter.dart';
import 'init.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  int _count = 0;
  bool _loading = false;
  String _status = "";

  late Counter _counter;
  final _scaffoldKey = GlobalKey<ScaffoldState>();

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

    initCounter();
    loading(true);
    readCount();
  }

  void initCounter() {
    _counter = AgentFactory.create(
      canisterId: "qaa6y-5yaaa-aaaaa-aaafa-cai",
      url: 
      "http://localhost:8000", // 对于Android模拟器，请使用10.0.2.2作为端点
      idl: idl,
    ).hook(Counter());
  }

  void loading(bool state) {
    setState(() {
      _loading = state;
    });
  }

  void readCount() async {
    int c = await _counter.count();
    loading(false);
    setState(() {
      _count = c;
    });
  }

  void increase() async {
    loading(true);
    await _counter.add();
    readCount();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        key: _scaffoldKey,
        appBar: AppBar(
          title: const Text('Dfinity flutter Dapp'),
        ),
        body: Center(
          child: Column(mainAxisAlignment: MainAxisAlignment.center, children: [
            Text(_loading ? 'loading contract count' : '$_count'),
            Container(
              height: 30,
            ),
            Container(
              height: 30,
            ),
            Text(_status.isEmpty ? "Please Login 👆" : _status),
            Container(
              height: 30,
            ),
          ]),
        ),
        floatingActionButton: FloatingActionButton(
          child: const Icon(Icons.add),
          onPressed: () async {
            increase();
          },
        ),
      ),
    );
  }
}