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

fix(TAP-Verifier): Corrects the name of receipt aggregate voucher str… #49

Merged
merged 1 commit into from
Aug 17, 2023
Merged

fix(TAP-Verifier): Corrects the name of receipt aggregate voucher str… #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/TAPVerifier.sol
View file
Open in desktop
Expand Up @@ -11,14 +11,14 @@ import {EIP712} from "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
* @dev A contract for verifying receipt aggregation vouchers.
*/
contract TAPVerifier is EIP712 {
struct ReceiptAggregationVoucher {
struct ReceiptAggregateVoucher {
address allocationId;
uint64 timestampNs;
uint128 valueAggregate;
}

struct SignedRAV {
ReceiptAggregationVoucher rav;
ReceiptAggregateVoucher rav;
bytes signature; // 65 bytes: r (32 Bytes) || s (32 Bytes) || v (1 Byte)
}

Expand All @@ -34,7 +34,7 @@ contract TAPVerifier is EIP712 {
constructor(string memory name, string memory version) EIP712(name, version) {}

/**
* @dev Recovers the signer address of a signed ReceiptAggregationVoucher (RAV).
* @dev Recovers the signer address of a signed ReceiptAggregateVoucher (RAV).
* @param signedRAV The SignedRAV containing the RAV and its signature.
* @return The address of the signer.
* @notice REVERT: This function may revert if ECDSA.recover fails, check ECDSA library for details.
Expand All @@ -61,12 +61,12 @@ contract TAPVerifier is EIP712 {
}

/**
* @dev Computes the hash of a ReceiptAggregationVoucher (RAV).
* @dev Computes the hash of a ReceiptAggregateVoucher (RAV).
* @param rav The RAV for which to compute the hash.
* @return The hash of the RAV.
*/
function hashRAV(
ReceiptAggregationVoucher calldata rav
ReceiptAggregateVoucher calldata rav
) public view returns (bytes32) {
return
_hashTypedDataV4(
Expand Down
4 changes: 2 additions & 2 deletions test/Escrow.t.sol
View file
Open in desktop
Expand Up @@ -418,8 +418,8 @@ contract EscrowContractTest is Test {
uint256 authorizedSignerPrivateKey
) private view returns (TAPVerifier.SignedRAV memory) {
// Create a RAV
TAPVerifier.ReceiptAggregationVoucher memory rav =
TAPVerifier.ReceiptAggregationVoucher(allocationID, timestampNs, aggregateAmount);
TAPVerifier.ReceiptAggregateVoucher memory rav =
TAPVerifier.ReceiptAggregateVoucher(allocationID, timestampNs, aggregateAmount);
bytes32 digest = tap_verifier.hashRAV(rav);

// Sign the digest using the authorized signer's private key
Expand Down
48 changes: 24 additions & 24 deletions test/TapVerifier.t.sol
View file
Open in desktop
Expand Up @@ -26,11 +26,11 @@ contract TAPVerifierTest is Test {
}

/**
* @notice Test case for recovering the signer from a signed ReceiptAggregationVoucher (RAV).
* @notice Test case for recovering the signer from a signed ReceiptAggregateVoucher (RAV).
*/
function testRecoverSignature() public {
// Create a sample ReceiptAggregationVoucher (RAV)
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 10, 158);
// Create a sample ReceiptAggregateVoucher (RAV)
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 10, 158);

// Compute the digest of the RAV
bytes32 digest = tap_verifier.hashRAV(rav);
Expand All @@ -49,14 +49,14 @@ contract TAPVerifierTest is Test {
}

/**
* @notice Test case using a valid ReceiptAggregationVoucher (RAV) and its signature sampled from the Rust library.
* @notice Test case using a valid ReceiptAggregateVoucher (RAV) and its signature sampled from the Rust library.
* The test uses a pre-generated sample RAV and its signature, created using the same mnemonic for the signer as the
* signer in the test contract's setup. It then recovers the signer address from the signed RAV and asserts that it
* matches the expected signer address.
*/
function testSampledValidRAV() public {
// Sampled RAV and signature (created using the same mnemonic for the signer)
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 10, 158);
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 10, 158);
(uint8 v, bytes32 r, bytes32 s) = (
27,
0x6a18671465401bf0003b88048eccefaa7c6961168d2dfd3d12b9485cb857ddca,
Expand All @@ -73,12 +73,12 @@ contract TAPVerifierTest is Test {

/**
* @notice Test case with an invalid allocation ID.
* The test modifies the allocation ID of a signed ReceiptAggregationVoucher (RAV) to an invalid value
* The test modifies the allocation ID of a signed ReceiptAggregateVoucher (RAV) to an invalid value
* and asserts that the recovered signer is not the expected signer address.
*/
function testRAVInvalidAllocationID() public {
// Create a ReceiptAggregationVoucher (RAV)
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 10, 158);
// Create a ReceiptAggregateVoucher (RAV)
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 10, 158);

// Compute the digest of the RAV
bytes32 digest = tap_verifier.hashRAV(rav);
Expand All @@ -101,12 +101,12 @@ contract TAPVerifierTest is Test {

/**
* @notice Test case with an invalid Timestamp.
* The test modifies the Timestamp of a signed ReceiptAggregationVoucher (RAV) to an invalid value
* The test modifies the Timestamp of a signed ReceiptAggregateVoucher (RAV) to an invalid value
* and asserts that the recovered signer is not the expected signer address.
*/
function testRAVInvalidTimestamp() public {
// Create a ReceiptAggregationVoucher (RAV)
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 10, 158);
// Create a ReceiptAggregateVoucher (RAV)
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 10, 158);

// Compute the digest of the RAV
bytes32 digest = tap_verifier.hashRAV(rav);
Expand All @@ -129,12 +129,12 @@ contract TAPVerifierTest is Test {

/**
* @notice Test case with an invalid value aggregate.
* The test modifies the value aggregate of a signed ReceiptAggregationVoucher (RAV) to an invalid value
* The test modifies the value aggregate of a signed ReceiptAggregateVoucher (RAV) to an invalid value
* and asserts that the recovered signer is not the expected signer address.
*/
function testRAVInvalidValueAggregate() public {
// Create a ReceiptAggregationVoucher (RAV)
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 10, 158);
// Create a ReceiptAggregateVoucher (RAV)
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 10, 158);

// Compute the digest of the RAV
bytes32 digest = tap_verifier.hashRAV(rav);
Expand All @@ -157,12 +157,12 @@ contract TAPVerifierTest is Test {

/**
* @notice Test case for an invalid signature.
* The test creates a sample ReceiptAggregationVoucher (RAV) and an invalid signature (tampered with or incorrect).
* The test creates a sample ReceiptAggregateVoucher (RAV) and an invalid signature (tampered with or incorrect).
* It then attempts to recover the signer address from the signed RAV, expecting a revert due to the invalid signature.
*/
function testInvalidSignature() public {
// Create a sample ReceiptAggregationVoucher (RAV)
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 10, 158);
// Create a sample ReceiptAggregateVoucher (RAV)
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 10, 158);

// Create an invalid signature (e.g., tampered with or incorrect)
(uint8 v, bytes32 r, bytes32 s) = (27, bytes32(0), bytes32(0));
Expand All @@ -176,13 +176,13 @@ contract TAPVerifierTest is Test {
}

/**
* @notice Test case for the edge scenario with minimum values for timestamp_ns and value_aggregate in ReceiptAggregationVoucher.
* The test creates a ReceiptAggregationVoucher with minimum values and signs it.
* @notice Test case for the edge scenario with minimum values for timestamp_ns and value_aggregate in ReceiptAggregateVoucher.
* The test creates a ReceiptAggregateVoucher with minimum values and signs it.
* It then recovers the signer address from the signed RAV and asserts that it matches the expected signer address.
*/
function testEdgeCaseMinValuedRav() public {
// Test with minimum values for timestamp_ns and value_aggregate
TAPVerifier.ReceiptAggregationVoucher memory rav = TAPVerifier.ReceiptAggregationVoucher(address(0x1), 0, 0);
TAPVerifier.ReceiptAggregateVoucher memory rav = TAPVerifier.ReceiptAggregateVoucher(address(0x1), 0, 0);
bytes32 digest = tap_verifier.hashRAV(rav);
(uint8 v, bytes32 r, bytes32 s) = vm.sign(signerPrivateKey, digest);
TAPVerifier.SignedRAV memory signed_rav = TAPVerifier.SignedRAV(rav, abi.encodePacked(r, s, v));
Expand All @@ -191,14 +191,14 @@ contract TAPVerifierTest is Test {
}

/**
* @notice Test case for the edge scenario with maximum values for timestamp_ns and value_aggregate in ReceiptAggregationVoucher.
* The test creates a ReceiptAggregationVoucher with maximum values and signs it.
* @notice Test case for the edge scenario with maximum values for timestamp_ns and value_aggregate in ReceiptAggregateVoucher.
* The test creates a ReceiptAggregateVoucher with maximum values and signs it.
* It then recovers the signer address from the signed RAV and asserts that it matches the expected signer address.
*/
function testEdgeCaseMaxValuedRav() public {
// Test with maximum values for timestamp_ns and value_aggregate
TAPVerifier.ReceiptAggregationVoucher memory rav =
TAPVerifier.ReceiptAggregationVoucher(address(0x1), type(uint64).max, type(uint128).max);
TAPVerifier.ReceiptAggregateVoucher memory rav =
TAPVerifier.ReceiptAggregateVoucher(address(0x1), type(uint64).max, type(uint128).max);
bytes32 digest = tap_verifier.hashRAV(rav);
(uint8 v, bytes32 r, bytes32 s) = vm.sign(signerPrivateKey, digest);
TAPVerifier.SignedRAV memory signed_rav = TAPVerifier.SignedRAV(rav, abi.encodePacked(r, s, v));
Expand Down