Flutter插件apillon_flutter的使用方法详解介绍

该插件提供了Dart和Flutter开发者与Apillon服务交互的工具和库，通过减少样板代码并简化多步骤流程为单一操作来简化Apillon的REST API的使用。

要求

• Dart SDK: >=3.2.2 <4.0.0
• Apillon API密钥和密钥
• http包版本 1.1.0

开始使用插件apillon_flutter

要使用Apillon Flutter SDK，您必须首先在Apillon.io注册账户，创建项目，并生成具有适当权限的API密钥。

该Flutter SDK包可以在pub.dev上作为Dart包获取，也可以直接在Github上查看。要在您的项目中包含它，请将以下内容添加到pubspec.yaml文件中：

dependencies:
  apillon_flutter: ^0.0.1

初始化

要开始使用SDK，您需要导入它并用您的Apillon API密钥和密钥进行配置。以下是初始化Storage模块的示例：

import 'package:apillon_flutter/apillon_flutter.dart';

void main() {
  var storage = Storage(ApillonConfig(
    key: 'yourApiKey',
    secret: 'yourApiSecret',
  ));
}

Apillon Flutter SDK中的所有模块都需要相同的初始配置key和secret。

模块

Apillon Flutter SDK由几个模块组成，每个模块对应特定的Apillon服务。以下是使用这些模块的一些示例。

Storage

Storage模块提供了与Storage服务交互的功能。

使用示例

import 'dart:io';
import 'package:apillon_flutter/apillon_flutter.dart';
import 'package:path/path.dart' as path;

void main() async {
  var storage = Storage(ApillonConfig(
    key: 'yourApiKey',
    secret: 'yourApiSecret',
  ));

  // 列出所有存储桶
  var buckets = await storage.listBuckets(IApillonPagination());
  print('存储桶:');
  for (var bucket in buckets) {
    print('${bucket.name} - ${bucket.uuid}');
  }

  var bucketUuid = 'eaff2672-3012-46fb-9278-5efacc6cb616';

  // 获取特定存储桶详情
  var bucketDetails = await storage.bucket(bucketUuid).get();
  print('存储桶详情: ${bucketDetails.name}, 大小: ${bucketDetails.size}');

  // 列出存储桶内的文件
  var files = await storage.bucket(bucketUuid).listFiles(IBucketFilesRequest());
  print('存储桶内的文件:');
  for (var file in files) {
    print('${file.name} - ${file.uuid}');
  }

  // 从文件夹上传文件
  var uploadDir = path.join(Directory.current.path, 'my-folder');
  print('正在从$uploadDir上传文件');
  await storage.bucket(bucketUuid).uploadFromFolder(uploadDir, IFileUploadRequest());

  // 从缓冲区上传单个文件
  var filePath = path.join(Directory.current.path, 'file.txt');
  var fileBytes = File(filePath).readAsBytesSync();
  await storage.bucket(bucketUuid).uploadFiles([
    FileMetadata(
      fileName: 'file.txt',
      contentType: 'text/plain',
      content: fileBytes,
    )
  ], IFileUploadRequest());

  // 获取特定文件详情
  var fileUuid = 'eaff2672-3012-46fb-9278-5efacc6cb616';
  var fileDetails = await storage.bucket(bucketUuid).file(fileUuid).get();
  print('文件详情: ${fileDetails.name}, 大小: ${fileDetails.size}');
}

IPNS方法

Storage模块还包含用于操作特定存储桶的IPNS记录的方法。

import 'package:apillon_flutter/apillon_flutter.dart';

