Skip to content

feat[contracts]: enable initiating L2 upgrade via L1 to L2 message #854

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

Closed
smartcontracts wants to merge 2 commits into from
Closed

feat[contracts]: enable initiating L2 upgrade via L1 to L2 message #854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e8bab5
feat[contracts]: enable initiating L2 upgrade via L1 to L2 message
smartcontracts May 12, 2021
4b5de02
chore: add changeset
smartcontracts May 12, 2021
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
5 changes: 5 additions & 0 deletions .changeset/fluffy-knives-impress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@eth-optimism/contracts': patch
---

enables l2 upgrades to be initiated by an l1 to l2 message
33 changes: 28 additions & 5 deletions packages/contracts/contracts/chugsplash/L2ChugSplashDeployer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ pragma experimental ABIEncoderV2;
/* Library Imports */
import { Lib_ExecutionManagerWrapper } from "../optimistic-ethereum/libraries/wrappers/Lib_ExecutionManagerWrapper.sol";
import { Lib_MerkleTree } from "../optimistic-ethereum/libraries/utils/Lib_MerkleTree.sol";
import { OVM_CrossDomainEnabled } from "../optimistic-ethereum/libraries/bridge/OVM_CrossDomainEnabled.sol";

/* External Imports */
import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
Expand All @@ -20,7 +21,7 @@ import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
* actions (in any order) by demonstrating with a Merkle proof that the action was approved by the
* contract owner. Only a single upgrade may be active at any given time.
*/
contract L2ChugSplashDeployer is Ownable {
contract L2ChugSplashDeployer is Ownable, OVM_CrossDomainEnabled {

/*********
* Enums *
Expand Down Expand Up @@ -100,19 +101,41 @@ contract L2ChugSplashDeployer is Ownable {
/***************
* Constructor *
***************/

/**
* @param _owner Address that will initially own the L2ChugSplashDeployer.
*/
constructor(
address _owner
)
Ownable()
OVM_CrossDomainEnabled(0x4200000000000000000000000000000000000007)
{
transferOwnership(_owner);
}


/*********************
* Function Modifier *
*********************/

/**
* A modifier like "onlyOwner" but also alternatively allows the owner to call this contract
* via an L1 => L2 message.
*/
modifier onlyOwnerOrCrossDomainOwner() {
require(
Copy link
Contributor

@tynes tynes May 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a gas savings thing to pack so much in a single expression? If so, I understand why there is utility but otherwise readability is more important

Copy link
Contributor Author

@smartcontracts smartcontracts May 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would you reformat this to make it more legible?

Copy link
Contributor

@maurelian maurelian May 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't the cross domains enabled lib have something that does half of this?

Copy link
Contributor Author

@smartcontracts smartcontracts May 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but I don't believe it's possible to compose two function modifiers with an "OR".

msg.sender == owner()
|| (
msg.sender == address(getCrossDomainMessenger())
&& getCrossDomainMessenger().xDomainMessageSender() == owner()
),
"ChugSplashDeployer: caller is not the owner"
);
_;
}


/********************
* Public Functions *
********************/
Expand Down Expand Up @@ -143,7 +166,7 @@ contract L2ChugSplashDeployer is Ownable {
uint256 _bundleSize
)
public
onlyOwner
onlyOwnerOrCrossDomainOwner
{
require(
_bundleHash != bytes32(0),
Expand Down Expand Up @@ -179,7 +202,7 @@ contract L2ChugSplashDeployer is Ownable {
*/
function cancelTransactionBundle()
public
onlyOwner
onlyOwnerOrCrossDomainOwner
{
require(
hasActiveBundle() == true,
Expand Down Expand Up @@ -208,7 +231,7 @@ contract L2ChugSplashDeployer is Ownable {
uint256 _bundleSize
)
public
onlyOwner
onlyOwnerOrCrossDomainOwner
{
cancelTransactionBundle();
approveTransactionBundle(_bundleHash, _bundleSize);
Expand Down
104 changes: 100 additions & 4 deletions packages/contracts/test/contracts/chugsplash/L2ChugSplashDeployer.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { expect } from '../../setup'
import hre from 'hardhat'
import { ethers, Contract, Signer, ContractFactory } from 'ethers'
import { MockContract, smockit } from '@eth-optimism/smock'
import { toPlainObject } from 'lodash'

/* Imports: Internal */
import {
Expand All @@ -12,7 +13,6 @@ import {
predeploys,
} from '../../../src'
import { NON_NULL_BYTES32, NON_ZERO_ADDRESS } from '../../helpers'
import { toPlainObject } from 'lodash'

describe('L2ChugSplashDeployer', () => {
let signer1: Signer
Expand All @@ -22,10 +22,17 @@ describe('L2ChugSplashDeployer', () => {
})

let Mock__OVM_ExecutionManager: MockContract
let Mock__OVM_L2CrossDomainMessenger: MockContract
before(async () => {
Mock__OVM_ExecutionManager = await smockit('OVM_ExecutionManager', {
address: predeploys.OVM_ExecutionManagerWrapper,
})
Mock__OVM_L2CrossDomainMessenger = await smockit(
'OVM_L2CrossDomainMessenger',
{
address: predeploys.OVM_L2CrossDomainMessenger,
}
)
})

let Factory__L2ChugSplashDeployer: ContractFactory
Expand Down Expand Up @@ -59,7 +66,7 @@ describe('L2ChugSplashDeployer', () => {
ethers.constants.HashZero,
0
)
).to.be.revertedWith('Ownable: caller is not the owner')
).to.be.revertedWith('ChugSplashDeployer: caller is not the owner')
})

it('should allow the owner to approve a new transaction bundle', async () => {
Expand All @@ -77,6 +84,34 @@ describe('L2ChugSplashDeployer', () => {
expect(await L2ChugSplashDeployer.currentBundleSize()).to.equal(1234)
})

it('should allow the owner to approve a new transaction bundle via an L1 => L2 message', async () => {
Mock__OVM_L2CrossDomainMessenger.smocked.xDomainMessageSender.will.return.with(
await signer1.getAddress()
)

await expect(
L2ChugSplashDeployer.connect(
hre.ethers.provider
).callStatic.approveTransactionBundle(NON_NULL_BYTES32, 1234, {
from: Mock__OVM_L2CrossDomainMessenger.address,
})
).to.not.be.reverted
})

it('should revert if cross domain message sender is not the owner', async () => {
Mock__OVM_L2CrossDomainMessenger.smocked.xDomainMessageSender.will.return.with(
await signer2.getAddress()
)

await expect(
L2ChugSplashDeployer.connect(
hre.ethers.provider
).callStatic.approveTransactionBundle(NON_NULL_BYTES32, 1234, {
from: Mock__OVM_L2CrossDomainMessenger.address,
})
).to.be.revertedWith('ChugSplashDeployer: caller is not the owner')
})

it('should revert if trying to approve a bundle with the empty hash', async () => {
await expect(
L2ChugSplashDeployer.connect(signer1).approveTransactionBundle(
Expand Down Expand Up @@ -264,7 +299,21 @@ describe('L2ChugSplashDeployer', () => {
it('should revert if caller is not the owner', async () => {
await expect(
L2ChugSplashDeployer.connect(signer2).cancelTransactionBundle()
).to.be.revertedWith('Ownable: caller is not the owner')
).to.be.revertedWith('ChugSplashDeployer: caller is not the owner')
})

it('should revert if cross domain message sender is not the owner', async () => {
Mock__OVM_L2CrossDomainMessenger.smocked.xDomainMessageSender.will.return.with(
await signer2.getAddress()
)

await expect(
L2ChugSplashDeployer.connect(
hre.ethers.provider
).callStatic.cancelTransactionBundle({
from: Mock__OVM_L2CrossDomainMessenger.address,
})
).to.be.revertedWith('ChugSplashDeployer: caller is not the owner')
})

it('should revert if there is no active bundle', async () => {
Expand Down Expand Up @@ -308,6 +357,20 @@ describe('L2ChugSplashDeployer', () => {
expect(await L2ChugSplashDeployer.currentBundleSize()).to.equal(0)
})

it('should allow the owner to cancel a bundle via an L1 => L2 message', async () => {
Mock__OVM_L2CrossDomainMessenger.smocked.xDomainMessageSender.will.return.with(
await signer1.getAddress()
)

await expect(
L2ChugSplashDeployer.connect(
hre.ethers.provider
).callStatic.cancelTransactionBundle({
from: Mock__OVM_L2CrossDomainMessenger.address,
})
).to.not.be.reverted
})

it('should allow the owner to cancel an active bundle after some actions have been executed', async () => {
await L2ChugSplashDeployer.executeAction(
bundle.actions[0].action,
Expand Down Expand Up @@ -339,7 +402,21 @@ describe('L2ChugSplashDeployer', () => {
NON_NULL_BYTES32,
1234
)
).to.be.revertedWith('Ownable: caller is not the owner')
).to.be.revertedWith('ChugSplashDeployer: caller is not the owner')
})

it('should revert if cross domain message sender is not the owner', async () => {
Mock__OVM_L2CrossDomainMessenger.smocked.xDomainMessageSender.will.return.with(
await signer2.getAddress()
)

await expect(
L2ChugSplashDeployer.connect(
hre.ethers.provider
).callStatic.overrideTransactionBundle(NON_NULL_BYTES32, 1234, {
from: Mock__OVM_L2CrossDomainMessenger.address,
})
).to.be.revertedWith('ChugSplashDeployer: caller is not the owner')
})

it('should allow the owner to override the current active bundle', async () => {
Expand All @@ -360,5 +437,24 @@ describe('L2ChugSplashDeployer', () => {
)
expect(await L2ChugSplashDeployer.currentBundleSize()).to.equal(1234)
})

it('should allow the owner to override a bundle via an L1 => L2 message', async () => {
Mock__OVM_L2CrossDomainMessenger.smocked.xDomainMessageSender.will.return.with(
await signer1.getAddress()
)

await L2ChugSplashDeployer.connect(signer1).approveTransactionBundle(
'0x' + 'FF'.repeat(32),
12345
)

await expect(
L2ChugSplashDeployer.connect(
hre.ethers.provider
).callStatic.overrideTransactionBundle(NON_NULL_BYTES32, 1234, {
from: Mock__OVM_L2CrossDomainMessenger.address,
})
).to.not.be.reverted
})
})
})