diff --git a/docs/README.md b/docs/README.md index f10b275..ae0f704 100644 --- a/docs/README.md +++ b/docs/README.md @@ -28,4 +28,5 @@ For indexing purposes, it is required that you provide a [substreams](https://su ### 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. diff --git a/docs/execution/swap-executor.md b/docs/execution/swap-executor.md index c98c3a2..1daddc9 100644 --- a/docs/execution/swap-executor.md +++ b/docs/execution/swap-executor.md @@ -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. 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. -6. **Gas Efficiency**: Ensure the implementation is gas-efficient, ideally using assembly where possible, -though it is not mandatory. Strive for optimal performance in the swap logic +6. **Gas Efficiency**: Ensure the implementation is gas-efficient. Strive for optimal performance in the swap logic. 7. **Security Considerations**: Follow common security best practices, such as validating inputs, ensuring proper access control, and safeguarding against reentrancy attacks.