Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md - Hedera replaces with Hiero #262

Merged
merged 4 commits into from
Oct 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 37 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 implementation of consensus node software transactions and queries, performance and longevity testing.

## Setup

Clone repository
First you need to clone the repository

git clone [email protected]:hashgraph/hedera-sdk-tck.git
```
git clone [email protected]: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.
Expand All @@ -32,49 +38,51 @@ 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).
Comment on lines -61 to -64
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why we did remove the support section?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it links to Hashgraph. We need to create a new document in Hiero. I created an issue: hiero-ledger/hiero#15

```
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.
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

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 [[email protected]](mailto:[email protected]).
Hiero uses the Linux Foundation Decentralised Trust [Code of Conduct](https://www.lfdecentralizedtrust.org/code-of-conduct).

## License

Expand Down