trails-contracts/src/interfaces/ITrailsIntentEntrypoint.sol at 3184e8c0a3efb1a82964b8df257e0e0d59e41a73 · 0xsequence/trails-contracts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.30;

/// @title ITrailsIntentEntrypoint
/// @notice Interface for the TrailsIntentEntrypoint contract
interface ITrailsIntentEntrypoint {
    // -------------------------------------------------------------------------
    // Types
    // -------------------------------------------------------------------------

    struct Signature {
        uint8 v;
        bytes32 r;
        bytes32 s;
    }

    // -------------------------------------------------------------------------
    // Events
    // -------------------------------------------------------------------------

    /// @notice Emitted when a user deposits tokens to an intent address
    /// @param user The user making the deposit
    /// @param intentAddress The intent address receiving the deposit
    /// @param amount The amount of tokens deposited
    event IntentDeposit(address indexed user, address indexed intentAddress, uint256 amount);

    /// @notice Emitted when a fee is paid.
    /// @param user The account from which the fee was taken.
    /// @param feeToken The ERC-20 token used to pay the fee.
    /// @param feeAmount The amount of the fee paid.
    /// @param feeCollector The address receiving the fee.
    event FeePaid(address indexed user, address indexed feeToken, uint256 feeAmount, address indexed feeCollector);

    // -------------------------------------------------------------------------
    // Views
    // -------------------------------------------------------------------------

    /// @notice Returns the EIP-712 domain separator used for intent signatures.
    /// forge-lint: disable-next-line(mixed-case-function)
    function DOMAIN_SEPARATOR() external view returns (bytes32);

    /// @notice Returns the trails intent typehash constant used in EIP-712 signatures.
    /// forge-lint: disable-next-line(mixed-case-function)
    function TRAILS_INTENT_TYPEHASH() external view returns (bytes32);

    /// @notice Returns the version string of the contract.
    /// forge-lint: disable-next-line(mixed-case-function)
    function VERSION() external view returns (string memory);

    /// @notice Returns the current nonce for a given user.
    /// @param user The user address to query.
    function nonces(address user) external view returns (uint256);

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    /// @notice Deposit tokens to an intent address using ERC20 permit
    /// @param user The user making the deposit
    /// @param token The token to deposit (also used for fee payment)
    /// @param amount The amount to deposit
    /// @param permitAmount The amount to permit for spending (amount + feeAmount if paying fee)
    /// @param intentAddress The intent address to deposit to
    /// @param deadline The permit deadline
    /// @param nonce The nonce for this user
    /// @param feeAmount The amount of fee to pay (0 for no fee, paid in same token)
    /// @param feeCollector The address to receive the fee (address(0) for no fee)
    /// @param description A description string for the intent
    /// @param permitSig The permit signature (v, r, s)
    /// @param intentSig The intent signature (v, r, s)
    function depositToIntentWithPermit(
        address user,
        address token,
        uint256 amount,
        uint256 permitAmount,
        address intentAddress,
        uint256 deadline,
        uint256 nonce,
        uint256 feeAmount,
        address feeCollector,
        string calldata description,
        Signature calldata permitSig,
        Signature calldata intentSig
    ) external;

    /// @notice Deposit tokens to an intent address (requires prior approval)
    /// @param user The user making the deposit
    /// @param token The token to deposit (also used for fee payment)
    /// @param amount The amount to deposit
    /// @param intentAddress The intent address to deposit to
    /// @param deadline The intent deadline
    /// @param nonce The nonce for this user
    /// @param feeAmount The amount of fee to pay (0 for no fee, paid in same token)
    /// @param feeCollector The address to receive the fee (address(0) for no fee)
    /// @param description A description string for the intent
    /// @param intentSig The intent signature (v, r, s)
    function depositToIntent(
        address user,
        address token,
        uint256 amount,
        address intentAddress,
        uint256 deadline,
        uint256 nonce,
        uint256 feeAmount,
        address feeCollector,
        string calldata description,
        Signature calldata intentSig
    ) external;
}