kivaprotocol/aries-guardianship-agency

Aries监护代理机构 (Aries Guardianship Agency)

镜像概述

Aries监护代理机构镜像提供了一个用于设置和管理Aries代理的环境，支持连接本地Indy账本和PostgreSQL***数据库。该镜像需通过环境配置文件进行参数调整，可用于代理服务的开发测试、部署及与外部网络（如kiva-network）的集成。

核心功能和特性

• 支持通过.env文件配置环境参数，快速初始化代理服务
• 集成本地Indy账本和PostgreSQL***数据库，提供完整的代理运行环境
• 提供REST API接口，支持创建和删除代理实例
• 支持与kiva-network集成，通过特定环境变量配置实现网络连接
• 包含测试框架，可通过npm test执行测试用例
• 依赖bcgovimages/aries-cloudagent镜像提供Aries代理核心功能

使用场景和适用范围

• Aries代理服务的本地开发与测试
• 代理服务的容器化部署
• 需要连接Indy账本和PostgreSQL数据库的***代理应用
• 与kiva-network等外部协议网络的集成测试

使用方法和配置说明

环境准备

1. 配置环境变量文件

首先需创建.env文件，最简单的方式是复制dummy.env模板：

bash
cp dummy.env .env

除NODE_ENV外，其他参数需根据实际环境调整。若有权限访问其他协议仓库，可从相关仓库获取配置值。

2. 拉取依赖镜像

首次运行前，需确保本地Docker缓存中存在最新的Aries Cloud Agent镜像：

bash
docker pull docker.xuanyuan.run/bcgovimages/aries-cloudagent:py36-1.16-1_0.7.1

3. 额外环境配置

检查src/config/env.json文件，其中包含额外的环境变量设置，可能需要根据环境进行调整（不常用）。

运行测试环境

启动服务

主docker-compose配置会启动代理机构、本地Indy账本和PostgreSQL***数据库：

bash
npm install
docker-compose up

执行测试用例

服务启动后，通过以下命令运行测试：

bash
npm test

代理管理API使用

创建代理

使用REST客户端（如Insomnia）发送POST请求创建代理：

bash
POST http://localhost:3010/v1/manager

请求体示例：

json
{
  "walletId": "walletId001",
  "walletKey": "walletKey001",
  "adminApiKey": "someAdminKey",
  "ttl": -1,
  "seed": "000000000000000000000000ABCDEFG1",
  "agentId": "testAgent2"
}

删除代理

使用创建代理时返回的agentId发送DELETE请求删除代理：

bash
DELETE http://localhost:3010/v1/manager

请求体示例：

json
{
  "agentId": "AGENT_ID_RETURNED_ABOVE"
}

连接kiva-network

若需从协议仓库连接kiva-network，需更新以下环境参数：

WALLET_DB_HOST=protocol-identity-wallets-db
NETWORK_NAME=kiva-network

然后运行：

bash
npm install
docker-compose -f docker-compose.kiva-network.yml up

Docker冲突处理

若遇到来自其他文件的Docker镜像冲突，可通过以下命令清理：

bash
docker rm -f $(docker ps -aq)

Transaction API说明

事务API（如v2/transaction命名空间）需要TDC控制器和代理，这些组件可在protocol-aries仓库中获取。

本地代码测试（aries-guardianship-agency）

1. 克隆protocol-aries代码：

   bash
   git clone https://github.com/kiva/protocol-aries
   

2. 配置步骤1中下载代码的环境
3. 在aries-guardianship-agency中构建/运行docker-compose.yml
4. 在protocol-aries/implementation中配置ncra和tdc控制器的.env文件，以使用wallets-db
5. 运行protocol-aries/implementation/docker-compose.local.yml
6. 执行protocol-aries中scripts/setup.sh所需的脚本