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.

Sign up for GitHub

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

Jump to bottom

docs: Add test specifications for TokenUnfreezeTransaction #274

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Add test specifications for TokenUnfreezeTransaction #274

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5ce330
docs: add tests
rwalworth Nov 11, 2024
5350bcd
docs: add test
rwalworth Nov 19, 2024
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
141 changes: 141 additions & 0 deletions test-specifications/token-service/tokenUnfreezeTransaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# 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. <CREATED_ACCOUNT_ID> will denote the ID of the account, and <CREATED_ACCOUNT_PRIVATE_KEY> will denote the private key of the created account as a DER-encoded hex string. <CREATED_TOKEN_ID> will denote the ID of the created token, <CREATED_TOKEN_FREEZE_KEY> will denote the freeze key of the token as a DER-encoded hex string, and <CREATED_TOKEN_ADMIN_KEY> will denote the admin 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=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | The token unfreeze succeeds. | N |
| 2 | Unfreezes a token that doesn't exist on an account | tokenId="123.456.789", accountId=<CREATED_ACCOUNT_ID> | 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=<CREATED_ACCOUNT_ID> | The token unfreeze fails with an SDK internal error. | N |
| 4 | Unfreezes a token with no token ID on an account | accountId=<CREATED_ACCOUNT_ID> | The token unfreeze fails with an INVALID_TOKEN_ID response code from the network. | N |
| 5 | Unfreezes a deleted token on an account | tokenId=<DELETED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<DELETED_TOKEN_FREEZE_KEY>] | 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=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID> | The token unfreeze fails with an INVALID_SIGNATURE response code from the network. | N |
| 7 | Unfreezes a token but signs with the token's admin key | tokenId=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<CREATED_TOKEN_ADMIN_KEY>] | 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=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<INCORRECT_VALID_PRIVATE_KEY>] | 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=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID> | 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=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | The token unfreeze succeeds. | N |
| 11 | Unfreezes a token on an account that is not associated with the token | tokenId=<CREATED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | 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=<PAUSED_TOKEN_ID>, accountId=<CREATED_ACCOUNT_ID>, commonTransactionParams.signers=[<PAUSED_TOKEN_FREEZE_KEY>] | 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=<CREATED_TOKEN_ID>, accountId="123.456.789", commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | 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=<CREATED_TOKEN_ID>, accountId="", commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | The token freeze fails with an SDK internal error. | N |
| 3 | Unfreezes a token on an account with no account ID | tokenId=<CREATED_TOKEN_ID>, commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | The token freeze fails with an INVALID_ACCOUNT_ID response code from the network. | N |
| 4 | Unfreezes a token on a deleted account | tokenId=<DELETED_TOKEN_ID>, accountId=<DELETED_ACCOUNT_ID>, commonTransactionParams.signers=[<CREATED_TOKEN_FREEZE_KEY>] | 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"
}
}
```