Tycho Simulation

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 protocols, but it is not necessarily limited to this.

See also: The evm_simulation module allows for simulating any transaction; it is agnostic to protocol. See module's documentation.

Currently supported protocols:

• Uniswap V2 and Forks
• Uniswap V3
• VM enabled protocols

See also evm module which can simulate any transaction.

Adding a new Protocol

To add a new protocol, you will need to complete the following high-level steps:

Native protocol:

1. Create a protocol state struct that implements the ProtocolSim struct.
2. Create a tycho decoder for the protocol state: i.e. implement TryFrom for ComponentWithState to your new protocol state.

Each native protocol should have its own module under tycho-simulation/src/protocol.

VM protocol:

1. Add the associated adapter runtime file to tycho-simulations/src/protocol/assets. Make sure to name the file according to the protocol name used by tycho in the following format: <Protocol><Version>Adapter.evm.runtime. For example: vm:balancer_v2 will be BalancerV2Adapter.evm.runtime.

1. Adding state & behaviour

Simply implement a struct that contains the state of the protocol. Only the attributes that are necessary to fulfill the ProtocolSim trait are required. Then, implement the ProtocolSim trait (see here).

2. Adding Events

Note: The following section describes a legacy approach that is no longer required for implementing event_transition. This information is retained for historical context only and should not be used in new implementations.

In previous versions, we need to implement the event_transition method. This method processed events based on metadata from logs, which were particularly tailored for EVM-based chains. If multiple events were supported by a protocol, they could be grouped into a protocol-specific enum, and converted into the more generic ProtocolEvent enum.

Important: This process is no longer required. The system now handles event transitions more efficiently, so you can disregard this section for new implementations.

Local development

1. Please also make sure that the following commands pass if you have changed the code:

cargo check --all
cargo test --all --all-features
cargo +nightly fmt -- --check
cargo +nightly clippy --workspace --all-features --all-targets -- -D warnings

We are using the stable toolchain for building and testing, but the nightly toolchain for formatting and linting, as it allows us to use the latest features of rustfmt and clippy.

If you are working in VSCode, we recommend you install the rust-analyzer extension, and use the following VSCode user settings:

"editor.formatOnSave": true,
"rust-analyzer.rustfmt.extraArgs": ["+nightly"],
"rust-analyzer.check.overrideCommand": [
"cargo",
"+nightly",
"clippy",
"--workspace",
"--all-features",
"--all-targets",
"--message-format=json"
],
"[rust]": {
"editor.defaultFormatter": "rust-lang.rust-analyzer"
}