Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/numocash/crawler

🦋 A tool for arbitraging between Numo and Uniswap liquidity pools.
https://github.com/numocash/crawler

amm arbitrage ethereum solidity

Last synced: about 1 month ago
JSON representation

🦋 A tool for arbitraging between Numo and Uniswap liquidity pools.

Host: GitHub
URL: https://github.com/numocash/crawler
Owner: numocash
License: mit
Created: 2023-03-09T14:51:35.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-07-21T02:16:12.000Z (6 months ago)
Last Synced: 2024-11-14T13:38:14.291Z (about 2 months ago)
Topics: amm, arbitrage, ethereum, solidity
Language: Solidity
Homepage:
Size: 1.83 MB
Stars: 9
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Swap Library [![Foundry][foundry-badge]][foundry] [![License: MIT][license-badge]][license]

[gha]: https://github.com/numo-hq/swap-library/actions
[gha-badge]: https://github.com/numo-hq/swap-library/actions/workflows/ci.yml/badge.svg
[foundry]: https://getfoundry.sh/
[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
[license]: https://opensource.org/licenses/MIT
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg

Helper functions for swapping with Numo.

## Examples

- **SwapRouter.sol:** Facilitates swapping on Numo
- **Arbitrage.sol:** Allows for arbitrage between a Uniswap V2 or V3 style exchange and Numo

## Development

### Build

Build the contracts:

```sh
$ forge build
```

### Clean

Delete the build artifacts and cache directories:

```sh
$ forge clean
```

### Compile

Compile the contracts:

```sh
$ forge build
```

### Format

Format the contracts:

```sh
$ forge fmt
```

### Gas Usage

Get a gas report:

```sh
$ forge test --gas-report
```

### Lint

Lint the contracts:

```sh
$ pnpm lint
```

### Test

Run the tests:

```sh
$ forge test
```

## Notes

1. Foundry uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to manage dependencies. For
detailed instructions on working with dependencies, please refer to the
[guide](https://book.getfoundry.sh/projects/dependencies.html) in the book
2. You don't have to create a `.env` file, but filling in the environment variables may be useful when debugging and
testing against a fork.

## License