all files / contracts/interfaces/ IBridgeWrapper.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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity 0.8.6;
 
 
/**
 * @title Bridge Wrapper
 * @author solace.fi
 * @notice Facilitates cross chain apps by wrapping and unwrapping bridged tokens.
 *
 * Users will start by bridging [**SOLACE**](./../SOLACE) from mainnet to altnets. The bridge operates the token contract on the altnet, referred to as **Bridged SOLACE** or **bSOLACE**. This contract must be used to 1:1 convert **bSOLACE** to [**SOLACE**](./../SOLACE) before it can be used. This is to maintain a "native" [**SOLACE**](./../SOLACE) contract that has the same address on each chain.
 *
 * Users can send [**SOLACE**](./../SOLACE) back to mainnet by converting it to **bSOLACE** then using the bridge. This conversion will fail if there is insufficient bridge liquidity. The user will receive [**SOLACE**](./../SOLACE) on mainnet, no unwrapping is required.
 *
 * By convention we say that **bSOLACE** is wrapped and [**SOLACE**](./../SOLACE) is unwrapped.
 *
 * "Bridge Liquidity" is the measurement of how much **bSOLACE** has been converted into [**SOLACE**](./../SOLACE) minus the amount of [**SOLACE**](./../SOLACE) that has been converted into **bSOLACE**, which is equal to the amount of **bSOLACE** owned by this contract. Converting [**SOLACE**](./../SOLACE) to **bSOLACE** will fail if it drops the bridge liquidity below zero.
 *
 * The [**SOLACE**](./../SOLACE) and **bSOLACE** addresses are set on construction and cannot be modified.
 */
interface IBridgeWrapper {
 
    /***************************************
    EVENTS
    ***************************************/
 
    /// @notice Emitted when **bSOLACE** is converted to [**SOLACE**](./../SOLACE).
    event Unwrapped(address indexed sender, address indexed receiver, uint256 amount);
    /// @notice Emitted when [**SOLACE**](./../SOLACE) is converted to **bSOLACE**.
    event Wrapped(address indexed sender, address indexed receiver, uint256 amount);
 
    /***************************************
    GLOBAL VARIABLES
    ***************************************/
 
    /// @notice [**SOLACE**](./../../SOLACE) token.
    function solace() external view returns (address);
    /// @notice **bSOLACE** token.
    function bsolace() external view returns (address);
 
    /***************************************
    UNWRAPPER FUNCTIONS (BSOLACE -> SOLACE)
    ***************************************/
 
    /**
     * @notice Converts **bSOLACE** to [**SOLACE**](./../SOLACE).
     * @dev Uses ERC20 approve-transfer.
     * @param amount Amount of **bSOLACE** to convert.
     * @param receiver User that will receive [**SOLACE**](./../SOLACE).
     */
    function bsolaceToSolace(uint256 amount, address receiver) external;
 
    /***************************************
    WRAPPER FUNCTIONS (SOLACE -> BSOLACE)
    ***************************************/
 
    /**
     * @notice Converts [**SOLACE**](./../SOLACE) to **bSOLACE**.
     * This conversion will fail if there is insufficient bridge liquidity.
     * @dev Uses ERC20 approve-transfer.
     * @param amount Amount of [**SOLACE**](./../SOLACE) to convert.
     * @param receiver User that will receive **bSOLACE**.
     */
    function solaceToBSolace(uint256 amount, address receiver) external;
 
    /**
     * @notice Converts [**SOLACE**](./../SOLACE) to **bSOLACE**.
     * This conversion will fail if there is insufficient bridge liquidity.
     * @dev Uses ERC20 permit-transfer.
     * @param amount Amount of [**SOLACE**](./../SOLACE) to convert.
     * @param receiver User that will receive **bSOLACE**.
     * @param deadline Time the transaction must go through before.
     * @param v secp256k1 signature
     * @param r secp256k1 signature
     * @param s secp256k1 signature
     */
    function solaceToBSolaceSigned(uint256 amount, address receiver, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external;
}