Hedera™ C++ SDK

The SDK for interacting with Hedera Hashgraph: the official distributed consensus platform built using the hashgraph consensus algorithm for fast, fair and secure transactions. Hedera enables and empowers developers to build an entirely new class of decentralized applications.

Prerequisites

For MacOS and Linux users:

• ninja
  • MacOS: brew install ninja
  • Linux: apt-get install ninja
• pkg-config
  • MacOS: brew install pkg-config
  • Linux: apt-get install pkg-config
• cmake
  • MacOS: brew install cmake
  • Linux: apt-get install cmake

📣 Note: Ensure you install all three ninja, pkg-config, and cmake to avoid errors in subsequent steps. The installations might take a few minutes.

For Windows users:

• Visual Studio 2019/2022 Community/Pro with Universal Windows Platform Development Tools
• Perl (perl.exe must be added to %PATH%)
• NASM (nasm.exe must be added to %PATH%)

Build

This project features CMake Presets which simplify the setup of vcpkg based dependencies. The below commands are typically all that is required.

1. Clone the project

git clone https://github.com/hashgraph/hedera-sdk-cpp.git

2. CD to your project directory

cd hedera-sdk-cpp

3. Complete the following tasks within your project directory

# Ensure the VCPkg Submodule is initialized
git submodule update --init

# Windows (x64) Build
cmake --preset windows-x64-release
cmake --build --preset windows-x64-release

# Linux (x64) Build
cmake --preset linux-x64-release
cmake --build --preset linux-x64-release

# MacOS (Intel x64) Build
cmake --preset macos-x64-release
cmake --build --preset macos-x64-release

# MacOS (Aarch64) Build
cmake --preset macos-arm64-release
cmake --build --preset macos-arm64-release

Testing

To run all SDK tests (for Release or Debug builds):

ctest -C [Release|Debug] --test-dir build/<PRESET>

To run all SDK unit tests and test vectors:

ctest -C [Release|Debug] --test-dir build/<PRESET> -R "TestVectors|UnitTests"

To run all SDK integration tests:

ctest -C [Release|Debug] --test-dir build/<PRESET> -R "IntegrationTests"

To run a specific test:

ctest -C [Release|Debug] --test-dir build/<PRESET> -R <NAME OF TEST>

Running Integration Tests

To run the integration tests it's necessary to have a running Hedera Local Node. If the local node is already running, check the configuration JSON file for the network settings. Ensure the values for network tag contains a valid AccountId and a valid IP address for an operational node.

Example config file:

{
  "network": {
    "0.0.3": "127.0.0.1:50211"
  },
  "mirrorNetwork": [
    "127.0.0.1:5600"
  ],
  "operator": {
    "accountId": "0.0.2",
    "privateKey": "302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137"
  }
}

(Source: /config/local_node.json)

Examples

Most examples require OPERATOR_ID and OPERATOR_KEY to be in a .env file in the directory from which the examples are being run. If running from the root directory:

build/<PRESET>/sdk/examples/[Release|Debug]/<EXAMPLE-NAME>

Contributing to this Project

We welcome participation from all developers!

For instructions on how to contribute to this repo, please review the Contributing Guide for C++.

More instructions for contribution can be found in the Global Contributing Guide.

Code of Conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code of conduct.

If you need to prepare a new SDK release, then see the Step-by-Step guide how to do it.

License

Apache License 2.0