Bytecode Verification

[prateek105]

https://trello.com/c/D8IpxaUI/24-fps-bytecode-verification

[ElliotFriedman]

Merge conflicts will need to be resolved with the latest changes that were just merged.

It would be great to see documentation in FPS so that users can understand how to use this system. Documentation should include instructions for users on how to install FPS and install node modules so that this works.

[ElliotFriedman]

Unit tests are failing in CI with error:

Ran 1 test for test/TypeCheck.t.sol:TypeCheck
[FAIL. Reason: setup failed: failed to read from "/home/runner/work/addresses/Addresses.json": No such file or directory (os error 2)] setUp() (gas: 0)

[prateek105]

running

forge test --mc TypeCheck --ffi --fork-url sepolia

locally, this is the output:

No files changed, compilation skipped
2024-04-02T21:41:29.897864Z ERROR cheatcodes: non-empty stderr input=["npx", "ts-node", "typescript/encode.ts", "[[\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", \"0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5000000000000000000000000\", [\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", 2, [\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", 2]]], [\"Arg1\", \"Arg2\"], [2, 3], [[\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", 2, [\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", 2]], [\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", 2, [\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", 2]]]]", "ExampleTypeCheck_02.sol:ExampleTypeCheck_02", "out/"] stderr="/Users/elliot/node_modules/@ethersproject/logger/src.ts/index.ts:269\n        const error: any = new Error(message);\n                           ^\nError: expected array value (argument=null, value=\"0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5\", code=INVALID_ARGUMENT, version=abi/5.7.0)\n    at Logger.makeError (/Users/elliot/node_modules/@ethersproject/logger/src.ts/index.ts:269:28)\n    at Logger.throwError (/Users/elliot/node_modules/@ethersproject/logger/src.ts/index.ts:281:20)\n    at Logger.throwArgumentError (/Users/elliot/node_modules/@ethersproject/logger/src.ts/index.ts:285:21)\n    at ArrayCoder.Coder._throwError (/Users/elliot/node_modules/@ethersproject/abi/src.ts/coders/abstract-coder.ts:68:16)\n    at ArrayCoder.encode (/Users/elliot/node_modules/@ethersproject/abi/src.ts/coders/array.ts:195:18)\n    at /Users/elliot/node_modules/@ethersproject/abi/src.ts/coders/array.ts:62:19\n    at Array.forEach (<anonymous>)\n    at pack (/Users/elliot/node_modules/@ethersproject/abi/src.ts/coders/array.ts:54:12)\n    at ArrayCoder.encode (/Users/elliot/node_modules/@ethersproject/abi/src.ts/coders/array.ts:210:16)\n    at /Users/elliot/node_modules/@ethersproject/abi/src.ts/coders/array.ts:62:19 {\n  reason: 'expected array value',\n  code: 'INVALID_ARGUMENT',\n  argument: null,\n  value: '0x95222290DD7278Aa3Ddd389Cc1E1d165CC4BAfe5'\n}\n"

Ran 3 tests for test/TypeCheck.t.sol:TypeCheck
[PASS] test_typeCheck() (gas: 6622503)
[PASS] test_typeCheckIncorrectArtifact() (gas: 2555888)
[PASS] test_typeCheckIncorrectByteCode() (gas: 5017304)
Suite result: ok. 3 passed; 0 failed; 0 skipped; finished in 9.57s (17.26s CPU time)

This is a required behaviour. This error corresponds to test_typeCheckIncorrectArtifact test. Where we are passing incorrect artifact path to TypeChecker, which leads to this typescript error while encoding. So we want this error.

[ElliotFriedman]

missing lib path here

[prateek105]

A user who has installed fps and is type checking his contracts doesn't need to think about lib path. We have this code vm.envOr("LIB_PATH", string("lib/forge-proposal-simulator/")); in script so lib path will be set by default. I have added this LIB_PATH env so that this script can also be run from the fps repo by setting LIB_PATH as "" just like we do in test.

[ElliotFriedman]

Missing LIB_PATH

[ElliotFriedman]

add example of how to run from CLI from within FPS

TYPE_CHECK_ADDRESSES_PATH=addresses/TypeCheckAddresses.json ADDRESSES_PATH=addresses/Addresses.json ARTIFACT_PATH=out/ LIB_PATH= forge script script/TypeCheck.s.sol:TypeCheck --ffi --fork-url  sepolia

[prateek105]

done here ddea628

[ElliotFriedman]

LGTM!