Flutter钱包客户端插件 archethic_wallet_client 的使用

什么是 ArchethicWallet RPC？

要了解更多关于 ArchethicWallet RPC，请参考 AEIP-4。

使用方法

添加依赖

在您的项目中添加 archethic-wallet-client 依赖：

$ flutter pub add archethic-wallet-client

设置 Deeplink

如果您希望应用程序在 Android 或 iOS 上工作，则必须设置应用程序的 Deeplink 端点。这是为了让 DeeplinkRPC 正常工作。

Android

在 AndroidManifest.xml 文件中，作为根元素的子元素添加一个 queries 元素：

<queries>
    <!-- AEWallet deeplink support -->
    <intent>
        <action android:name="android.intent.action.VIEW" />
        <data
            android:scheme="aewallet"
            android:host="archethic.tech" />
    </intent>
</queries>

在 .MainActivity 标签内添加 meta-data 和 intent-filter：

<!-- AEWallet deeplink support -->
<meta-data
    android:name="flutter_deeplinking_enabled"
    android:value="true" />
<intent-filter android:autoVerify="true">
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <!-- Replace `flutterdappexample` by your custom deeplink scheme -->
    <!-- Replace `dapp.example` by your custom deeplink host -->
    <!-- These will be used to compose the replyUrl when sending RPCs -->
    <data
        android:scheme="flutterdappexample"  
        android:host="dapp.example" />
</intent-filter>

iOS

在 Info.plist 文件中添加 LSApplicationQueriesSchemes 条目：

<key>LSApplicationQueriesSchemes</key>
<array>
  <string>aewallet</string>
</array>

在 ios/Runner 目录下的 Info.plist 中添加两个新键：

<key>FlutterDeepLinkingEnabled</key>
<true/>
<key>CFBundleURLTypes</key>
<array>
    <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <!-- Replace `flutterdappexample` by your custom deeplink scheme -->
    <!-- Replace `dapp.example` by your custom deeplink host -->
    <!-- These will be used to compose the replyUrl when sending RPCs -->
    <key>CFBundleURLName</key>
    <string>dapp.example</string>
    <key>CFBundleURLSchemes</key>
    <array>
    <string>flutterdappexample</string>
    </array>
    </dict>
</array>

其他本地设置

MacOS

将以下内容添加到 macos/Runner/DebugProfile.entitlements 和 macos/Runner/Release.entitlements 文件中：

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

客户端设置

实例化客户端

import 'package:archethic-wallet-client/archethic-wallet-client.dart';

// 1. 实例化客户端
final _aewalletClient = ArchethicDAppClient.auto(
  origin: const RequestOrigin(        
    name: 'FlutterDappExample',
  ),
  replyBaseUrl: 'flutterdappexample://dapp.example',    
);

[仅限 Deeplink] 监听 Deeplink 响应

在 onGenerateRoute 方法中处理传入的 Deeplinks：

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Dapp Demo',
      home: MyHome(),
      onGenerateRoute: (settings) {
        if ((_aewalletClient as DeeplinkArchethicDappClient)
            .handleRoute(settings.name)) return;

        //... 处理应用所需的其他路由
        return null;
      },
    );
  }
}

发出请求

final response = await _aewalletClient.sendTransaction(
    transactionJsonData,
);

response.when(
    failure: (failure) {
        log(
            'Transaction failed',
            error: failure,
        );
    },
    success: (result) {
        log(
            'Transaction succeed : ${json.encode(result)}',
        );
    },
);

RPC 方法

有两种类型的 RPC 方法：

• 单次调用
• 订阅（由于技术限制，订阅不适用于 Deeplink 通道）

获取 Endpoint (get_endpoint)

获取 AEWallet 使用的 Endpoint URL。

请求

// 请求体为空

成功响应

{
  "endpointUrl": String // Endpoint URL
}

刷新当前账户 (refresh_current_account)

请求钱包刷新当前账户信息。

请求

// 请求体为空

成功响应

// 无响应体

获取账户 (get_accounts)

获取 AEWallet 中可用的账户。

请求

// 请求体为空

成功响应

{
  "accounts": [
    {
      "shortName": String,      // 账户名称
      "serviceName": String     // 服务名称
      "genesisAddress": String, // 创世地址
    }
  ]
}

发送交易 (send_transaction)

签名并发送交易。

请求

{
  "type": String,                 // 交易类型
  "version": Number,              // 交易版本
  "data": Object,                 // 交易数据区
  "generateEncryptedSeedSC": bool // 是否生成加密种子
}

成功响应

{
  "transactionAddress": String,  // 发送交易的地址
  "nbConfirmations": Number,     // 已接收确认数
  "maxConfirmations": Number,    // 最大确认数
}

示例代码

以下是一个完整的示例代码，展示了如何使用 archethic_wallet_client 插件：

import 'package:archethic_wallet_client/archethic_wallet_client.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_dapp_example/logger.dart';
import 'package:flutter_dapp_example/main_screen.dart';

late final ArchethicDAppClient _aewalletClient;

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  LoggerSetup.instance().setup();

  _aewalletClient = await ArchethicDAppClient.auto(
    origin: const RequestOrigin(
      name: 'FlutterDappExample',
    ),
    replyBaseUrl:
        kIsWeb ? Uri.base.toString() : 'flutterdappexample://dapp.example',
  );

  await _aewalletClient.connect();

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Archethic Wallet Client Demo',
      home: Scaffold(
        body: MainScreen(aewalletClient: _aewalletClient),
      ),
      onGenerateRoute: (settings) {
        if ((_aewalletClient as DeeplinkArchethicDappClient)
            .handleRoute(settings.name)) return;
        return null;
      },
    );
  }
}