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

[L-04] Mismatch Between Documented and Actual Return Type in createClaimMessage Function #59

Open
softstackio opened this issue Sep 10, 2024 · 0 comments

Comments

@softstackio
Copy link

Description:
In the ClaimContract, the createClaimMessage function has a discrepancy between its documented return type and its actual return type. The function comment states that it returns a bytes32, but the function signature and implementation actually return bytes memory. This inconsistency in documentation could lead to confusion for developers using or maintaining the contract.

Recommendation:
To resolve this issue, update the function comment to accurately reflect the actual return type:

/**
* @notice returns the claim message for the provided claim target address.
* @param _claimToAddr address target address for the claim.
* @return bytes memory Encoded claim message.
*/
function createClaimMessage(
   address _claimToAddr,
   bytes memory _postfix
) public view returns (bytes memory) {
   // Function implementation
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant