Skip to content

Commit

Permalink
Implementation of toEthAddress function (#23)
Browse files Browse the repository at this point in the history 
* added unit tests

* fix and add some cases

* fix

* POC for validate function

* new cases added, validate function updated

* validate/test updates

* validate default return value back to true
  • Loading branch information
@vaniiiii
vaniiiii authored Nov 8, 2023
1 parent a8826e2 commit cee55f7
Show file tree
Hide file tree
Showing 3 changed files with 305 additions and 7 deletions.
293 changes: 293 additions & 0 deletions contracts/v0.8/tests/filladdress.test.sol
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
// SPDX-License-Identifier: Apache-2.0
pragma solidity ^0.8.17;

import {Test} from "forge-std/Test.sol";
import {FilAddresses} from "contracts/v0.8/utils/FilAddresses.sol";
import {FilAddressIdConverter} from "contracts/v0.8/utils/FilAddressIdConverter.sol";
import {CommonTypes} from "contracts/v0.8/types/CommonTypes.sol";

contract FilAddressesTest is Test {
address testAddress = makeAddr("testaddress");

error InvalidAddress();

// UNIT TESTS
function test_fromEthAddress() external {
bytes memory filAddress = FilAddresses.fromEthAddress(testAddress).data;
assertEq(filAddress, abi.encodePacked(hex"040a", testAddress));
}

function test_toEthAddress() external {
CommonTypes.FilAddress memory filAddress = CommonTypes.FilAddress(abi.encodePacked(hex"040a", testAddress));
address ethAddress = FilAddresses.toEthAddress(filAddress);
assertEq(testAddress, ethAddress);
}

function test_toEthAddressInvalidFirstByte() external {
CommonTypes.FilAddress memory invalidFilAddress =
CommonTypes.FilAddress(abi.encodePacked(hex"000a", testAddress));

vm.expectRevert(InvalidAddress.selector);
FilAddresses.toEthAddress(invalidFilAddress);
}

function test_toEthAddressInvalidSecondByte() external {
CommonTypes.FilAddress memory invalidFilAddress =
CommonTypes.FilAddress(abi.encodePacked(hex"0400", testAddress));

vm.expectRevert(InvalidAddress.selector);
FilAddresses.toEthAddress(invalidFilAddress);
}

function test_toEthAddressInvalidLength() external {
CommonTypes.FilAddress memory invalidFilAddress =
CommonTypes.FilAddress(abi.encodePacked(hex"040a", testAddress, hex"00"));

vm.expectRevert(InvalidAddress.selector);
FilAddresses.toEthAddress(invalidFilAddress);
}

function test_fromActorID() external {
CommonTypes.FilAddress memory result = FilAddresses.fromActorID(1000);
assertEq(keccak256(result.data), keccak256(hex"00e807"));

result = FilAddresses.fromActorID(type(uint64).max);
assertEq(keccak256(result.data), keccak256(hex"00ffffffffffffffffff01"));
}

function test_fromBytes() external {
CommonTypes.FilAddress memory result = FilAddresses.fromBytes(hex"000a");
assertEq(keccak256(result.data), keccak256(hex"000a"));

result = FilAddresses.fromBytes(hex"00ffffffffffffffffff01");
assertEq(keccak256(result.data), keccak256(hex"00ffffffffffffffffff01"));

result = FilAddresses.fromBytes(hex"01fd1d0f4dfcd7e99afcb99a8326b7dc459d32c628");
assertEq(keccak256(result.data), keccak256(hex"01fd1d0f4dfcd7e99afcb99a8326b7dc459d32c628"));

result = FilAddresses.fromBytes(hex"02e54dea4f9bc5b47d261819826d5e1fbf8bc5503b");
assertEq(keccak256(result.data), keccak256(hex"02e54dea4f9bc5b47d261819826d5e1fbf8bc5503b"));

result = FilAddresses.fromBytes(
hex"03ad58df696e2d4e91ea86c881e938ba4ea81b395e12797b84b9cf314b9546705e839c7a99d606b247ddb4f9ac7a3414dd"
);
assertEq(
keccak256(result.data),
keccak256(
hex"03ad58df696e2d4e91ea86c881e938ba4ea81b395e12797b84b9cf314b9546705e839c7a99d606b247ddb4f9ac7a3414dd"
)
);

result = FilAddresses.fromBytes(hex"040a71C7656EC7ab88b098defB751B7401B5f6d8976F");
assertEq(keccak256(result.data), keccak256(hex"040a71C7656EC7ab88b098defB751B7401B5f6d8976F"));
}

function test_fromBytesFirstByte0x00InvalidInputLengthShort() external {
bytes memory invalidInput = hex"00";
vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(invalidInput);
}

function test_fromBytesFirstByte0x00InvalidInputLengthLong() external {
bytes memory invalidInput = abi.encodePacked(hex"00", new bytes(11));
vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(invalidInput);
}

function test_fromBytesFirstByte0x01InvalidInput() external {
bytes memory invalidInput = abi.encodePacked(hex"01", new bytes(21));
vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(invalidInput);
}

function test_fromBytesFirstByte0x02InvalidInput() external {
bytes memory invalidInput = abi.encodePacked(hex"02", new bytes(21));
vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(invalidInput);
}

function test_fromBytesFirstByte0x03InvalidInput() external {
bytes memory invalidInput = abi.encodePacked(hex"03", new bytes(49));
vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(invalidInput);
}

function test_fromBytesFirstByte0x04InvalidInputLength() external {
bytes memory invalidInput = abi.encodePacked(hex"040a", new bytes(21));
vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(invalidInput);
}

function test_validate() external pure {
CommonTypes.FilAddress memory inputAddress = CommonTypes.FilAddress(hex"0001");
assert(FilAddresses.validate(inputAddress));

inputAddress = FilAddresses.fromActorID(type(uint64).max);
assert(FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"01", new bytes(20)));
assert(FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"02", new bytes(20)));
assert(FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"03", new bytes(48)));
assert(FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"040a", new bytes(20)));
assert(FilAddresses.validate(inputAddress));
}

