From 35a5d37803be947808349a047dae32f6ccbd2138 Mon Sep 17 00:00:00 2001 From: Rob Walworth Date: Thu, 21 Nov 2024 10:54:15 -0500 Subject: [PATCH 1/2] docs: remove mentions of Hedera in documentation Signed-off-by: Rob Walworth --- DevelopmentProcess.md | 14 +++++++------- README.md | 6 +++--- docs/design.md | 8 +++----- test-specifications/commonTransactionParameters.md | 2 +- test-specifications/errorCodes.md | 6 +++--- test-specifications/utility.md | 2 +- 6 files changed, 18 insertions(+), 20 deletions(-) diff --git a/DevelopmentProcess.md b/DevelopmentProcess.md index 684eedd..2ace5a4 100644 --- a/DevelopmentProcess.md +++ b/DevelopmentProcess.md @@ -1,6 +1,6 @@ # TCK Development Process -This document is meant to describe and outline the process by which TCK tests are written and developed for a specific Hedera request type. Since the work for these TCK tests will not only be contained to this repo but also spread out amongst all the SDK repos, there will be a good amount of coordination required between all developers to make sure TCK and SDK work stays in parity with each other. The outline below will describe how tests should be documented, developed, and tested to keep this parity. This process is always open to changes at any point if the developers find better or more optimal ways to accomplish tasks. +This document is meant to describe and outline the process by which TCK tests are written and developed for a specific request type. Since the work for these TCK tests will not only be contained to this repo but also spread out amongst all the SDK repos, there will be a good amount of coordination required between all developers to make sure TCK and SDK work stays in parity with each other. The outline below will describe how tests should be documented, developed, and tested to keep this parity. This process is always open to changes at any point if the developers find better or more optimal ways to accomplish tasks. ## SDK Leads @@ -17,18 +17,18 @@ Since the process outlined will require coordination across all SDKs, having a d ## Process -The TCK development process encompasses all work done for a Hedera request type, including documentation, development of tests, the actual testing of the tests, and finally synchronously merging all the work. +The TCK development process encompasses all work done for a request type, including documentation, development of tests, the actual testing of the tests, and finally synchronously merging all the work. ### Step 1: Documentation -Before any development takes place, the tests to be written need to be thought out and put in a markdown file in the `test-specifications` folder. A new file should use the `test-specifications/testSpecificationsTemplate.md` file as a template. The new markdown file should also be placed within a folder within the `test-specifications` folder that contains all the tests for the particular Hedera service that services the request for which tests are being written. For example, if tests are being written for `AccountCreateTransaction`, the `accountCreateTransaction.md` file should be placed in `test-specifications/crypto-service`. +Before any development takes place, the tests to be written need to be thought out and put in a markdown file in the `test-specifications` folder. A new file should use the `test-specifications/testSpecificationsTemplate.md` file as a template. The new markdown file should also be placed within a folder within the `test-specifications` folder that contains all the tests for the particular service that services the request for which tests are being written. For example, if tests are being written for `AccountCreateTransaction`, the `accountCreateTransaction.md` file should be placed in `test-specifications/crypto-service`. The items that should be included in a request's test documentation can be seen by looking at the `testSpecificationsTemplate.md` file. These items include: - Description: A description of the test specification. This, for the most part, should be copy-paste between test files with slight changes for names, links, etc. - Design: A brief rundown of what is being tested, how it's being tested, and how the test results can be verified. - - Request properties: A link to the Hedera documentation for the request. + - Request properties: A link to the documentation for the request. - Request protobuf: A link to the protobuf file located in the [hedera-protobufs](https://github.com/hashgraph/hedera-protobufs) repository for the request type being tested. - - Response codes: A link to the protobuf file that contains the response codes for gRPC requests sent to a Hedera network. + - Response codes: A link to the protobuf file that contains the response codes for gRPC requests sent to a network. - Mirror Node APIs: A link to the mirror node APIs that can be used to verify test results. - Code snippet: A code snippet that shows how to use the request type in code. - JSON-RPC API documentation: The information on how the JSON-RPC servers should implement the method being used to test. This should include: @@ -49,7 +49,7 @@ Once the tests have been written, they can be put up for in a pull request. The ### Step 2a: TCK Test Driver -Once the tests are written, approved, and merged, they can then be developed. The approved and merged test documentation should be used to discern what tests to write and how they should operate. Much like the test documentation, the file that contains the code for the tests should be placed within a folder within the `test` folder that contains all the tests for the particular Hedera service that services the request for which the tests are being written. For example, if tests are being written for `AccountCreateTransaction`, the `test_accountCreateTransaction.js` file should be placed in `test/crypto-service`. +Once the tests are written, approved, and merged, they can then be developed. The approved and merged test documentation should be used to discern what tests to write and how they should operate. Much like the test documentation, the file that contains the code for the tests should be placed within a folder within the `test` folder that contains all the tests for the particular service that services the request for which the tests are being written. For example, if tests are being written for `AccountCreateTransaction`, the `test_accountCreateTransaction.js` file should be placed in `test/crypto-service`. A few guidelines for developing the tests: - The name of the test file should match the name of the documentation, with a `test_` prepended to the file name, and obviously the different file extension. So a documentation markdown file named `accountCreateTransaction.md` would have its test implementation file named `test_accountCreateTransaction.js`. @@ -108,4 +108,4 @@ Once the development of the SDK server is complete, it should be tested against ### Step 3: Merge Pull Requests -Once the development work for the TCK and the SDK servers is complete, three approvals from the SDK leads will be required for any pull requests to be merged. This is a new improvement, to merge PRs early enough while waiting for all the tests to pass on all SDK servers simultaneously. This will then mark the completion of the development work for this specific Hedera request. \ No newline at end of file +Once the development work for the TCK and the SDK servers is complete, three approvals from the SDK leads will be required for any pull requests to be merged. This is a new improvement, to merge PRs early enough while waiting for all the tests to pass on all SDK servers simultaneously. This will then mark the completion of the development work for this specific request. \ No newline at end of file diff --git a/README.md b/README.md index f7d1dc1..9689371 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ First you need to clone the repository git clone git@github.com:hiero-ledger/hiero-sdk-tck.git ``` -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). +The TCK provides ready-to-use configurations to run tests against [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 (see our [transition document](https://github.com/hiero-ledger/hiero/blob/main/transition.md) for more details). -### Configure usage of Hedera Testnet +### Configure usage of Hiero Testnet -- Get a Hedera testnet account ID and private key from Hedera [here](https://portal.hedera.com/register) +- Get a testnet account ID and private key [here](https://portal.hedera.com/register) - rename `.env.testnet` to `.env` - Add ECDSA account ID and private key to `.env` diff --git a/docs/design.md b/docs/design.md index aa6de5a..cb11166 100644 --- a/docs/design.md +++ b/docs/design.md @@ -30,9 +30,8 @@ The SDK's JSON-RPC server returns responses that originate from the consensus no ### Requirements -1. The hedera network must support at least 4 nodes, so one can be shut down - without affecting consensus. -2. The hedera network will be a local network setup by the TCK +1. The test network must support at least 4 nodes, so one can be shut down without affecting consensus. +2. The test network will be a local network setup by the TCK 3. The TCK will be an executable NPM module. 4. The JSON-RPC server for the SDK must be started prior to running the TCK. 5. The TCK must take configuration, requiring the endpoint of the JSON-RPC @@ -43,8 +42,7 @@ The SDK's JSON-RPC server returns responses that originate from the consensus no ### Guidance -The hedera network ideally would be a hedera-local-node, which would mean adding -support for multiple nodes to the hedera-local-node (Issue is already filed) +The network ideally would be a hedera-local-node, which would mean adding support for multiple nodes to the hedera-local-node (Issue is already filed) ### JSON-RPC API Examples diff --git a/test-specifications/commonTransactionParameters.md b/test-specifications/commonTransactionParameters.md index 875c79b..e56801a 100644 --- a/test-specifications/commonTransactionParameters.md +++ b/test-specifications/commonTransactionParameters.md @@ -1,6 +1,6 @@ # Common Transaction Parameters -There are common parameters that can be set for all Hedera transaction types. This document specifies a common JSON object that should be added to all transactions that encapsulates these common parameters. +There are common parameters that can be set for all Hiero transaction types. This document specifies a common JSON object that should be added to all transactions that encapsulates these common parameters. ## Transaction Parameter Object Definition diff --git a/test-specifications/errorCodes.md b/test-specifications/errorCodes.md index 47f131f..6d0dabf 100644 --- a/test-specifications/errorCodes.md +++ b/test-specifications/errorCodes.md @@ -4,7 +4,7 @@ The JSON-RPC 2.0 specification that the TCK and SDK servers use allow for implem ## Errors -### Hedera Error +### Hiero Error #### Error code @@ -26,10 +26,10 @@ The `data` object in the JSON-RPC 2.0 `error` object should contain the status o "id": , "error": { "code": -32001, - "message": "Hedera error", + "message": "Hiero error", "data": { "status": "INVALID_SIGNATURE", - "message": "Hedera transaction 0.0.53244@1714166295.670948384 failed precheck with status INVALID_SIGNATURE" + "message": "Hiero transaction 0.0.53244@1714166295.670948384 failed precheck with status INVALID_SIGNATURE" } } } diff --git a/test-specifications/utility.md b/test-specifications/utility.md index 61b8063..953bf52 100644 --- a/test-specifications/utility.md +++ b/test-specifications/utility.md @@ -102,7 +102,7 @@ Method used to close the TCK network connections. Network connections can be ree #### Description -Method used to generate a Hedera Key. +Method used to generate a Hiero Key. #### Input Parameters From 290ee093305ecf5c7686c3f74ccfca7c8ee4b9e6 Mon Sep 17 00:00:00 2001 From: Rob Walworth <110835868+rwalworth@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:56:27 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Hendrik Ebbers Signed-off-by: Rob Walworth <110835868+rwalworth@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9689371..5f5b84c 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ First you need to clone the repository git clone git@github.com:hiero-ledger/hiero-sdk-tck.git ``` -The TCK provides ready-to-use configurations to run tests against [testnet](https://docs.hedera.com/hedera/networks) or [hedera-local-node](https://github.com/hashgraph/hedera-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 (see our [transition document](https://github.com/hiero-ledger/hiero/blob/main/transition.md) for more details). -### Configure usage of Hiero Testnet +### Configure usage of Hedera Testnet -- Get a testnet account ID and private key [here](https://portal.hedera.com/register) +- Get a Hedera testnet account ID and private key [here](https://portal.hedera.com/register) - rename `.env.testnet` to `.env` - Add ECDSA account ID and private key to `.env`