๐Getting Started
1. Introduction
The Guardian is an innovative open-source platform that streamlines the creation, management, and verification of digital environmental assets. It leverages a customizable Policy Workflow Engine and Web3 technology to ensure transparent and fraud-proof operations, making it a key tool for transforming sustainability practices and carbon markets.
Below are the universal software prerequisites, followed by network-specific items.
2. Prerequisites
2.1 Universal software
Git โ source-control tooling
Docker โ one-command build & run
MongoDB v6, Node.js v16, and NATS 1.12.2 โ auto-installed when using Docker-Compose
Web3.Storage account โ IPFS pinning service
Filebase account โ S3-compatible IPFS pinning
Redis 7.3.0 โ in-memory cache & message broker (auto-provisioned by the Docker stack)
2.2 Hedera network
Key type
ED25519
ED25519
Network
testnet
mainnet
Fees: Mainnet operations incur HBAR costsโfund your account before running Guardian.
3. Preparing a Mainnet Account & Keys
Install a Hedera-enabled wallet (e.g., HashPack).
Create a Mainnet account and note the Account ID (
0.0.x
).Export the ED25519 key pair
HashPack path: Settings โ Manage Accounts โ Export Private Key (DER format).
Update your
.env
HEDERA_NET=mainnet HEDERA_OPERATOR_ID=0.0.123456 HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- โฆ -----END PRIVATE KEY-----
4. Preparing a Testnet Account & Keys
Create a Testnet account via the Hedera Developer Portal.
Record your Account ID (
0.0.x
).Download the ED25519 private key (ignore ECDSA)
Select DER Encoded โ do not choose HEX Encoded.
Update your
.env
dotenvCopyEditHEDERA_NET=testnet HEDERA_OPERATOR_ID=0.0.987654 HEDERA_OPERATOR_KEY=-----BEGIN PRIVATE KEY----- โฆ -----END PRIVATE KEY-----
5. Installation
Docker-Compose
bashCopyEditdocker compose -f ./deploy/docker-compose.yml --profile all up -d
(Detects Testnet/Mainnet from
.env
)Pre-built containers โ pull
hashgraph/guardian:latest
and supply.env
as a secret.Manual build โ clone repo, install Node deps, compile, start services.
6. Troubleshooting
Server not starting? Ensure that Docker is running and all containers are up.
Cannot access the admin dashboard? Check if the correct ports (3000) are open and not blocked by your firewall.
Issues with API calls? Verify that your Hedera account ID and private key are correctly configured in the
.env
file.For additional help, visit the Hedera Guardian GitHub Issues.
7. Additional Resources
8. Feedback and Support
For support, reach out via Hedera Discord Sustainability channel or email us at [email protected].
Submit feedback or feature requests through the GitHub repository.
9. Legal and Licensing
Hedera Guardian is open-source and licensed under the Apache 2.0 License. Please review the LICENSE file for more details.
Last updated