Flutter区块链交互插件kadena_dart_sdk的使用

Flutter区块链交互插件kadena_dart_sdk的使用

概述

这是一个用于与Kadena区块链进行交互的Dart SDK。

签名和快速签名用法

dApp用法

import 'package:kadena_dart_sdk/kadena_dart_sdk.dart';

// 创建一个签名API对象
ISigningApi signingApi = SigningApi();

// 创建一个签名或快速签名请求
SignRequest signRequest = SignRequest(
  code: '"Hello"', // 这里应为有效的Pact命令字符串
  data: {},
  sender: 'sender',
  networkId: 'testnet04',
  chainId: '1',
  gasLimit: 1000,
  gasPrice: 1e-5,
  signingPubKey: 'pubKey',
  ttl: 600,
  caps: [
    DappCapp(
      role: 'Gas',
      description: 'Gas Cap',
      cap: Capability(
        name: 'Gas',
        args: [],
      ),
    ),
  ],
);

QuicksignRequest quicksignRequest = QuicksignRequest(
  commandSigDatas: [
    CommandSigData(
      cmd: 'Hello, World!', // 这里应为有效的Pact命令字符串
      sigs: [
        QuicksignSigner(
          pubKey: 'pubKey',
        ),
      ],
    ),
  ],
);

// 可以通过将其转换为JSON格式来传输该对象
final signRequestJson = signRequest.toJson();
final quicksignRequestJson = quicksignRequest.toJson();

钱包用法

import 'package:kadena_dart_sdk/kadena_dart_sdk.dart';

// 创建一个签名API对象
ISigningApi signingApi = SigningApi();

// 创建公钥/私钥对
final KadenaSignKeyPair kp = KadenaSignKeyPair(
  publicKey: 'priv_key',
  privateKey: 'pub_key',
);

// 获取从dApp接收到的签名/快速签名请求对象
final Map<String, dynamic> quicksignRequestJson = {
  "commandSigDatas": [
    {
      "cmd": "Hello, World!", // 这里应为有效的Pact命令字符串
      "sigs": [
        {
          "pubKey":
              '8d48094ca84b475ece568c4b0d8aacfb1de3278b6bd16b33a60c068b86a2ba51',
        }
      ]
    }
  ]
};
final Map<String, dynamic> signRequestJson = {
  "code": '"Hello"', // 这里应为有效的Pact命令字符串
  "data": {},
  "sender": "sender",
  "networkId": "testnet04",
  "chainId": "1",
  "gasLimit": 1000,
  "gasPrice": 1e-5,
  "signingPubKey": '8d48094ca84b475ece568c4b0d8aacfb1de3278b6bd16b33a60c068b86a2ba51',
  "ttl": 600,
  "caps": [
    {
      "role": "Gas",
      "description": "Gas Cap",
      "cap": {
        "name": "Gas",
        "args": []
      }
    }
  ]
};

/// 签名请求流程 ///
// 1. 解析请求
final SignRequest signRequest = signingApi.parseSignRequest(
  signRequestJson,
);

// 2. 使用请求构造一个PactCommandPayload
final PactCommandPayload pactCommandPayload = signingApi.constructPactCommandPayload(
  request: signRequest,
);

// 3. 以某种方式（弹窗、底部面板等）获取用户的签名批准
final bool approval = true;

// 4. 签名交易
SignResult signResult;
if (approval) {
  signResult = signingApi.sign(
    request: signRequest,
    keyPairs: kp,
  );
} else {
  signResult = SignResult(
    error: SignRequestError(
      msg: 'User declined to sign',
    ),
  );
}

// 5. 将签名结果返回给dApp以JSON格式
final Map<String, dynamic> signResultJson = signResult.toJson();

/// 快速签名流程 ///
// 1. 解析请求
final QuicksignRequest quicksignRequest = signingApi.parseQuicksignRequest(
  quicksignRequestJson,
);

// 2. 存储快速签名响应，并循环处理每个CommandSigData
final List<QuicksignResponse> quicksignResponseList = [];
for (final CommandSigData commandSigData in quicksignRequest.commandSigDatas) {
  // 3. 以某种方式（弹窗、底部面板等）获取用户的签名批准
  var approval = true;

  // 4. 根据批准情况，签名交易或添加noSig快速签名结果
  if (approval) {
    final QuicksignResult quicksignResult = signingApi.quicksignSingleCommand(
      commandSigData: commandSigData,
      keyPairs: kp,
    );
    quicksignResponseList.add(quicksignResult);
  } else {
    quicksignResponseList.add(
      QuicksignResponse(
        commandSigData: commandSigData,
        outcome: QuicksignOutcome(
          result: QuicksignOutcome.noSig,
        ),
      ),
    );
  }
}

// 5. 返回快速签名结果给dApp以JSON格式
final QuicksignResult quicksignResult = QuicksignResult(
  responses: quicksignResponseList,
).toJson();

实现

ISigningApi 是一个接口，这样可以轻松地对其进行模拟，并且可以创建未来的版本，这些版本可以轻松替换当前实现。

此库旨在使dApp构建请求和钱包签名变得简单。

测试

要运行测试：

flutter test

测试验证了描述在KIP中的功能。然而，KIP尚未合并，未最终确定，且可能发生变化。

待办事项

• 构建签名API的签名部分
• 与示例dApp一起构建集成测试以证明功能

常见命令

重建生成的代码：

flutter pub run build_runner build --delete-conflicting-outputs