Skip to content

New messenger interface #825

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.

Sign up for GitHub

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

Merged
merged 14 commits into from
Nov 3, 2020
Merged

New messenger interface #825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ccad356
Use the latest optimism contracts
i-stam Oct 29, 2020
ca79147
Merge branch 'send-rewards-into-l2' into new-messenger-interface
i-stam Oct 29, 2020
a46f904
Update l2bridge spec tests (#827)
i-stam Oct 30, 2020
2327a43
Add internal function for code elimination and requireActive modifier
i-stam Oct 30, 2020
b85df66
Linter fix
i-stam Oct 30, 2020
7f8d92d
Add a few extra safety checks
i-stam Nov 2, 2020
16752e1
Remove same-chain tests from workflow
i-stam Nov 2, 2020
8897b77
Add config.yml
i-stam Nov 2, 2020
5fd682a
update to new mocks
K-Ho Nov 2, 2020
4e9cfe7
Merge branch 'new-messenger-interface' of https://github.com/Syntheti…
K-Ho Nov 2, 2020
ae06658
Fix same-chain tests
i-stam Nov 3, 2020
ccea05a
Add same-chain tests to the ci workflow
i-stam Nov 3, 2020
3d73f52
Linter fixes
i-stam Nov 3, 2020
08626f6
Add L2 to L1 (withdrawl) same-chain multi-test
i-stam Nov 3, 2020
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
11 changes: 5 additions & 6 deletions contracts/SynthetixBridgeToBase.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import "./interfaces/ISynthetixBridgeToBase.sol";
import "./interfaces/ISynthetix.sol";

// solhint-disable indent
import "@eth-optimism/rollup-contracts/build/contracts/bridge/interfaces/CrossDomainMessenger.interface.sol";
import "@eth-optimism/contracts/build/contracts/iOVM/bridge/iOVM_BaseCrossDomainMessenger.sol";


contract SynthetixBridgeToBase is Owned, MixinResolver, ISynthetixBridgeToBase {
uint32 private constant CROSS_DOMAIN_MESSAGE_GAS_LIMIT = 3e6; //TODO: verify value
uint32 private constant CROSS_DOMAIN_MESSAGE_GAS_LIMIT = 3e6; //TODO: make this updateable

/* ========== ADDRESS RESOLVER CONFIGURATION ========== */
bytes32 private constant CONTRACT_EXT_MESSENGER = "ext:Messenger";
Expand All @@ -26,16 +26,15 @@ contract SynthetixBridgeToBase is Owned, MixinResolver, ISynthetixBridgeToBase {
CONTRACT_BASE_SYNTHETIXBRIDGETOOPTIMISM
];

//
// ========== CONSTRUCTOR ==========

constructor(address _owner, address _resolver) public Owned(_owner) MixinResolver(_resolver, addressesToCache) {}

//
// ========== INTERNALS ============

function messenger() internal view returns (ICrossDomainMessenger) {
return ICrossDomainMessenger(requireAndGetAddress(CONTRACT_EXT_MESSENGER, "Missing Messenger address"));
function messenger() internal view returns (iOVM_BaseCrossDomainMessenger) {
return iOVM_BaseCrossDomainMessenger(requireAndGetAddress(CONTRACT_EXT_MESSENGER, "Missing Messenger address"));
}

function synthetix() internal view returns (ISynthetix) {
Expand All @@ -48,7 +47,7 @@ contract SynthetixBridgeToBase is Owned, MixinResolver, ISynthetixBridgeToBase {

function onlyAllowFromOptimism() internal view {
// ensure function only callable from the L2 bridge via messenger (aka relayer)
ICrossDomainMessenger _messenger = messenger();
iOVM_BaseCrossDomainMessenger _messenger = messenger();
require(msg.sender == address(_messenger), "Only the relayer can call this");
require(_messenger.xDomainMessageSender() == synthetixBridgeToOptimism(), "Only the L1 bridge can invoke");
}
Expand Down
50 changes: 22 additions & 28 deletions contracts/SynthetixBridgeToOptimism.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import "./interfaces/IERC20.sol";
import "./interfaces/IIssuer.sol";

// solhint-disable indent
import "@eth-optimism/rollup-contracts/build/contracts/bridge/interfaces/CrossDomainMessenger.interface.sol";
import "@eth-optimism/contracts/build/contracts/iOVM/bridge/iOVM_BaseCrossDomainMessenger.sol";


contract SynthetixBridgeToOptimism is Owned, MixinResolver, ISynthetixBridgeToOptimism {
uint32 private constant CROSS_DOMAIN_MESSAGE_GAS_LIMIT = 3e6; //TODO: verify value, uint32 to uint in new version
uint32 private constant CROSS_DOMAIN_MESSAGE_GAS_LIMIT = 3e6; //TODO: from constant to an updateable value

/* ========== ADDRESS RESOLVER CONFIGURATION ========== */
bytes32 private constant CONTRACT_EXT_MESSENGER = "ext:Messenger";
Expand Down Expand Up @@ -43,8 +43,8 @@ contract SynthetixBridgeToOptimism is Owned, MixinResolver, ISynthetixBridgeToOp
//
// ========== INTERNALS ============

function messenger() internal view returns (ICrossDomainMessenger) {
return ICrossDomainMessenger(requireAndGetAddress(CONTRACT_EXT_MESSENGER, "Missing Messenger address"));
function messenger() internal view returns (iOVM_BaseCrossDomainMessenger) {
return iOVM_BaseCrossDomainMessenger(requireAndGetAddress(CONTRACT_EXT_MESSENGER, "Missing Messenger address"));
}

function synthetix() internal view returns (ISynthetix) {
Expand All @@ -71,6 +71,16 @@ contract SynthetixBridgeToOptimism is Owned, MixinResolver, ISynthetixBridgeToOp
require(activated, "Function deactivated");
}

function _rewardDeposit(uint amount) internal {
// create message payload for L2
bytes memory messageData = abi.encodeWithSignature("mintSecondaryFromDepositForRewards(uint256)", amount);

// relay the message to this contract on L2 via L1 Messenger
messenger().sendMessage(synthetixBridgeToBase(), messageData, CROSS_DOMAIN_MESSAGE_GAS_LIMIT);

emit RewardDeposit(msg.sender, amount);
}

// ========== MODIFIERS ============

modifier requireActive() {
Expand Down Expand Up @@ -104,20 +114,13 @@ contract SynthetixBridgeToOptimism is Owned, MixinResolver, ISynthetixBridgeToOp
function rewardDeposit(uint amount) external requireActive {
// move the SNX into this contract
synthetixERC20().transferFrom(msg.sender, address(this), amount);

// create message payload for L2
bytes memory messageData = abi.encodeWithSignature("mintSecondaryFromDepositForRewards(uint256)", amount);

// relay the message to this contract on L2 via L1 Messenger
messenger().sendMessage(synthetixBridgeToBase(), messageData, CROSS_DOMAIN_MESSAGE_GAS_LIMIT);

emit RewardDepositByAccount(msg.sender, amount);
_rewardDeposit(amount);
}

// ========= RESTRICTED FUNCTIONS ==============

// invoked by Messenger on L1 after L2 waiting period elapses
function completeWithdrawal(address account, uint amount) external {
function completeWithdrawal(address account, uint amount) external requireActive {
// ensure function only callable from L2 Bridge via messenger (aka relayer)
require(msg.sender == address(messenger()), "Only the relayer can call this");
require(messenger().xDomainMessageSender() == synthetixBridgeToBase(), "Only the L2 bridge can invoke");
Expand All @@ -130,7 +133,8 @@ contract SynthetixBridgeToOptimism is Owned, MixinResolver, ISynthetixBridgeToOp
}

// invoked by the owner for migrating the contract to the new version that will allow for withdrawals
function migrateBridge(address newBridge) external onlyOwner {
function migrateBridge(address newBridge) external onlyOwner requireActive {
require(newBridge != address(0), "Cannot migrate to address 0");
activated = false;

IERC20 ERC20Synthetix = synthetixERC20();
Expand All @@ -142,27 +146,17 @@ contract SynthetixBridgeToOptimism is Owned, MixinResolver, ISynthetixBridgeToOp
}

// invoked by RewardsDistribution on L1 (takes SNX)
function notifyRewardAmount(uint256 reward) external {
function notifyRewardAmount(uint256 amount) external requireActive {
require(msg.sender == address(rewardsDistribution()), "Caller is not RewardsDistribution contract");

// to be here means I've been given an amount of SNX to distribute onto L2

// create message payload for L2
bytes memory messageData = abi.encodeWithSignature("mintSecondaryFromDepositForRewards(uint256)", reward);

// relay the message to this contract on L2 via L1 Messenger
messenger().sendMessage(synthetixBridgeToBase(), messageData, CROSS_DOMAIN_MESSAGE_GAS_LIMIT);

emit RewardDeposit(reward);
_rewardDeposit(amount);
}

// ========== EVENTS ==========

event Deposit(address indexed account, uint amount);
event RewardDepositByAccount(address indexed account, uint reward);

event RewardDeposit(uint reward);

event BridgeMigrated(address oldBridge, address newBridge, uint amount);
event Deposit(address indexed account, uint amount);
event RewardDeposit(address indexed account, uint amount);
event WithdrawalCompleted(address indexed account, uint amount);
}
Loading