-
Notifications
You must be signed in to change notification settings - Fork 20
/
IArbitrumBranchPort.sol
47 lines (40 loc) · 1.92 KB
/
IArbitrumBranchPort.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
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IBranchPort} from "./IBranchPort.sol";
/**
* @title Arbitrum Branch Port Contract
* @author MaiaDAO
* @notice Ulyses `Port` implementation for Arbitrum Branch Chain deployment.
* This contract is used to manage the deposit and withdrawal of underlying assets
* from the Arbitrum Branch Chain in response to Branch Bridge Agents' requests.
* Manages Bridge Agents and their factories as well as the chain's strategies and
* their tokens.
*/
interface IArbitrumBranchPort is IBranchPort {
/*///////////////////////////////////////////////////////////////
EXTERNAL FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Function to deposit underlying / native token amount into Port in exchange for Local hToken.
* @param _depositor underlying / native token depositor.
* @param _recipient hToken receiver.
* @param _underlyingAddress underlying / native token address.
* @param _amount amount of tokens.
*/
function depositToPort(address _depositor, address _recipient, address _underlyingAddress, uint256 _amount)
external;
/**
* @notice Function to withdraw underlying / native token amount into Port in exchange for Local hToken.
* @param _depositor underlying / native token depositor.
* @param _recipient hToken receiver.
* @param _globalAddress global hToken address.
* @param _amount amount of tokens.
*/
function withdrawFromPort(address _depositor, address _recipient, address _globalAddress, uint256 _amount)
external;
/*///////////////////////////////////////////////////////////////
ERRORS
//////////////////////////////////////////////////////////////*/
error UnknownToken();
error UnknownUnderlyingToken();
}