function test_validateInvalidInput() external pure {
CommonTypes.FilAddress memory inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"00", new bytes(11)));
assert(!FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(hex"00");
assert(!FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"01", new bytes(19)));
assert(!FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"02", new bytes(19)));
assert(!FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"03", new bytes(47)));
assert(!FilAddresses.validate(inputAddress));

inputAddress = CommonTypes.FilAddress(abi.encodePacked(hex"040a", new bytes(21)));
assert(!FilAddresses.validate(inputAddress));
}

// FUZZING TESTS
function testFuzz_toEthAddressInvalidFirstByte(address addr, bytes1 firstByte) public {
vm.assume(firstByte != hex"04");
CommonTypes.FilAddress memory filAddress = CommonTypes.FilAddress(abi.encodePacked(firstByte, hex"0a", addr));

vm.expectRevert(InvalidAddress.selector);
FilAddresses.toEthAddress(filAddress);
}

function testFuzz_toEthAddressInvalidSecondByte(address addr, bytes1 secondByte) public {
vm.assume(secondByte != hex"0a");
CommonTypes.FilAddress memory filAddress = CommonTypes.FilAddress(abi.encodePacked(hex"04", secondByte, addr));

vm.expectRevert(InvalidAddress.selector);
FilAddresses.toEthAddress(filAddress);
}

function testFuzz_toEthAddressInvalidBytesLength(address addr, bytes1 endByte) public {
CommonTypes.FilAddress memory filAddress = CommonTypes.FilAddress(abi.encodePacked("040a", addr, endByte));

vm.expectRevert(InvalidAddress.selector);
FilAddresses.toEthAddress(filAddress);
}

function testFuzz_toEthAddress(address addr) public {
bytes memory addrBytes = abi.encodePacked(addr);
bytes memory filAddressBytes = abi.encodePacked(hex"040a", addrBytes);
CommonTypes.FilAddress memory filAddress = CommonTypes.FilAddress(filAddressBytes);

address ethAddress = FilAddresses.toEthAddress(filAddress);

assertEq(addr, ethAddress);
}

function testFuzz_fromEthAddress(address addr) public {
bytes memory addrBytes = abi.encodePacked(addr);
bytes memory filAddressBytes = abi.encodePacked(hex"040a", addrBytes);

CommonTypes.FilAddress memory filAddress = FilAddresses.fromEthAddress(addr);

assertEq(filAddressBytes, filAddress.data);
}

function testFuzz_fromBytesFirstByte0x00(bytes memory data) public {
vm.assume(data.length > 1 && data.length <= 11);
data[0] = 0x00;

CommonTypes.FilAddress memory filAddress = FilAddresses.fromBytes(data);
assertEq(data, filAddress.data);
}

