Hyperledger Aries Cloud Agent Python (ACA-Py) 使用教程

1. 项目目录结构及介绍

Hyperledger Aries Cloud Agent Python (ACA-Py) 是一个用于构建去中心化身份应用和服务的基础框架。项目的目录结构如下：

aries-cloudagent-python/
├── aries_cloudagent/
│   ├── __init__.py
│   ├── __main__.py
│   ├── config/
│   ├── protocols/
│   ├── storage/
│   ├── wallet/
│   └── ...
├── demo/
│   ├── __init__.py
│   ├── faber.py
│   ├── alice.py
│   └── ...
├── docker/
│   ├── Dockerfile
│   └── ...
├── docs/
│   ├── index.md
│   └── ...
├── scripts/
│   ├── run_docker.sh
│   └── ...
├── tests/
│   ├── __init__.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
└── ...

目录结构介绍

• aries_cloudagent/: 核心代码目录，包含了 ACA-Py 的主要功能模块。
  • init.py: 初始化文件。
  • main.py: 项目的启动文件。
  • config/: 配置相关的模块。
  • protocols/: 协议相关的模块。
  • storage/: 存储相关的模块。
  • wallet/: 钱包相关的模块。
• demo/: 示例代码目录，包含了多个演示 ACA-Py 功能的示例脚本。
• docker/: Docker 相关的文件，包含了 Dockerfile 等。
• docs/: 文档目录，包含了项目的文档文件。
• scripts/: 脚本目录，包含了运行 Docker 容器的脚本等。
• tests/: 测试代码目录，包含了项目的单元测试和集成测试。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。

2. 项目的启动文件介绍

ACA-Py 的启动文件是 aries_cloudagent/__main__.py。这个文件负责初始化并启动 ACA-Py 实例。启动 ACA-Py 实例时，可以通过命令行参数或环境变量来配置实例的行为。

启动命令示例

aca-py start --inbound-transport http 0.0.0.0 8000 --outbound-transport http

主要启动参数

• --inbound-transport: 指定入站传输协议和端口。
• --outbound-transport: 指定出站传输协议。
• --admin: 指定管理接口的地址和端口。
• --wallet-type: 指定钱包类型（如 askar）。
• --seed: 指定钱包种子。

3. 项目的配置文件介绍

ACA-Py 的配置可以通过命令行参数、环境变量或 YAML 文件来完成。配置文件通常用于定义项目的持久化设置，如数据库连接、钱包配置等。

配置文件示例

wallet:
  type: askar
  name: my_wallet
  key: my_secret_key

transport:
  inbound:
    - type: http
      host: 0.0.0.0
      port: 8000
  outbound:
    - type: http

主要配置项

• wallet: 钱包配置，包括类型、名称和密钥。
• transport: 传输配置，包括入站和出站传输协议。
• admin: 管理接口配置，包括地址和端口。

通过以上配置，可以灵活地启动和管理 ACA-Py 实例，满足不同的应用需求。