From 48b5da9b4ff3e257fcf20f48e85102a2545894db Mon Sep 17 00:00:00 2001 From: Hendrik Ebbers Date: Mon, 28 Oct 2024 09:47:57 +0100 Subject: [PATCH 1/4] README.md - Hedera replaces with Hiero Signed-off-by: Hendrik Ebbers --- README.md | 65 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 36 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index bf63b15..2f01dd0 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,35 @@ -# Hedera SDK TCK +# Hiero SDK TCK -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 hedera-sdk-tck aims to verify compliant implementations of -a Hedera SDK. It will encompass tests that validate the implmentation of consensus node software transactions and queries, performance and longevity testing. - -# test-driver-js +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 implmentation of consensus node software transactions and queries, performance and longevity testing. ## Setup -Clone repository +First you need to clone the repository - git clone git@github.com:hashgraph/hedera-sdk-tck.git +``` +git clone git@github.com:hashgraph/hedera-sdk-tck.git +``` -### Decide between Testnet or a local node +The TCK provides ready-to-use configurations to run tests against the [Hedera testnet](https://docs.hedera.com/hedera/networks) or [hedera-local-node](https://github.com/hashgraph/hedera-local-node). +In near future hedera-local-node will be transfered to Hiero. -#### Testnet +### Configure usage of Hedera Testnet - Get a Hedera testnet account ID and private key from Hedera [here](https://portal.hedera.com/register) - rename `.env.testnet` to `.env` - Add ECDSA account ID and private key to `.env` -#### Local node +### Configure usage of local node - Start your [hedera-local-node](https://github.com/hashgraph/hedera-local-node) - rename `.env.custom_node` to `.env` +### Configure usage of a custom network + +- Change the content of `.env` to fit to your network + ### Start a JSON-RPC server 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. @@ -32,49 +38,50 @@ Start only the JSON-RPC server for the SDK you want to test. The JSON-RPC server Install packages with npm - npm install +``` +npm install +``` Run specific test file - npm run test test/account/test_accountCreateTransaction.js +``` +npm run test test/account/test_accountCreateTransaction.js +``` Run all tests - npm run test +``` +npm run test +``` ### Reports -After running `npm run test` the generated HTML and JSON reports can be found in the mochawesome-report folder +After running `npm run test` the generated HTML and JSON reports can be found in the `mochawesome-report` folder ### Linting and Formatting + 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 +``` +npm run lint +``` To **format** the code run: - npm run format - - -## Support - -If you have a question on how to use the product, please see our -[support guide](https://github.com/hashgraph/.github/blob/main/SUPPORT.md). +``` +npm run format +``` ## Contributing -Contributions are welcome. Please see the -[contributing guide](https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md) -to see how you can get involved. +Contributions are welcome. +Please read our [contributing guide]([https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md)) to see how you can get involved. ## Code of Conduct -This project is governed by the -[Contributor Covenant Code of Conduct](https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md). By -participating, you are expected to uphold this code of conduct. Please report unacceptable behavior -to [oss@hedera.com](mailto:oss@hedera.com). +Hiero uses the Linux FOundation Decentralised Trust [Code of Conduct]([https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md](https://www.lfdecentralizedtrust.org/code-of-conduct)). ## License From dcea36c4c5b72bfee9d1c8dadae9f5eee7794e92 Mon Sep 17 00:00:00 2001 From: Hendrik Ebbers Date: Mon, 28 Oct 2024 10:00:07 +0100 Subject: [PATCH 2/4] Update README.md Signed-off-by: Hendrik Ebbers --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f01dd0..9316dcf 100644 --- a/README.md +++ b/README.md @@ -76,12 +76,13 @@ npm run format ## Contributing -Contributions are welcome. -Please read our [contributing guide]([https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md)) to see how you can get involved. +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](https://github.com/hiero-ledger/.github/blob/main/CONTRIBUTING.md) to see how you can get involved. ## Code of Conduct -Hiero uses the Linux FOundation Decentralised Trust [Code of Conduct]([https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md](https://www.lfdecentralizedtrust.org/code-of-conduct)). +Hiero uses the Linux FOundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct). ## License From 4a89e83501e6da3d91ea49b4fa45e67b746da1cc Mon Sep 17 00:00:00 2001 From: Hendrik Ebbers Date: Tue, 29 Oct 2024 12:01:12 +0100 Subject: [PATCH 3/4] Update README.md Co-authored-by: Rob Walworth <110835868+rwalworth@users.noreply.github.com> Signed-off-by: Hendrik Ebbers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9316dcf..dcb2686 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ Please read our [contributing guide](https://github.com/hiero-ledger/.github/blo ## Code of Conduct -Hiero uses the Linux FOundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct). +Hiero uses the Linux Foundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct). ## License From 259b0dbb13dcf95daa4ebc17d30c99a10066c638 Mon Sep 17 00:00:00 2001 From: Hendrik Ebbers Date: Tue, 29 Oct 2024 12:01:46 +0100 Subject: [PATCH 4/4] Update README.md Signed-off-by: Hendrik Ebbers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dcb2686..7f7aadd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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 implmentation of consensus node software transactions and queries, performance and longevity testing. +It will encompass tests that validate the implementation of consensus node software transactions and queries, performance and longevity testing. ## Setup