void main() async {
  var storage = Storage(ApillonConfig(
    key: 'yourApiKey',
    secret: 'yourApiSecret',
  ));
  var bucketUuid = 'eaff2672-3012-46fb-9278-5efacc6cb616';

  // 列出存储桶内的所有现有IPNS记录
  var ipnsRecords = await storage.bucket(bucketUuid).listIpnsNames(IPNSListRequest());
  print('IPNS记录:');
  for (var record in ipnsRecords) {
    print('${record.name} - ${record.uuid}');
  }

  // 创建新的IPNS记录
  const name = 'Test IPNS';
  const description = '这是一个测试描述';
  const cid = 'QmUxtfFfWFguxSWUUy2FiBsGuH6Px4KYFxJqNYJRiDpemj';
  var newIpnsRecord = await storage.bucket(bucketUuid).createIpns(ICreateIpns(
    name: name,
    description: description,
    cid: cid,
  ));
  print('新IPNS记录: ${newIpnsRecord.uuid}');

  // 发布IPNS记录指向新的CID
  const newCid = 'Qmakf2aN7wzt5u9H3RadGjfotu62JsDfBq8hHzGsV2LZFx';
  await storage.bucket(bucketUuid).ipns(newIpnsRecord.uuid).publish(newCid);
  print('IPNS记录发布到新的CID: $newCid');

  // 删除IPNS记录
  await storage.bucket(bucketUuid).ipns(newIpnsRecord.uuid).delete();
  print('IPNS记录已删除: ${newIpnsRecord.uuid}');
}

NFTs

NFT模块封装了NFT服务的功能。

使用示例

import 'package:apillon_flutter/apillon_flutter.dart';

void main() async {
  var nft = Nft(ApillonConfig(
    key: 'yourApiKey',
    secret: 'yourApiSecret',
  ));

  // 创建一个新的NFT集合
  var collection = await nft.create(ICreateCollection(
    chain: EvmChain.moonbase,
    collectionType1: CollectionType.generic,
    name: 'Space Explorers',
    description: '一个太空探险者的集合',
    symbol: 'SE',
    royaltiesFees: 3,
    royaltiesAddress: '0x95B8c6b9225456107649776EF8aAF20C42d58814',
    baseUri: 'https://test.com/metadata/',
    baseExtension: '.json',
    maxSupply: 50,
    isRevokable: false,
    isSoulbound: false,
    drop: false,
  ));
  print('集合创建: ${collection.uuid}');
  // 或者创建一个substrate集合
  var substrateCollection = await nft.createSubstrate({
    chain: SubstrateChain.astar,
    collectionType1: CollectionType.generic,
    name: 'SpaceExplorers',
    symbol: 'SE',
    ...
  });

  // 在集合中铸造一个新的NFT
  var mintResult = await nft.collection(collection.uuid).mint(IMintNftData(
    receivingAddress: '0x5BA8B0c24bA5307b67E619ad500a635204F73bF1',
    quantity: 1,
  ));
  print('铸造交易哈希: ${mintResult.transactionHash}');

  // 列出NFT集合
  var collections = await nft.listCollections(ICollectionFilters());

  // 将NFT的所有权转让给另一个地址
  await collection.transferOwnership('0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD');
}

Identity

Identity模块提供了验证钱包签名和获取身份数据的功能。

使用示例

import 'package:apillon_flutter/apillon_flutter.dart';

void main() async {
  var identity = Identity(ApillonConfig(
    key: 'yourApiKey',
    secret: 'yourApiSecret',
  ));

  // 为EVM钱包签名验证生成签名消息
  const customMessage = 'Identity EVM SDK 测试';
  var signingMessage = identity.generateSigningMessage(customMessage)["message"];
  print('签名消息: $signingMessage');

  var walletAddress = '0xa79bg13g2...';
  var signature = '0xYourSignature'; // 由客户端应用从用户的钱包中获得的签名

  // 验证EVM钱包签名
  var validationResult = await identity.validateEvmWalletSignature(IValidateEvmWalletSignature(
    walletAddress: walletAddress,
    message: signingMessage,
    signature: signature,
  ));
  print('是否有效: ${validationResult.isValid}');
  print('地址: ${validationResult.address}');

  // 获取Polkadot地址的钱包身份档案
  var polkadotAddress = '5HqHQDGcHqS...',
  var identityProfile = await identity.getWalletIdentity(polkadotAddress);
  print('身份档案: ${identityProfile.subsocial['content']['name']}');
}