diff --git a/README.md b/README.md index 1c0dbd2..5abdbea 100644 --- a/README.md +++ b/README.md @@ -6,110 +6,9 @@ Tycho Execution makes it easy to trade on different DEXs by handling the complex custom code for each DEX, you get a simple, ready-to-use tool that generates the necessary data to execute trades. It's designed to be safe, straightforward, and quick to set up, so anyone can start trading without extra effort. -## Quickstart +For complete documentation, see Tycho docs [here](https://docs.propellerheads.xyz/tycho/for-solvers/execution). -To get started, have a look at our [Quickstart example](examples/quickstart/README.md). +## Examples -## Bin Usage Guide - -### Installation - -First, build and install the binary: - -```bash -# Build the project -cargo build --release - -# Install the binary to your system -cargo install --path . -``` - -After installation, the `tycho-encode` command will be available to use from any directory in your terminal. - -### Commands - -The command lets you choose the encoding strategy to be used. The available strategies are: - -#### Tycho Router - -`tycho-router`: Encodes a transaction using the Tycho Router encoding strategy. - -Example: - -```bash -echo '' | tycho-encode tycho-router -``` - -#### Tycho Router With Permit2 - -`tycho-router-with-permit2`: Encodes a transaction using the Tycho Router encoding strategy. Requires a private key for -signing -Permit2. - -Example: - -```bash -echo '' | tycho-encode tycho-router --swapper-pk 0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234 -``` - -#### Direct execution - -`direct-execution`: Encodes a transaction using the direct execution encoding strategy. Does not require a private key. - -Example: - -```bash -echo '' | tycho-encode direct-execution -``` - -### Encoding Transactions - -The commands accept the following options: - -- `--config_path`: Path to the executor addresses configuration file (defaults - to `src/encoding/config/executor_addresses.json`) -- `--swapper-pk`: Private key for signing approvals (required when direct_execution is false) - -#### Example - -Here's a complete example that encodes a swap from WETH to DAI using Uniswap V2 and the Tycho Router strategy: - -```bash -echo '{"sender":"0x1234567890123456789012345678901234567890","receiver":"0x1234567890123456789012345678901234567890","given_token":"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2","given_amount":"1000000000000000000","checked_token":"0x6B175474E89094C44Da98b954EedeAC495271d0F","exact_out":false,"slippage":0.01,"expected_amount":"1000000000000000000","checked_amount":"990000000000000000","router_address":"0xaa820C29648D5EA543d712cC928377Bd7206a0E7","swaps":[{"component":{"id":"0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640","protocol_system":"uniswap_v2","protocol_type_name":"UniswapV2Pool","chain":"ethereum","tokens":["0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"],"contract_ids":["0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D"],"static_attributes":{"factory":"0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f"},"change":"Update","creation_tx":"0x0000000000000000000000000000000000000000000000000000000000000000","created_at":"2024-02-28T12:00:00"},"token_in":"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2","token_out":"0x6B175474E89094C44Da98b954EedeAC495271d0F","split":0.0}],"direct_execution":true}' | tycho-encode tycho-router-permit2 --swapper-pk 0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234 -``` - -#### JSON Payload Structure: Solution struct - -The `Solution` struct is composed of the following fields: - -- `sender`: The address initiating the transaction -- `receiver`: The address receiving the output tokens -- `given_token`: The address of the input token (e.g., WETH) -- `given_amount`: The amount of input tokens (in wei) -- `checked_token`: The address of the output token (e.g., DAI) -- `exact_out`: Boolean indicating if this is an exact output swap -- `slippage`: The maximum allowed slippage (e.g., 0.01 for 1%) -- `expected_amount`: The expected output amount -- `checked_amount`: The minimum acceptable output amount (accounting for slippage) -- `swaps`: Array of swap steps, each containing: - - `component`: Details about the DEX/protocol being used - - `token_in`: Input token address for this step - - `token_out`: Output token address for this step - - `split`: Proportion of tokens to route through this step (1.0 = 100%) -- `router_address`: The address of the protocol's router contract -- `direct_execution`: Boolean indicating if the transaction should be executed directly - -## Contract Analysis - -We use [Slither](https://github.com/crytic/slither) to detect any potential vulnerabilities in our contracts. - -To run locally, simply install Slither in your conda env and run it inside the foundry directory. - -```bash -conda create --name tycho-execution python=3.10 -conda activate tycho-execution - -pip install slither-analyzer -cd foundry -slither . -``` \ No newline at end of file +To get started on encoding, have a look at our [Encoding example](examples/encoding-example/README.md). +For a complete example please refer to the [Tycho Quickstart guide](https://docs.propellerheads.xyz/tycho). diff --git a/examples/quickstart/README.md b/examples/encoding-example/README.md similarity index 56% rename from examples/quickstart/README.md rename to examples/encoding-example/README.md index 0978ffd..02af49e 100644 --- a/examples/quickstart/README.md +++ b/examples/encoding-example/README.md @@ -1,6 +1,6 @@ -# QuickStart +# Encoding example -This quickstart guide enables you to: +This guide enables you to: 1. Create a Solution object 2. Encode the solution to interact with the Ethereum blockchain @@ -8,5 +8,5 @@ This quickstart guide enables you to: ## How to run ```bash -cargo run --release --example quickstart +cargo run --release --example encoding-example ``` \ No newline at end of file diff --git a/examples/quickstart/main.rs b/examples/encoding-example/main.rs similarity index 100% rename from examples/quickstart/main.rs rename to examples/encoding-example/main.rs