From e5ce330cdc20b25cc3028885b89941b7d1aeafe2 Mon Sep 17 00:00:00 2001 From: Rob Walworth Date: Mon, 11 Nov 2024 16:21:54 -0500 Subject: [PATCH 1/2] docs: add tests Signed-off-by: Rob Walworth --- .../token-service/tokenUnfreezeTransaction.md | 140 ++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 test-specifications/token-service/tokenUnfreezeTransaction.md diff --git a/test-specifications/token-service/tokenUnfreezeTransaction.md b/test-specifications/token-service/tokenUnfreezeTransaction.md new file mode 100644 index 0000000..20943a8 --- /dev/null +++ b/test-specifications/token-service/tokenUnfreezeTransaction.md @@ -0,0 +1,140 @@ +# TokenUnfreezeTransaction - Test specification + +## Description: +This test specification for TokenUnfreezeTransaction is to be one of many for testing the functionality of the Hedera SDKs. The SDK under test will use the language specific JSON-RPC server return responses back to the test driver. + +## Design: +Each test within the test specification is linked to one of the properties within TokenUnfreezeTransaction. Each property is tested with a mix of boundaries. The inputs for each test are a range of valid, minimum, maximum, negative and invalid values for the method. The expected response of a passed test can be a correct error response code or seen as the result of node queries. A successful transaction (the transaction reached consensus and was applied to state) can be determined by getting a `TransactionReceipt` or `TransactionRecord`, or can be determined by using queries such as `TokenInfoQuery` or `AccountBalanceQuery` and investigating for the required changes (creations, updates, etc.). The mirror node can also be used to determine if a transaction was successful via its rest API. Error codes are obtained from the response code proto files. + +**Transaction properties:** + +https://docs.hedera.com/hedera/sdks-and-apis/sdks/token-service/unfreeze-an-account + +**TokenDelete protobufs:** + +https://github.com/hashgraph/hedera-protobufs/blob/main/services/token_unfreeze_account.proto + +**Response codes:** + +https://github.com/hashgraph/hedera-protobufs/blob/main/services/response_code.proto + +**Mirror Node APIs:** + +https://docs.hedera.com/hedera/sdks-and-apis/rest-api + +## JSON-RPC API Endpoint Documentation + +### Method Name + +`unfreezeToken` + +### Input Parameters + +| Parameter Name | Type | Required/Optional | Description/Notes | +|-------------------------|--------------------------------------------------|-------------------|------------------------------------| +| tokenId | string | optional | The ID of the token to unfreeze. | +| accountId | string | optional | The ID of the account to unfreeze. | +| commonTransactionParams | [json object](../commonTransactionParameters.md) | optional | | + +### Output Parameters + +| Parameter Name | Type | Description/Notes | +|----------------|--------|---------------------------------------------------------------------------------------| +| status | string | The status of the submitted `TokenUnfreezeTransaction` (from a `TransactionReceipt`). | + +### Additional Notes + +The tests contained in this specification will assume that a valid account and a valid token have already successfully created, associated, and frozen, unless otherwise specified. will denote the ID of the account, and will denote the private key of the created account as a DER-encoded hex string. will denote the ID of the created token, and will denote the freeze key of the token as a DER-encoded hex string. + +## Property Tests + +### **Token ID:** + +- The ID of the token to unfreeze. + +| Test no | Name | Input | Expected response | Implemented (Y/N) | +|---------|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-------------------| +| 1 | Unfreezes a token on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze succeeds. | N | +| 2 | Unfreezes a token that doesn't exist on an account | tokenId="123.456.789", accountId= | The token unfreeze fails with an INVALID_TOKEN_ID response code from the network. | N | +| 3 | Unfreezes a token with an empty token ID on an account | tokenId="", accountId= | The token unfreeze fails with an SDK internal error. | N | +| 4 | Unfreezes a token with no token ID on an account | accountId= | The token unfreeze fails with an INVALID_TOKEN_ID response code from the network. | N | +| 5 | Unfreezes a deleted token on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_WAS_DELETED response code from the network. | N | +| 6 | Unfreezes a token on an account without signing with the token's freeze key | tokenId=, accountId= | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N | +| 7 | Unfreezes a token on an account but signs with an incorrect freeze key | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N | +| 8 | Unfreezes a token with no freeze key on an account | tokenId=, accountId= | The token unfreeze fails with an TOKEN_HAS_NO_FREEZE_KEY response code from the network. | N | +| 9 | Unfreezes a token that is already unfrozen on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze succeeds. | N | +| 10 | Unfreezes a token on an account that is not associated with the token | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_NOT_ASSOCIATED_WITH_ACCOUNT response code from the network. | N | +| 11 | Unfreezes a paused token on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_IS_PAUSED response code from the network. | N | + +#### JSON Request Example + +```json +{ + "jsonrpc": "2.0", + "id": 64362, + "method": "unfreezeToken", + "params": { + "tokenId": "0.0.15432", + "accountId": "0.0.54811", + "commonTransactionParams": { + "signers": [ + "302E020100300506032B657004220420DE6788D0A09F20DED806F446C02FB929D8CD8D17022374AFB3739A1D50BA72C8" + ] + } + } +} +``` + +#### JSON Response Example + +```json +{ + "jsonrpc": "2.0", + "id": 64362, + "result": { + "status": "SUCCESS" + } +} +``` + +### **Account ID:** + +- The ID of the account to freeze. + +| Test no | Name | Input | Expected response | Implemented (Y/N) | +|---------|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|-------------------| +| 1 | Unfreezes a token on an account that doesn't exist | tokenId=, accountId="123.456.789", commonTransactionParams.signers=[] | The token freeze fails with an INVALID_ACCOUNT_ID response code from the network. | N | +| 2 | Unfreezes a token on an account with an empty account ID | tokenId=, accountId="", commonTransactionParams.signers=[] | The token freeze fails with an SDK internal error. | N | +| 3 | Unfreezes a token on an account with no account ID | tokenId=, commonTransactionParams.signers=[] | The token freeze fails with an INVALID_ACCOUNT_ID response code from the network. | N | +| 4 | Unfreezes a token on a deleted account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token freeze fails with an ACCOUNT_WAS_DELETED response code from the network. | N | + +#### JSON Request Example + +```json +{ + "jsonrpc": "2.0", + "id": 64362, + "method": "unfreezeToken", + "params": { + "tokenId": "0.0.15432", + "accountId": "0.0.54811", + "commonTransactionParams": { + "signers": [ + "302E020100300506032B657004220420DE6788D0A09F20DED806F446C02FB929D8CD8D17022374AFB3739A1D50BA72C8" + ] + } + } +} +``` + +#### JSON Response Example + +```json +{ + "jsonrpc": "2.0", + "id": 64362, + "result": { + "status": "SUCCESS" + } +} +``` From 5350bcde3c44b37f5a89972b5a80d5eaeae69ccd Mon Sep 17 00:00:00 2001 From: Rob Walworth Date: Tue, 19 Nov 2024 17:51:39 -0500 Subject: [PATCH 2/2] docs: add test Signed-off-by: Rob Walworth --- .../token-service/tokenUnfreezeTransaction.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/test-specifications/token-service/tokenUnfreezeTransaction.md b/test-specifications/token-service/tokenUnfreezeTransaction.md index 20943a8..e988463 100644 --- a/test-specifications/token-service/tokenUnfreezeTransaction.md +++ b/test-specifications/token-service/tokenUnfreezeTransaction.md @@ -44,7 +44,7 @@ https://docs.hedera.com/hedera/sdks-and-apis/rest-api ### Additional Notes -The tests contained in this specification will assume that a valid account and a valid token have already successfully created, associated, and frozen, unless otherwise specified. will denote the ID of the account, and will denote the private key of the created account as a DER-encoded hex string. will denote the ID of the created token, and will denote the freeze key of the token as a DER-encoded hex string. +The tests contained in this specification will assume that a valid account and a valid token have already successfully created, associated, and frozen, unless otherwise specified. will denote the ID of the account, and will denote the private key of the created account as a DER-encoded hex string. will denote the ID of the created token, will denote the freeze key of the token as a DER-encoded hex string, and will denote the admin key of the token as a DER-encoded hex string. ## Property Tests @@ -60,11 +60,12 @@ The tests contained in this specification will assume that a valid account and a | 4 | Unfreezes a token with no token ID on an account | accountId= | The token unfreeze fails with an INVALID_TOKEN_ID response code from the network. | N | | 5 | Unfreezes a deleted token on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_WAS_DELETED response code from the network. | N | | 6 | Unfreezes a token on an account without signing with the token's freeze key | tokenId=, accountId= | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N | -| 7 | Unfreezes a token on an account but signs with an incorrect freeze key | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N | -| 8 | Unfreezes a token with no freeze key on an account | tokenId=, accountId= | The token unfreeze fails with an TOKEN_HAS_NO_FREEZE_KEY response code from the network. | N | -| 9 | Unfreezes a token that is already unfrozen on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze succeeds. | N | -| 10 | Unfreezes a token on an account that is not associated with the token | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_NOT_ASSOCIATED_WITH_ACCOUNT response code from the network. | N | -| 11 | Unfreezes a paused token on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_IS_PAUSED response code from the network. | N | +| 7 | Unfreezes a token but signs with the token's admin key | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N | +| 8 | Unfreezes a token on an account but signs with an incorrect freeze key | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N | +| 9 | Unfreezes a token with no freeze key on an account | tokenId=, accountId= | The token unfreeze fails with an TOKEN_HAS_NO_FREEZE_KEY response code from the network. | N | +| 10 | Unfreezes a token that is already unfrozen on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze succeeds. | N | +| 11 | Unfreezes a token on an account that is not associated with the token | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_NOT_ASSOCIATED_WITH_ACCOUNT response code from the network. | N | +| 12 | Unfreezes a paused token on an account | tokenId=, accountId=, commonTransactionParams.signers=[] | The token unfreeze fails with an TOKEN_IS_PAUSED response code from the network. | N | #### JSON Request Example