function testFuzz_fromBytesFirstByte0x00InvalidLength(bytes memory data) public {
vm.assume(data.length > 11 || data.length == 1);
data[0] = 0x00;

vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(data);
}

function testFuzz_fromBytesFirstByte0x01(bytes memory data) public {
vm.assume(data.length == 21);
data[0] = 0x01;

CommonTypes.FilAddress memory filAddress = FilAddresses.fromBytes(data);
assertEq(data, filAddress.data);
}

function testFuzz_fromBytesFirstByte0x01InvalidLength(bytes memory data) public {
vm.assume(data.length > 0 && data.length != 21);
data[0] = 0x01;

vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(data);
}

function testFuzz_fromBytesFirstByte0x02(bytes memory data) public {
vm.assume(data.length == 21);
data[0] = 0x02;

CommonTypes.FilAddress memory filAddress = FilAddresses.fromBytes(data);
assertEq(data, filAddress.data);
}

function testFuzz_fromBytesFirstByte0x02InvalidLength(bytes memory data) public {
vm.assume(data.length > 0 && data.length != 21);
data[0] = 0x02;

vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(data);
}

function testFuzz_fromBytesFirstByte0x03(bytes memory data) public {
vm.assume(data.length == 49);
data[0] = 0x03;

CommonTypes.FilAddress memory filAddress = FilAddresses.fromBytes(data);
assertEq(data, filAddress.data);
}

function testFuzz_fromBytesFirstByte0x03InvalidLength(bytes memory data) public {
vm.assume(data.length > 0 && data.length != 49);
data[0] = 0x03;

vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(data);
}

function testFuzz_fromBytesFirstByte0x04(bytes memory data) public {
vm.assume(data.length == 22);
data[0] = 0x04;
data[1] = 0x0a;

CommonTypes.FilAddress memory filAddress = FilAddresses.fromBytes(data);
assertEq(data, filAddress.data);
}

function testFuzz_fromBytesFirstByte0x04InvalidLength(bytes memory data) public {
vm.assume(data.length > 1 && data.length != 22);
data[0] = 0x04;
data[1] = 0x0a;

vm.expectRevert(InvalidAddress.selector);
FilAddresses.fromBytes(data);
}

function testFuzz_fromActorId(uint64 actorId) public {
vm.assume(actorId > 0 && actorId < 50);
// conversion to uint16 needed to get actorId in two bytes
bytes memory actorIdBytes = abi.encodePacked(uint16(actorId));
CommonTypes.FilAddress memory filAddress = FilAddresses.fromActorID(actorId);
assertEq(filAddress.data, actorIdBytes);
}
}
18 changes: 12 additions & 6 deletions contracts/v0.8/utils/FilAddresses.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,17 @@ library FilAddresses {
/// @notice allow to get a eth address from 040a type FilAddress made above
/// @param addr FilAddress to convert
/// @return new eth address
function toEthAddress(CommonTypes.FilAddress calldata addr) internal pure returns (address) {
function toEthAddress(CommonTypes.FilAddress memory addr) internal pure returns (address) {
if (addr.data[0] != 0x04 || addr.data[1] != 0x0a || addr.data.length != 22) {
revert InvalidAddress();
}
bytes20 ethAddress = bytes20(bytes(addr.data)[2:]);
bytes memory filAddress = addr.data;
bytes20 ethAddress;

assembly {
ethAddress := mload(add(filAddress, 0x22))
}

return address(ethAddress);
}

Expand Down Expand Up @@ -73,15 +79,15 @@ library FilAddresses {
/// @return whether the address is valid or not
function validate(CommonTypes.FilAddress memory addr) internal pure returns (bool) {
if (addr.data[0] == 0x00) {
return addr.data.length <= 10;
return (addr.data.length > 1 && addr.data.length <= 11);
} else if (addr.data[0] == 0x01 || addr.data[0] == 0x02) {
return addr.data.length == 21;
} else if (addr.data[0] == 0x03) {
return addr.data.length == 49;
} else if (addr.data[0] == 0x04) {
return addr.data.length <= 64;
} else if (addr.data[0] == 0x04 && addr.data[1] == 0x0a) {
return addr.data.length == 22;
}

return addr.data.length <= 256;
}
}
}
1 change: 0 additions & 1 deletion foundry.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ cache_path = 'foundry-cache'
optimizer = true
evm_version = 'paris'


[fuzz]
runs = 200

Expand Down

0 comments on commit cee55f7

Please sign in to comment.