A Technology Compatibility Kit (TCK) is a set of tools, documentation, and test suites used to verify whether a software implementation conforms to a specific technology standard or specification. The TCK aims to verify compliant implementations of a Hiero SDK. It will encompass tests that validate the implementation of consensus node software transactions and queries, performance and longevity testing.
First you need to clone the repository
git clone [email protected]:hashgraph/hedera-sdk-tck.git
The TCK provides ready-to-use configurations to run tests against the Hedera testnet or hedera-local-node. In near future hedera-local-node will be transfered to Hiero.
- Get a Hedera testnet account ID and private key from Hedera here
- rename
.env.testnetto.env - Add ECDSA account ID and private key to
.env
- Start your hedera-local-node
- rename
.env.custom_nodeto.env
- Change the content of
.envto fit to your network
Start only the JSON-RPC server for the SDK you want to test. The JSON-RPC server for the specified SDK will parse the JSON formatted request received by the test driver. The JSON-RPC server will execute the corresponding function or procedure associated with that method and prepare the response in JSON format to send back to the test driver.
Install packages with npm
npm install
Run specific test file
npm run test test/account/test_accountCreateTransaction.js
Run all tests
npm run test
After running npm run test the generated HTML and JSON reports can be found in the mochawesome-report folder
To ensure code quality and consistent styling, you can run ESLint and Prettier on the codebase.
To check for code issues, run:
npm run lint
To format the code run:
npm run format
Whether you’re fixing bugs, enhancing features, or improving documentation, your contributions are important — let’s build something great together!
Please read our contributing guide to see how you can get involved.
Hiero uses the Linux Foundation Decentralised Trust Code of Conduct.