feat!: use results on fs module (#191)

* feat!: use results on fs module

Refactor the fs module to use results and errors.

Closes #169

* chore: add result to readLine

* chore: use results for metadata

* chore: add empty result

* chore: add results to other fs functions

* chore: add results to the rest of the functions

* chore: export results from test.sol

* chore: add missing lib for metadata result

* chore: export FsMetadataResult from test.sol

* test: update fs tests

* style: run forge fmt

* chore: remove println from fe module

* feat!: use results on `fe.getBytecode`

* chore: review comments

---------

Co-authored-by: gnkz <[email protected]>

foundry.toml

@@ -5,6 +5,7 @@ libs = ['lib']
 ffi = true
 fs_permissions = [
     { access = "read", path = "./out"},
+    { access = "read", path = "./test/_modules" },
     { access = "read", path = "./test/fixtures/fs/read" },
     { access = "read-write", path = "./test/fixtures/fs/write" },
     { access = "read-write", path = "./test/fixtures/fe/output" }

src/_modules/Error.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.13;
 
 import {Pointer} from "./Pointer.sol";
-import {LibResultPointer, ResultType} from "./Result.sol";
+import {LibResultPointer, ResultType, StringResult, BytesResult, BoolResult} from "./Result.sol";
 
 type Error is bytes32;
 
@@ -105,6 +105,18 @@ library LibError {
         (,, bytes memory data) = decode(err);
         return abi.decode(data, (string));
     }
+
+    function toStringResult(Error self) internal pure returns (StringResult) {
+        return StringResult.wrap(Pointer.unwrap(self.toPointer()));
+    }
+
+    function toBytesResult(Error self) internal pure returns (BytesResult) {
+        return BytesResult.wrap(Pointer.unwrap(self.toPointer()));
+    }
+
+    function toBoolResult(Error self) internal pure returns (BoolResult) {
+        return BoolResult.wrap(Pointer.unwrap(self.toPointer()));
+    }
 }
 
 using LibError for Error global;

src/_modules/Fe.sol

@@ -5,6 +5,7 @@ import "./Commands.sol";
 import "./Strings.sol";
 import "./Fs.sol";
 import {formatError} from "../_utils/formatError.sol";
+import {BoolResult, BytesResult} from "./Result.sol";
 
 struct Fe {
     string compilerPath;
@@ -80,13 +81,9 @@ library fe {
 
     /// @dev Obtains the bytecode of a compiled contract with `contractName`.
     /// @param contractName The name of the contract from which to retrive the bytecode.
-    function getBytecode(Fe memory self, string memory contractName) internal view returns (bytes memory) {
+    function getBytecode(Fe memory self, string memory contractName) internal view returns (BytesResult) {
         string memory path = string.concat(self.outputDir, "/", contractName, "/", contractName, ".bin");
 
-        if (!fs.fileExists(path)) {
-            revert(_formatError("getBytecode(Fe,string))", "Contract not found"));
-        }
-
         return fs.readFileBinary(path);
     }