Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/memester-xyz/surl
HTTP Library for Solidity based on curl
https://github.com/memester-xyz/surl
Last synced: about 2 months ago
JSON representation
HTTP Library for Solidity based on curl
- Host: GitHub
- URL: https://github.com/memester-xyz/surl
- Owner: memester-xyz
- License: mit
- Created: 2022-06-29T07:55:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T16:26:09.000Z (over 1 year ago)
- Last Synced: 2024-05-19T05:50:22.652Z (8 months ago)
- Language: Solidity
- Homepage:
- Size: 32.2 KB
- Stars: 314
- Watchers: 6
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-foundry - surl - HTTP library for Foundry tests in Solidity based on curl. (Templates & Libraries)
README
#
surl
**Perform web requests from Solidity scripts/tests**
## Installation
```
forge install memester-xyz/surl
```
## Usage
1. Add this import to your script or test:
```solidity
import {Surl} from "surl/Surl.sol";
```
2. Add this directive inside of your Contract:
```solidity
using Surl for *;
```
3. Make your HTTP requests:
```solidity
// Perform a simple get request
(uint256 status, bytes memory data) = "https://httpbin.org/get".get();
// Perform a get request with headers
string[] memory headers = new string[](2);
headers[0] = "accept: application/json";
headers[1] = "Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==";
(uint256 status, bytes memory data) = "https://httpbin.org/get".get(headers);
// Perform a post request with headers and JSON body
string[] memory headers = new string[](1);
headers[0] = "Content-Type: application/json";
(uint256 status, bytes memory data) = "https://httpbin.org/post".post(headers, '{"foo": "bar"}');
// Perform a put request
(uint256 status, bytes memory data) = "https://httpbin.org/put".put();
// Perform a patch request
(uint256 status, bytes memory data) = "https://httpbin.org/put".patch();
// Perform a delete request (unfortunately 'delete' is a reserved keyword and cannot be used as a function name)
(uint256 status, bytes memory data) = "https://httpbin.org/delete".del();
```
4. You must enable [ffi](https://book.getfoundry.sh/cheatcodes/ffi.html) in order to use the library. You can either pass the `--ffi` flag to any forge commands you run (e.g. `forge script Script --ffi`), or you can add `ffi = true` to your `foundry.toml` file.
### Notes
- It assumes you are running on a UNIX based machine with `bash`, `tail`, `sed`, `tr`, `curl` and `cast` installed.
## Example
We have example usage for both [tests](./test/Surl.t.sol) and [scripts](./script/). The tests also demonstrate how surl can be used to request quotes from DEX aggregators and parse their json response with [cheatcodes](https://book.getfoundry.sh/cheatcodes/parse-json).
## Contributing
Clone this repo and run:
```
forge install
```
Get a [1inch API Key](https://1inch.dev/) and set it in a `.env` file (copy `.env.example`).
Make sure all tests pass, add new ones if needed:
```
forge test
```
## Why?
[Forge scripting](https://book.getfoundry.sh/tutorials/solidity-scripting.html) is becoming more popular. With Surl you can extend your scripts easily with HTTP requests.
## Development
This project uses [Foundry](https://getfoundry.sh). See the [book](https://book.getfoundry.sh/getting-started/installation.html) for instructions on how to install and use Foundry.