Skip to content

Commit

Permalink
Merge pull request #32 from propeller-heads/dc/open-protosim
Browse files Browse the repository at this point in the history
docs: Add disclaimer to Readme.md
  • Loading branch information
dianacarvalho1 authored Nov 4, 2024
2 parents eb71531 + bd56d9a commit 59709b4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Protosim

**Disclaimer: This repository is currently in its alpha release stage and is intended for workshop use only.
It is not production-ready, and we will not ensure backward compatibility at this stage.
A proper launch will follow soon.**

Moves slow on-chain computations off-chain to solve optimization problems.

This crate allows simulating a set of supported protocols off-chain. Currently, it has a focus on token exchange
Expand All @@ -19,7 +23,7 @@ aware of the state-mutating events and can transition their state correctly give
- Uniswap V2 and Forks
- Uniswap V3

See also `evm_simulation` module which can simulate any transaction.
See also `evm` module which can simulate any transaction.

## Adding a new Protocol

Expand Down

0 comments on commit 59709b4

Please sign in to comment.