Problem

When learning how to run the integretion tests for local development, I referenced the instructions in the readme here: https://github.com/hiero-ledger/hiero-sdk-js?tab=readme-ov-file#start-tests.

The local node link in the SDK readme takes me to the local node repo readme which has a couple different ways to run the local node. I tried the docker compose way and it seems the recommended way to start the local node to run integration tests is npm run start. If there is a recommended approach from the team we should document that in the readme.

Once local node was up and running, the readme states a command to run the integration tests.

task test:integration:node

The following errors were observed:

Error: Failed to construct client for IntegrationTestDev

The problem was that the env.sample file in the root directory needed to be renamed to .env and populated with the correct information.

It required the operator account ID and private key from an account created with local node. It also needed the network to be changed.

Solution

We should include all instructions necessary to run the integration tests successfully in the readme.

Alternatives

No response