HAQQ 项目安装与使用教程

HAQQ 项目安装与使用教程

haqq Shariah-compliant web3 platform 项目地址: https://gitcode.com/gh_mirrors/ha/haqq

1. 项目目录结构及介绍

HAQQ 项目的目录结构如下：

haqq/
├── app/
├── client/
├── cmd/
├── contracts/
├── crypto/
├── docker/
├── encoding/
├── ethereum/eip712/
├── ibc/
├── indexer/
├── ledger/
├── nix/
├── precompiles/
├── proto/
├── rpc/
├── scripts/
├── server/
├── tests/
├── testutil/
├── types/
├── utils/
├── version/
├── xx/
├── build.sh
├── dockerignore
├── envrc
├── gitattributes
├── gitignore
├── golangci.yml
├── goreleaser.yml
├── kodiak.toml
├── markdownlint.yml
├── markdownlintignore
├── snyk
├── CODE_OF_CONDUCT.md
├── LICENSE
├── Makefile
├── README.md
├── buf.work.yaml
├── clang-format
├── config.yml
├── flake.lock
├── flake.nix
├── go.mod
├── go.sum
├── gometalinter.json
├── gomod2nix.toml
├── init.sh
├── package.json
├── shell.nix

目录介绍

• app/: 包含应用程序的核心代码。
• client/: 客户端相关代码。
• cmd/: 命令行工具和入口文件。
• contracts/: 智能合约相关代码。
• crypto/: 加密相关代码。
• docker/: Docker 配置和脚本。
• encoding/: 编码相关代码。
• ethereum/eip712/: Ethereum EIP-712 相关代码。
• ibc/: 跨链相关代码。
• indexer/: 索引器相关代码。
• ledger/: 账本相关代码。
• nix/: Nix 包管理器相关配置。
• precompiles/: 预编译相关代码。
• proto/: Protocol Buffers 相关代码。
• rpc/: RPC 相关代码。
• scripts/: 脚本文件。
• server/: 服务器相关代码。
• tests/: 测试代码。
• testutil/: 测试工具相关代码。
• types/: 类型定义相关代码。
• utils/: 工具函数相关代码。
• version/: 版本管理相关代码。
• xx/: 其他未分类的代码。

2. 项目启动文件介绍

项目的启动文件主要位于 cmd/ 目录下。以下是一些关键的启动文件：

• cmd/haqqd/: 主节点启动文件。
• cmd/haqqcli/: 命令行客户端启动文件。

启动命令示例

# 启动主节点
./cmd/haqqd/haqqd start

# 启动命令行客户端
./cmd/haqqcli/haqqcli query account <address>

3. 项目配置文件介绍

项目的配置文件主要位于项目根目录和 config/ 目录下。以下是一些关键的配置文件：

• config.yml: 主配置文件，包含节点、网络、数据库等配置。
• docker/docker-compose.yml: Docker 配置文件，用于定义容器服务。
• nix/shell.nix: Nix 包管理器配置文件。

配置文件示例

# config.yml
node:
  network: "mainnet"
  database:
    type: "leveldb"
    path: "/data/haqq"

rpc:
  address: "0.0.0.0:26657"
  cors_allowed_origins: ["*"]

通过以上配置文件，可以自定义节点的网络、数据库路径、RPC 地址等参数。

---

以上是 HAQQ 项目的安装与使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 HAQQ 项目。

haqq Shariah-compliant web3 platform 项目地址: https://gitcode.com/gh_mirrors/ha/haqq