Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(contracts-rfq): Synapse Intent Router #3433

Merged
merged 16 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import {ISynapseIntentRouter} from "./ISynapseIntentRouter.sol";

interface ISynapseIntentPreviewer {
/// @notice Preview the completion of a user intent.
/// @dev Will not revert if the intent cannot be completed, returns empty values instead.
/// @dev Returns (amountIn, []) if the intent is a no-op (tokenIn == tokenOut).
/// @param swapQuoter Peripheral contract to use for swap quoting
/// @param tokenIn Initial token for the intent
/// @param tokenOut Final token for the intent
/// @param amountIn Initial amount of tokens to use for the intent
/// @return amountOut Final amount of tokens to receive. Zero if the intent cannot be completed.
/// @return steps Steps to use in SynapseIntentRouter in order to complete the intent.
/// Empty if the intent cannot be completed, or if intent is a no-op (tokenIn == tokenOut).
function previewIntent(
address swapQuoter,
address tokenIn,
address tokenOut,
uint256 amountIn
)
external
view
returns (uint256 amountOut, ISynapseIntentRouter.StepParams[] memory steps);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

interface ISynapseIntentRouter {
/// @notice Parameters for a single Zap step.
/// @param token Address of the token to use for the step
/// @param amount Amount of tokens to use for the step (type(uint256).max to use the full ZapRecipient balance)
/// @param msgValue Amount of native token to supply for the step, out of the total `msg.value` used for the
/// `fulfillIntent` call (could differ from `amount` regardless of the token type)
/// @param zapData Instructions for the ZapRecipient contract on how to execute the Zap
struct StepParams {
address token;
uint256 amount;
uint256 msgValue;
bytes zapData;
}

/// @notice Kindly ask SIR to complete the provided intent by completing a series of Zap steps using the
/// provided ZapRecipient contract.
/// - Each step is verified to be a correct Zap as per `IZapRecipient` specification.
/// - The amounts used for each step can be predetermined or based on the proceeds from the previous steps.
/// - SIR does not perform any checks on the Zap Data; the user is responsible for ensuring correct encoding.
/// - The user is responsible for selecting the correct ZapRecipient for their intent: ZapRecipient must be
/// able to modify the Zap Data to adjust to possible changes in the passed amount value.
/// - SIR checks that the ZapRecipient balance for every token in `steps` has not increased after the last step.
/// @dev Typical workflow involves a series of preparation steps followed by the last step representing the user
/// intent such as bridging, depositing, or a simple transfer to the final recipient. The ZapRecipient must be
/// the funds recipient for the preparation steps, while the final recipient must be used for the last step.
/// @dev This function will revert in any of the following cases:
/// - The deadline has passed.
/// - The array of StepParams is empty.
/// - The amount of tokens to use for the last step is below the specified minimum.
/// - Any step fails.
/// - `msg.value` does not match `sum(steps[i].msgValue)`.
/// @param zapRecipient Address of the IZapRecipient contract to use for the Zap steps
/// @param amountIn Initial amount of tokens (steps[0].token) to transfer into ZapRecipient
/// @param minLastStepAmountIn Minimum amount of tokens (steps[N-1].token) to use for the last step
/// @param deadline Deadline for the intent to be completed
/// @param steps Parameters for each step. Use amount = type(uint256).max for steps that
/// should use the full ZapRecipient balance.
function completeIntentWithBalanceChecks(
address zapRecipient,
uint256 amountIn,
uint256 minLastStepAmountIn,
uint256 deadline,
StepParams[] memory steps
)
external
payable;

/// @notice Kindly ask SIR to complete the provided intent by completing a series of Zap steps using the
/// provided ZapRecipient contract.
/// @dev This function is identical to `completeIntentWithBalanceChecks` except that it does not verify that
/// the ZapRecipient balance for every token in `steps` has not increased after the last Zap.
/// Anyone using this function must validate that the funds are fully spent by ZapRecipient
/// using other means like separate on-chain checks or off-chain simulation.
function completeIntent(
address zapRecipient,
uint256 amountIn,
uint256 minLastStepAmountIn,
uint256 deadline,
StepParams[] memory steps
)
external
payable;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

interface ISynapseIntentRouterErrors {
error SIR__AmountInsufficient();
error SIR__DeadlineExceeded();
error SIR__MsgValueIncorrect();
error SIR__StepsNotProvided();
error SIR__TokenNotContract();
error SIR__UnspentFunds();
error SIR__ZapIncorrectReturnValue();
error SIR__ZapNoReturnValue();
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.17;
pragma solidity ^0.8.17;

import {IDefaultPool} from "./IDefaultPool.sol";

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.17;
pragma solidity ^0.8.17;

interface IDefaultPool {
function swap(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.17;
pragma solidity ^0.8.17;

interface IWETH9 {
function deposit() external payable;
Expand Down
Loading
Loading