feat: request module

README.md

@@ -23,7 +23,7 @@ See the [Vulcan Book](https://nomoixyz.github.io/vulcan/) for detailed usage inf
 ## Why Vulcan?
 
 Our goal is to provide:
- 
+
 - Better naming for VM functionality (no more `prank`, `roll`, `warp`, ...)
 - A testing framework with better readability and a familiar syntax
 - Improved ergonomics
@@ -84,3 +84,10 @@ contract TestSomething is Test {
 ## Contributing
 
 At this stage we are looking for all kinds of feedback, as the general direction of the project is not fully defined yet. If you have any ideas to improve naming, ergonomics, or anything else, please open an issue or a PR.
+
+## Acknowledgments
+
+Some of the ideas and code in Vulcan are directly inspired by or adapted from the following projects:
+
+- [forge-std](https://github.com/foundry-rs/forge-std/)
+- [memester-xyz/surl](https://github.com/memester-xyz/surl)

src/_modules/Result.sol

@@ -0,0 +1,97 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.13 <0.9.0;
+
+struct Error {
+    bytes32 id;
+    string message;
+}
+
+enum ResultType {
+    Error,
+    Ok
+}
+
+struct Result {
+    ResultType _type;
+    bytes _data;
+}
+
+struct StringResult {
+    Result _inner;
+}
+
+library LibResult {
+    function isError(Result memory self) internal pure returns (bool) {
+        return self._type == ResultType.Error;
+    }
+
+    function isOk(Result memory self) internal pure returns (bool) {
+        return self._type == ResultType.Ok;
+    }
+
+    function toError(Result memory self) internal pure returns (Error memory) {
+        return abi.decode(self._data, (Error));
+    }
+
+    function toValue(Result memory self) internal pure returns (bytes memory) {
+        return self._data;
+    }
+
+    function unwrap(Result memory self) internal pure returns (bytes memory) {
+        if (self.isError()) {
+            revert(self.toError().message);
+        }
+
+        return self._data;
+    }
+
+    function expect(Result memory self, string memory err) internal pure returns (bytes memory) {
+        if (self.isError()) {
+            revert(err);
+        }
+
+        return self._data;
+    }
+
+    function toResult(Error memory error) internal pure returns (Result memory) {
+        return Result({_type: ResultType.Error, _data: abi.encode(error)});
+    }
+}
+
+library LibStringResult {
+    function isOk(StringResult memory self) internal pure returns (bool) {
+        return self._inner.isOk();
+    }
+
+    function isError(StringResult memory self) internal pure returns (bool) {
+        return self._inner.isError();
+    }
+
+    function unwrap(StringResult memory self) internal pure returns (string memory) {
+        return string(self._inner.unwrap());
+    }
+
+    function expect(StringResult memory self, string memory err) internal pure returns (string memory) {
+        return string(self._inner.expect(err));
+    }
+
+    function toError(StringResult memory self) internal pure returns (Error memory) {
+        return self._inner.toError();
+    }
+
+    function toValue(StringResult memory self) internal pure returns (string memory) {
+        return string(self._inner.toValue());
+    }
+}
+
+function Ok(bytes memory value) pure returns (Result memory) {
+    return Result({_type: ResultType.Ok, _data: value});
+}
+
+function Ok(string memory value) pure returns (StringResult memory) {
+    return StringResult(Ok(bytes(value)));
+}
+
+using LibStringResult for StringResult global;
+using LibResult for Result global;
+using LibResult for Error global;