all files / contracts/interfaces/ iRouterSequencerCrossTalk.sol

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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
 
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
/// @title iRouterSequencerCrossTalk contract interface for router Crosstalk
/// @author Router Protocol
interface iRouterSequencerCrossTalk is IERC165 {
    struct Params {
        uint8 _destChainID;
        bytes _erc20;
        bytes _swapData;
        bytes _generic;
        uint256 _gasLimit;
        uint256 _gasPrice;
        address _feeToken;
        bool _isTransferFirst;
        bool _isOnlyGeneric;
    }
 
    struct ExecutesStruct {
        uint8 chainID;
        uint64 nonce;
    }
 
    /// @notice Link event is emitted when a new link is created.
    /// @param ChainID Chain id the contract is linked to.
    /// @param linkedContract Contract address linked to.
    event Linkevent(uint8 indexed ChainID, address indexed linkedContract);
 
    /// @notice UnLink event is emitted when a link is removed.
    /// @param ChainID Chain id the contract is unlinked to.
    /// @param linkedContract Contract address unlinked to.
    event Unlinkevent(uint8 indexed ChainID, address indexed linkedContract);
 
    /// @notice CrossTalkSend Event is emited when a request is generated in soruce side when cross chain request is generated.
    /// @param sourceChain Source ChainID.
    /// @param params Params struct.
    /// @param sourceAddress Source Address.
    /// @param destinationAddress Destination Address.
    /// @param _selector Selector to interface on destination side.
    /// @param _hash Hash of the data sent.
    event CrossTalkSend(
        uint8 indexed sourceChain,
        Params params,
        address sourceAddress,
        address destinationAddress,
        bytes4 indexed _selector,
        bytes32 _hash
    );
 
    /// @notice CrossTalkReceive Event is emited when a request is recived in destination side when cross chain request accepted by contract.
    /// @param sourceChain Source ChainID.
    /// @param destChain Destination ChainID.
    /// @param sourceAddress Address of source contract.
    event CrossTalkReceive(
        uint8 indexed sourceChain,
        uint8 indexed destChain,
        address sourceAddress
    );
 
    /// @notice routerSync This is a public function and can only be called by Generic Handler of router infrastructure
    /// @param srcChainID Source ChainID.
    /// @param srcAddress Destination ChainID.
    /// @param genericData Contains abi encoded data for selector and params to be called.
    /// @param settlementToken address of the settlement token.
    /// @param returnAmount amount of settlement token paid to the recipient.
    function routerSync(
        uint8 srcChainID,
        address srcAddress,
        bytes memory genericData,
        address settlementToken,
        uint256 returnAmount
    ) external returns (bool, bytes memory);
 
    /// @notice Link This is a public function and can only be called by Generic Handler of router infrastructure
    /// @notice This function links contract on other chain ID's.
    /// @notice This is an administrative function and can only be initiated by linkSetter address.
    /// @param _chainID network Chain ID linked Contract linked to.
    /// @param _linkedContract Linked Contract address.
    function Link(uint8 _chainID, address _linkedContract) external;
 
    /// @notice UnLink This is a public function and can only be called by Generic Handler of router infrastructure
    /// @notice This function unLinks contract on other chain ID's.
    /// @notice This is an administrative function and can only be initiated by linkSetter address.
    /// @param _chainID network Chain ID linked Contract linked to.
    function Unlink(uint8 _chainID) external;
 
    /// @notice fetchLinkSetter This is a public function and fetches the linksetter address.
    function fetchLinkSetter() external view returns (address);
 
    /// @notice fetchLinkSetter This is a public function and fetches the address the contract is linked to.
    /// @param _chainID Chain ID information.
    function fetchLink(uint8 _chainID) external view returns (address);
 
    /// @notice fetchFeeToken This is a public function and fetches the fee token set by admin.
    function fetchFeeToken() external view returns (address);
 
    /// @notice fetchExecutes This is a public function and fetches the executes struct.
    function fetchExecutes(bytes32 _hash)
        external
        view
        returns (ExecutesStruct memory);
}