Liquidity.Party/tycho-protocol-sdk
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(ISwapExecutor): Improve swap executor related docs

Browse Source
This commit is contained in:
Diana Carvalho
2024-08-22 17:06:52 +01:00
parent 299a872160
commit d1e21a8d63
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/README.md
View File

@@ -28,4 +28,5 @@ For indexing purposes, it is required that you provide a [substreams](https://su
### Execution ### Execution
The execution component involves the implementation of the `SwapExecutor` interface, enabling token swaps within the protocol. The `SwapExecutor` is responsible for performing swaps by interacting with the underlying liquidity pools, handling token approvals, managing input/output amounts, and ensuring gas-efficient and secure execution. Each protocol must implement its own `SwapExecutor`, tailored to its specific logic and requirements. For execution purposes, the implementation of the `SwapExecutor` interface is required. Without this component, trades cannot be executed on-chain, making it a critical part of the integration.
The `SwapExecutor` is responsible for performing swaps by interacting with the underlying liquidity pools, handling token approvals, managing input/output amounts, and ensuring gas-efficient and secure execution. Each protocol must implement its own `SwapExecutor`, tailored to its specific logic and requirements.

3
docs/execution/swap-executor.md
View File

@@ -28,8 +28,7 @@ errors, such as invalid parameter lengths or unknown pool types in the swap logi
manage these approvals within the implementation to ensure smooth execution of the swap. manage these approvals within the implementation to ensure smooth execution of the swap.
5. **Token Transfer Support**: Ensure that the implementation supports transferring received tokens to a designated 5. **Token Transfer Support**: Ensure that the implementation supports transferring received tokens to a designated
receiver address, either within the swap function or through an additional transfer step. receiver address, either within the swap function or through an additional transfer step.
6. **Gas Efficiency**: Ensure the implementation is gas-efficient, ideally using assembly where possible, 6. **Gas Efficiency**: Ensure the implementation is gas-efficient. Strive for optimal performance in the swap logic.
though it is not mandatory. Strive for optimal performance in the swap logic
7. **Security Considerations**: Follow common security best practices, such as validating inputs, ensuring proper 7. **Security Considerations**: Follow common security best practices, such as validating inputs, ensuring proper
access control, and safeguarding against reentrancy attacks. access control, and safeguarding against reentrancy attacks.