diff --git a/packages/docs/src/core/src/spec/jump-transpilation.rst b/packages/docs/src/core/src/spec/jump-transpilation.rst
index c430c2652fdd..a154c130322d 100644
--- a/packages/docs/src/core/src/spec/jump-transpilation.rst
+++ b/packages/docs/src/core/src/spec/jump-transpilation.rst
@@ -59,4 +59,4 @@ Duplicate above code once for each (compare jumpdest, post-transpile jumpdest) p
**Note on bytecode interpretation**
-Note that properly processing these conditions requires preprocessing the code; a particularly pathological use case is ``PUSH2 JUMPDEST PUSH1 PUSH2 JUMPDEST PUSH1 PUSH2 JUMPDEST PUSH1 ...``, as this code has all ``JUMPDEST``s invalid but an alternative piece of code equivalent to this but only with the leading ``PUSH2`` replaced with another op (eg. ``BALANCE``) will have all ``JUMPDESTS`` valid. We appropriately deal with this, both in our transpiler and purity checker.
\ No newline at end of file
+Note that properly processing these conditions requires preprocessing the code; a particularly pathological use case is ``PUSH2 JUMPDEST PUSH1 PUSH2 JUMPDEST PUSH1 PUSH2 JUMPDEST PUSH1 ...``, as this code has all ``JUMPDEST``s invalid but an alternative piece of code equivalent to this but only with the leading ``PUSH2`` replaced with another op (eg. ``BALANCE``) will have all ``JUMPDESTS`` valid. We appropriately deal with this, both in our transpiler and safety checker.
\ No newline at end of file
diff --git a/packages/docs/src/core/src/spec/overview.rst b/packages/docs/src/core/src/spec/overview.rst
index db8ef8cda70d..63b414b654b6 100644
--- a/packages/docs/src/core/src/spec/overview.rst
+++ b/packages/docs/src/core/src/spec/overview.rst
@@ -4,7 +4,7 @@ OVM Overview and Architecture
The core functionality of the OVM is to run transactions in such a way that they are "pure" or "deterministic"--that is, no matter what time in the future a dispute about them is triggered on layer 1, the output of the computation is the same--*no matter what the state of the L1.
-To accomplish this, there are two critical smart contracts: the Execution Manager, and the Purity Checker.
+To accomplish this, there are two critical smart contracts: the Execution Manager, and the Safety Checker.
*****************
Execution Manager
@@ -19,10 +19,10 @@ The execution manager interfaces with "code contracts," which are contracts comp
<img src="../../_static/images/execution-manager.png" alt="The Execution Manager">
**************
-Purity Checker
+Safety Checker
**************
-To ensure that the execution of an OVM transaction is deterministic between L1 and L2, we must enforce that **only** the container interface described above is used. To accomplish this, we have a "purity checker." The purity checker analyzes the low-level assembly bytecode of an EVM contract to tell the execution manager whether the code conforms to the OVM interface. If it does not, then the execution manager does not allow such a contract to be created or used in a fraud proof.
+To ensure that the execution of an OVM transaction is deterministic between L1 and L2, we must enforce that **only** the container interface described above is used. To accomplish this, we have a "safety checker." The safety checker analyzes the low-level assembly bytecode of an EVM contract to tell the execution manager whether the code conforms to the OVM interface. If it does not, then the execution manager does not allow such a contract to be created or used in a fraud proof.
.. raw:: html
diff --git a/packages/docs/src/core/src/spec/transpilation-details.rst b/packages/docs/src/core/src/spec/transpilation-details.rst
index b7c7416edbef..b5d3d70229c3 100644
--- a/packages/docs/src/core/src/spec/transpilation-details.rst
+++ b/packages/docs/src/core/src/spec/transpilation-details.rst
@@ -20,7 +20,7 @@ The following opcodes perform stack operations which are constant in terms of L1
- "Pure" memory modifying operations:
- ``MLOAD, MSTORE, MSTORE8, MSIZE``.
- Permitted execution-context-dependent operations:
- - ``CALLVALUE*, CALLDATALOAD, CALLDATASIZE, CALLDATACOPY, CODESIZE, RETURNDATASIZE, RETURNDATACOPY`` \*Note: ``CALLVALUE`` will always be 0 because we enforce that all ``CALL`` s always pass 0 in our purity checking.
+ - ``CALLVALUE*, CALLDATALOAD, CALLDATASIZE, CALLDATACOPY, CODESIZE, RETURNDATASIZE, RETURNDATACOPY`` \*Note: ``CALLVALUE`` will always be 0 because we enforce that all ``CALL`` s always pass 0 in our safety checking.
Replaced Opcodes
================
@@ -119,7 +119,7 @@ These opcodes are banned simply because we don't want to support them currently.
ETH-native Value
-----------------------------------------
-We have made the decision for now not to use native ETH, and instead do everything with wrapped ETH (WETH). Note: ``CALLVALUE`` is actually able to be whitelisted, because our Purity Checker enforces that all Calls are made with a value of 0. Contracts are welcome to use msg.value, it will just always return 0. This means that the following opcodes are banned, not just transpiled:
+We have made the decision for now not to use native ETH, and instead do everything with wrapped ETH (WETH). Note: ``CALLVALUE`` is actually able to be whitelisted, because our Safety Checker enforces that all Calls are made with a value of 0. Contracts are welcome to use msg.value, it will just always return 0. This means that the following opcodes are banned, not just transpiled:
- ``BALANCE`` -- gets ``address(this).balance``
While not a ban, another note here is that all ``value``-related inputs to other opcodes like ``CREATE`` or ``CALL`` are overridden to ``0`` by their transpiled counterparts. We do have good inline documentation for how a native ``value`` could be added if needed. Another option is we could even transpile the native ETH opcodes to use ``WETH`` instead. TBD.
diff --git a/packages/ovm/config/.env.example b/packages/ovm/config/.env.example
index e1d7d24f2be3..8e44b8c42c8d 100644
--- a/packages/ovm/config/.env.example
+++ b/packages/ovm/config/.env.example
@@ -13,7 +13,7 @@
# Mnemonic for the wallet used to deploy the contracts
DEPLOY_MNEMONIC='response fresh afford leader twice silent table exist aisle pelican focus bird'
-DEPLOY_PURITY_CHECKER_CONTRACT_ADDRESS='0x some address here'
+DEPLOY_SAFETY_CHECKER_CONTRACT_ADDRESS='0x some address here'
# Note: can use any network name. 'local' or leaving it blank will deploy to DEPLOY_LOCAL_URL
DEPLOY_NETWORK='local'
@@ -30,4 +30,4 @@ OPCODE_WHITELIST_MASK='0x600a0000000000000000001fffffffffffffffff0fcf000063f0000
# CREATE, CREATE2, DELEGATECALL, DIFFICULTY, EXTCODECOPY, EXTCODESIZE,
# GASLIMIT, GASPRICE, NUMBER, ORIGIN, SELFDESTRUCT, SLOAD, SSTORE,
# STATICCALL, TIMESTAMP
-# See test/purity-checker/whitelist-mask-generator.spec.ts for more info
+# See test/safety-checker/whitelist-mask-generator.spec.ts for more info
diff --git a/packages/ovm/deploy/execution-manager.ts b/packages/ovm/deploy/execution-manager.ts
index 0f906401f993..21f98c6d2785 100644
--- a/packages/ovm/deploy/execution-manager.ts
+++ b/packages/ovm/deploy/execution-manager.ts
@@ -3,7 +3,7 @@ import { deploy, deployContract } from '@eth-optimism/core-utils'
import { Wallet } from 'ethers'
/* Internal Imports */
-import { deployPurityChecker } from './purity-checker'
+import { deploySafetyChecker } from './safety-checker'
import * as ExecutionManager from '../build/contracts/ExecutionManager.json'
import { resolve } from 'path'
import { GAS_LIMIT, DEFAULT_OPCODE_WHITELIST_MASK } from '../src/app'
@@ -13,13 +13,13 @@ const executionManagerDeploymentFunction = async (
): Promise<string> => {
console.log(`\nDeploying ExecutionManager!\n`)
- const purityCheckerContractAddress = await deployPurityChecker()
+ const safetyCheckerContractAddress = await deploySafetyChecker()
const executionManager = await deployContract(
ExecutionManager,
wallet,
DEFAULT_OPCODE_WHITELIST_MASK,
- purityCheckerContractAddress,
+ safetyCheckerContractAddress,
GAS_LIMIT,
true
)
diff --git a/packages/ovm/deploy/purity-checker.ts b/packages/ovm/deploy/safety-checker.ts
similarity index 61%
rename from packages/ovm/deploy/purity-checker.ts
rename to packages/ovm/deploy/safety-checker.ts
index 2cb18e8f3a95..a8415b9f1dce 100644
--- a/packages/ovm/deploy/purity-checker.ts
+++ b/packages/ovm/deploy/safety-checker.ts
@@ -4,23 +4,23 @@ import { deploy, deployContract, add0x } from '@eth-optimism/core-utils'
import { Wallet } from 'ethers'
/* Internal Imports */
-import * as PurityChecker from '../build/contracts/PurityChecker.json'
+import * as SafetyChecker from '../build/contracts/SafetyChecker.json'
import { resolve } from 'path'
-const purityCheckerDeploymentFunction = async (
+const safetyCheckerDeploymentFunction = async (
wallet: Wallet
): Promise<Address> => {
- let purityCheckerContractAddress =
- process.env.DEPLOY_PURITY_CHECKER_CONTRACT_ADDRESS
- if (!purityCheckerContractAddress) {
- console.log(`\nDeploying Purity Checker!\n`)
+ let safetyCheckerContractAddress =
+ process.env.DEPLOY_SAFETY_CHECKER_CONTRACT_ADDRESS
+ if (!safetyCheckerContractAddress) {
+ console.log(`\nDeploying Safety Checker!\n`)
// Default config whitelists all opcodes EXCEPT:
// ADDRESS, BALANCE, BLOCKHASH, CALLCODE, CALLER, COINBASE,
// CREATE, CREATE2, DELEGATECALL, DIFFICULTY, EXTCODECOPY, EXTCODESIZE,
// GASLIMIT, GASPRICE, NUMBER, ORIGIN, SELFDESTRUCT, SLOAD, SSTORE,
// STATICCALL, TIMESTAMP
- // See test/purity-checker/whitelist-mask-generator.spec.ts for more info
+ // See test/contracts/whitelist-mask-generator.spec.ts for more info
const whitelistMask =
process.env.OPCODE_WHITELIST_MASK ||
'0x600a0000000000000000001fffffffffffffffff0fcf000063f000013fff0fff'
@@ -29,41 +29,41 @@ const purityCheckerDeploymentFunction = async (
process.env.EXECUTION_MANAGER_ADDRESS || add0x('12'.repeat(20))
console.log(
- `Deploying Purity Checker using mask '${whitelistMask}' and execution manager '${executionManagerAddress}'...`
+ `Deploying Safety Checker using mask '${whitelistMask}' and execution manager '${executionManagerAddress}'...`
)
whitelistMask
- const purityChecker = await deployContract(
- PurityChecker,
+ const safetyChecker = await deployContract(
+ SafetyChecker,
wallet,
whitelistMask,
executionManagerAddress
)
- purityCheckerContractAddress = purityChecker.address
+ safetyCheckerContractAddress = safetyChecker.address
console.log(
- `Purity Checker deployed to ${purityCheckerContractAddress}!\n\n`
+ `Safety Checker deployed to ${safetyCheckerContractAddress}!\n\n`
)
} else {
console.log(
- `Using Purity Checker contract at ${purityCheckerContractAddress}\n`
+ `Using Safety Checker contract at ${safetyCheckerContractAddress}\n`
)
}
- return purityCheckerContractAddress
+ return safetyCheckerContractAddress
}
/**
- * Deploys the Purity Checker contract.
+ * Deploys the Safety Checker contract.
*
* @param rootContract Whether or not this is the main contract being deployed (as compared to a dependency).
* @returns The deployed contract's address.
*/
-export const deployPurityChecker = async (
+export const deploySafetyChecker = async (
rootContract: boolean = false
): Promise<string> => {
// Note: Path is from 'build/deploy/<script>.js'
const configDirPath = resolve(__dirname, `../../config/`)
- return deploy(purityCheckerDeploymentFunction, configDirPath, rootContract)
+ return deploy(safetyCheckerDeploymentFunction, configDirPath, rootContract)
}
-deployPurityChecker(true)
+deploySafetyChecker(true)
diff --git a/packages/ovm/package.json b/packages/ovm/package.json
index 06bfea982bcc..7b561739ea8e 100644
--- a/packages/ovm/package.json
+++ b/packages/ovm/package.json
@@ -16,7 +16,7 @@
"build": "mkdir -p ./build && waffle waffle-config.json && tsc -p .",
"clean": "rimraf build/",
"deploy:execution-manager": "yarn build && node ./build/deploy/execution-manager.js",
- "deploy:purity-checker": "yarn build && node ./build/deploy/purity-checker.js"
+ "deploy:safety-checker": "yarn build && node ./build/deploy/safety-checker.js"
},
"keywords": [
"optimistic",
diff --git a/packages/ovm/src/contracts/ExecutionManager.sol b/packages/ovm/src/contracts/ExecutionManager.sol
index 14a92a387b8b..bbfa6ac8b343 100644
--- a/packages/ovm/src/contracts/ExecutionManager.sol
+++ b/packages/ovm/src/contracts/ExecutionManager.sol
@@ -5,7 +5,7 @@ pragma experimental ABIEncoderV2;
import {DataTypes as dt} from "./DataTypes.sol";
import {FullStateManager} from "./FullStateManager.sol";
import {ContractAddressGenerator} from "./ContractAddressGenerator.sol";
-import {PurityChecker} from "./PurityChecker.sol";
+import {SafetyChecker} from "./SafetyChecker.sol";
import {RLPEncode} from "./RLPEncode.sol";
import {L2ToL1MessagePasser} from "./precompiles/L2ToL1MessagePasser.sol";
import {L1MessageSender} from "./precompiles/L1MessageSender.sol";
@@ -33,11 +33,11 @@ contract ExecutionManager is FullStateManager {
dt.ExecutionContext executionContext;
// Add Contract Address Generation contract
ContractAddressGenerator contractAddressGenerator;
- // Add Purity Checker contract
- PurityChecker purityChecker;
+ // Add Safety Checker contract
+ SafetyChecker safetyChecker;
RLPEncode rlp;
- // for testing: if true, then do not perform purity checking on init code or deployed bytecode
- bool overridePurityChecker;
+ // for testing: if true, then do not perform safety checking on init code or deployed bytecode
+ bool overrideSafetyChecker;
// Events
event ActiveContract(address _activeContract);
@@ -63,18 +63,18 @@ contract ExecutionManager is FullStateManager {
);
/**
- * @notice Construct a new ExecutionManager with a specified purity checker & owner.
- * @param _opcodeWhitelistMask A bit mask representing which opcodes are whitelisted or not for our purity checker
+ * @notice Construct a new ExecutionManager with a specified safety checker & owner.
+ * @param _opcodeWhitelistMask A bit mask representing which opcodes are whitelisted or not for our safety checker
* @param _owner The owner of this contract.
* @param _blockGasLimit The block gas limit for OVM blocks
- * @param _overridePurityChecker Set to true to disable purity checking (WARNING: Only do this in test environments)
+ * @param _overrideSafetyChecker Set to true to disable safety checking (WARNING: Only do this in test environments)
*/
- constructor(uint256 _opcodeWhitelistMask, address _owner, uint _blockGasLimit, bool _overridePurityChecker) public {
+ constructor(uint256 _opcodeWhitelistMask, address _owner, uint _blockGasLimit, bool _overrideSafetyChecker) public {
rlp = new RLPEncode();
- // Set override purity checker flag
- overridePurityChecker = _overridePurityChecker;
- // Set the purity checker address
- purityChecker = new PurityChecker(_opcodeWhitelistMask, address(this));
+ // Set override safety checker flag
+ overrideSafetyChecker = _overrideSafetyChecker;
+ // Set the safety checker address
+ safetyChecker = new SafetyChecker(_opcodeWhitelistMask, address(this));
// Initialize new contract address generator
contractAddressGenerator = new ContractAddressGenerator();
@@ -573,9 +573,9 @@ contract ExecutionManager is FullStateManager {
* @return True if this succeeded, false otherwise.
*/
function createNewContract(address _newOvmContractAddress, bytes memory _ovmInitcode) internal returns (bool){
- // Purity check the initcode -- unless the overridePurityChecker flag is set to true
- if (!overridePurityChecker && !purityChecker.isBytecodePure(_ovmInitcode)) {
- // Contract init code is not pure.
+ // Safety check the initcode -- unless the overrideSafetyChecker flag is set to true
+ if (!overrideSafetyChecker && !safetyChecker.isBytecodeSafe(_ovmInitcode)) {
+ // Contract init code is not safe.
return false;
}
// Switch the context to be the new contract
@@ -584,9 +584,9 @@ contract ExecutionManager is FullStateManager {
address codeContractAddress = deployCodeContract(_ovmInitcode);
// Get the runtime bytecode
bytes memory codeContractBytecode = getCodeContractBytecode(codeContractAddress);
- // Purity check the runtime bytecode -- unless the overridePurityChecker flag is set to true
- if (!overridePurityChecker && !purityChecker.isBytecodePure(codeContractBytecode)) {
- // Contract runtime bytecode is not pure.
+ // Safety check the runtime bytecode -- unless the overrideSafetyChecker flag is set to true
+ if (!overrideSafetyChecker && !safetyChecker.isBytecodeSafe(codeContractBytecode)) {
+ // Contract runtime bytecode is not safe.
return false;
}
// Associate the code contract with our ovm contract
diff --git a/packages/ovm/src/contracts/L2ExecutionManager.sol b/packages/ovm/src/contracts/L2ExecutionManager.sol
index b99f9320e95e..4c6ebf5cc0ad 100644
--- a/packages/ovm/src/contracts/L2ExecutionManager.sol
+++ b/packages/ovm/src/contracts/L2ExecutionManager.sol
@@ -18,8 +18,8 @@ contract L2ExecutionManager is ExecutionManager {
uint256 _opcodeWhitelistMask,
address _owner,
uint _gasLimit,
- bool _overridePurityChecker
- ) ExecutionManager(_opcodeWhitelistMask, _owner, _gasLimit, _overridePurityChecker) public {}
+ bool _overrideSafetyChecker
+ ) ExecutionManager(_opcodeWhitelistMask, _owner, _gasLimit, _overrideSafetyChecker) public {}
/**
@notice Stores the provided OVM transaction, mapping its hash to its value and its hash to the EVM tx hash
diff --git a/packages/ovm/src/contracts/PurityChecker.sol b/packages/ovm/src/contracts/SafetyChecker.sol
similarity index 93%
rename from packages/ovm/src/contracts/PurityChecker.sol
rename to packages/ovm/src/contracts/SafetyChecker.sol
index a3b4e999d9c3..88cb774bfe75 100644
--- a/packages/ovm/src/contracts/PurityChecker.sol
+++ b/packages/ovm/src/contracts/SafetyChecker.sol
@@ -1,17 +1,17 @@
pragma solidity ^0.5.0;
/**
- * @title PurityChecker
- * @notice Purity Checker contract used to check whether or not bytecode is pure, meaning:
+ * @title SafetyChecker
+ * @notice Safety Checker contract used to check whether or not bytecode is safe, meaning:
* 1. It uses only whitelisted opcodes
* 2. All CALLs are to the Execution Manager and have no value set (no ETH sent)
*/
-contract PurityChecker {
+contract SafetyChecker {
uint256 public opcodeWhitelistMask;
address public executionManagerAddress;
/**
- * @notice Construct a new Purity Checker with the specified whitelist mask
+ * @notice Construct a new Safety Checker with the specified whitelist mask
* @param _opcodeWhitelistMask A hex number of 256 bits where each bit represents an opcode, 0 - 255, which is set if whitelisted and unset otherwise.
* @param _executionManagerAddress The address of the ExecutionManager.sol contract
*/
@@ -33,11 +33,11 @@ contract PurityChecker {
}
/**
- * @notice Returns whether or not all of the provided bytecode is pure.
- * @param _bytecode The bytecode to purity check. This can be either creation bytecode (aka initcode) or runtime bytecode (aka contract code).
+ * @notice Returns whether or not all of the provided bytecode is safe.
+ * @param _bytecode The bytecode to safety check. This can be either creation bytecode (aka initcode) or runtime bytecode (aka contract code).
* More info on creation vs. runtime bytecode: https://medium.com/authereum/bytecode-and-init-code-and-runtime-code-oh-my-7bcd89065904
*/
- function isBytecodePure(
+ function isBytecodeSafe(
bytes memory _bytecode
) public view returns (bool) {
bool seenJUMP = false;
@@ -79,7 +79,7 @@ contract PurityChecker {
seenJUMP = true;
// we are now inside unreachable code until we hit a JUMPDEST!
insideUnreachableCode = true;
- // STOP or REVERT or INVALID or RETURN (see purity checker docs in wiki for more info)
+ // STOP or REVERT or INVALID or RETURN (see safety checker docs in wiki for more info)
} else if (op == 0x00 || op == 0xfd || op == 0xfe || op == 0xf3) {
// If we can't jump to JUMPDESTs, then all remaining bytecode is unreachable
if (!seenJUMP) {
diff --git a/packages/ovm/test/contracts/execution-manager.create-opcodes.spec.ts b/packages/ovm/test/contracts/execution-manager.create-opcodes.spec.ts
index b7aacba45d1f..a47ef2b410da 100644
--- a/packages/ovm/test/contracts/execution-manager.create-opcodes.spec.ts
+++ b/packages/ovm/test/contracts/execution-manager.create-opcodes.spec.ts
@@ -38,7 +38,7 @@ describe('ExecutionManager -- Create opcodes', () => {
const provider = createMockProvider({ gasLimit: DEFAULT_ETHNODE_GAS_LIMIT })
const [wallet] = getWallets(provider)
let executionManager: Contract
- let purityCheckedExecutioManager: Contract
+ let safetyCheckedExecutionManager: Contract
let deployTx
let deployInvalidTx
@@ -57,10 +57,10 @@ describe('ExecutionManager -- Create opcodes', () => {
SimpleStorage.bytecode
).getDeployTransaction(executionManager.address)
- purityCheckedExecutioManager = await deployContract(
+ safetyCheckedExecutionManager = await deployContract(
wallet,
- ExecutionManager, // Note: this is false, so it's purity checked.
- [DEFAULT_OPCODE_WHITELIST_MASK, '0x' + '00'.repeat(20), GAS_LIMIT, false],
+ ExecutionManager,
+ [DEFAULT_OPCODE_WHITELIST_MASK, '0x' + '00'.repeat(20), GAS_LIMIT, false], // Note: this is false, so it's safety checked.
{ gasLimit: DEFAULT_ETHNODE_GAS_LIMIT }
)
@@ -90,7 +90,7 @@ describe('ExecutionManager -- Create opcodes', () => {
// Now actually apply it to our execution manager
const result = await executionManager.provider.call({
- to: purityCheckedExecutioManager.address,
+ to: safetyCheckedExecutionManager.address,
data,
gasLimit,
})
@@ -130,7 +130,7 @@ describe('ExecutionManager -- Create opcodes', () => {
// Now actually apply it to our execution manager
const result = await executionManager.provider.call({
- to: purityCheckedExecutioManager.address,
+ to: safetyCheckedExecutionManager.address,
data,
gasLimit,
})
diff --git a/packages/ovm/test/contracts/execution-manager.purity-checking.spec.ts b/packages/ovm/test/contracts/execution-manager.purity-checking.spec.ts
index 6148c5c8bc96..a3eec42fe5e4 100644
--- a/packages/ovm/test/contracts/execution-manager.purity-checking.spec.ts
+++ b/packages/ovm/test/contracts/execution-manager.purity-checking.spec.ts
@@ -19,20 +19,20 @@ import {
} from '../helpers'
import { TransactionReceipt } from 'ethers/providers'
-const log = getLogger('execution-manager-purity-checking', true)
+const log = getLogger('execution-manager-safety-checking', true)
/*********
* TESTS *
*********/
-describe('Execution Manager -- Purity Checking', () => {
+describe('Execution Manager -- Safety Checking', () => {
const provider = createMockProvider({ gasLimit: DEFAULT_ETHNODE_GAS_LIMIT })
const [wallet] = getWallets(provider)
// Create pointers to our execution manager & simple copier contract
let executionManager: Contract
beforeEach(async () => {
- // Deploy ExecutionManager with Purity Checking enabled
+ // Deploy ExecutionManager with Safety Checking enabled
executionManager = await deployContract(
wallet,
ExecutionManager,
@@ -40,8 +40,8 @@ describe('Execution Manager -- Purity Checking', () => {
{ gasLimit: DEFAULT_ETHNODE_GAS_LIMIT }
)
})
- describe('Purity Checking within Execution Manager', async () => {
- it('should fail when given an impure contract', async () => {
+ describe('Safety Checking within Execution Manager', async () => {
+ it('should fail when given an unsafe contract', async () => {
// For transactions,
const receipt: TransactionReceipt = await manuallyDeployOvmContractReturnReceipt(
wallet,
@@ -57,10 +57,10 @@ describe('Execution Manager -- Purity Checking', () => {
createSucceeded.should.equal(
false,
- `DummyContract.sol should not have been considered pure because it uses storage in its constructor`
+ `DummyContract.sol should not have been considered safe because it uses storage in its constructor`
)
})
- it('should successfully deploy a pure contract', async () => {
+ it('should successfully deploy a safe contract', async () => {
const receipt = await manuallyDeployOvmContractReturnReceipt(
wallet,
provider,
@@ -75,7 +75,7 @@ describe('Execution Manager -- Purity Checking', () => {
createSucceeded.should.equal(
true,
- `AddThree.sol contract should have been considered pure`
+ `AddThree.sol contract should have been considered safe`
)
})
})
diff --git a/packages/ovm/test/contracts/purity-checker.spec.ts b/packages/ovm/test/contracts/safety-checker.spec.ts
similarity index 91%
rename from packages/ovm/test/contracts/purity-checker.spec.ts
rename to packages/ovm/test/contracts/safety-checker.spec.ts
index bbb265eb9788..d1bdc97684fb 100644
--- a/packages/ovm/test/contracts/purity-checker.spec.ts
+++ b/packages/ovm/test/contracts/safety-checker.spec.ts
@@ -10,10 +10,10 @@ import { Contract } from 'ethers'
import { createMockProvider, deployContract, getWallets } from 'ethereum-waffle'
/* Logging */
-const log = getLogger('purity-checker')
+const log = getLogger('safety-checker', true)
/* Contract Imports */
-import * as PurityChecker from '../../build/contracts/PurityChecker.json'
+import * as SafetyChecker from '../../build/contracts/SafetyChecker.json'
const executionManagerAddress = add0x('12'.repeat(20)) // Test Execution Manager address 0x121...212
const notWhitelisted: EVMOpcode[] = [
@@ -52,25 +52,25 @@ const whitelistedNotHaltingOrCALL: EVMOpcode[] = Opcode.ALL_OP_CODES.filter(
x.name !== 'CALL'
)
-describe('Purity Checker', () => {
+describe('Safety Checker', () => {
const provider = createMockProvider()
const [wallet] = getWallets(provider)
- let purityChecker: Contract
+ let safetyChecker: Contract
/* Deploy a new whitelist contract before each test */
beforeEach(async () => {
- purityChecker = await deployContract(
+ safetyChecker = await deployContract(
wallet,
- PurityChecker,
+ SafetyChecker,
[DEFAULT_OPCODE_WHITELIST_MASK, executionManagerAddress],
{ gasLimit: 6700000 }
)
})
- describe('isBytecodePure()', async () => {
+ describe('isBytecodeSafe()', async () => {
describe('Empty case', () => {
it('should work for empty case', async () => {
- const res: boolean = await purityChecker.isBytecodePure([])
+ const res: boolean = await safetyChecker.isBytecodeSafe([])
res.should.eq(true, `empty bytecode should be whitelisted!`)
})
})
@@ -78,7 +78,7 @@ describe('Purity Checker', () => {
describe('Single op-code cases', async () => {
it('should correctly classify non-whitelisted', async () => {
for (const opcode of notWhitelisted) {
- const res: boolean = await purityChecker.isBytecodePure(
+ const res: boolean = await safetyChecker.isBytecodeSafe(
`0x${opcode.code.toString('hex')}`
)
res.should.eq(
@@ -91,7 +91,7 @@ describe('Purity Checker', () => {
it('should correctly classify whitelisted', async () => {
for (const opcode of whitelistedNotHaltingOrCALL) {
if (!opcode.name.startsWith('PUSH')) {
- const res: boolean = await purityChecker.isBytecodePure(
+ const res: boolean = await safetyChecker.isBytecodeSafe(
`0x${opcode.code.toString('hex')}`
)
res.should.eq(
@@ -114,7 +114,7 @@ describe('Purity Checker', () => {
const bytecode: string = `0x${Buffer.of(push1Code + i - 1).toString(
'hex'
)}${invalidOpcode.repeat(i)}`
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
true,
`PUSH${i} failed by not skipping ${i} bytes of bytecode!`
@@ -132,7 +132,7 @@ describe('Purity Checker', () => {
const bytecode: string = `0x${Buffer.of(push1Code + i - 1).toString(
'hex'
)}${invalidOpcode.repeat(i + 1)}`
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`PUSH${i} succeeded, skipping ${i +
@@ -153,7 +153,7 @@ describe('Purity Checker', () => {
)}`
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(true, `Bytecode of all whitelisted (non-halting) failed!`)
})
@@ -167,7 +167,7 @@ describe('Purity Checker', () => {
)}`
}
for (const opcode of notWhitelisted) {
- const res: boolean = await purityChecker.isBytecodePure(
+ const res: boolean = await safetyChecker.isBytecodeSafe(
bytecode + opcode.code.toString('hex')
)
res.should.eq(
@@ -186,7 +186,7 @@ describe('Purity Checker', () => {
for (const opcode of notWhitelisted) {
bytecode += opcode.code.toString('hex')
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
true,
`Bytecode containing invalid opcodes in unreachable code after a ${haltingOp.name} failed!`
@@ -201,7 +201,7 @@ describe('Purity Checker', () => {
for (const opcode of notWhitelisted) {
bytecode += opcode.code.toString('hex')
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
true,
`Bytecode containing invalid opcodes after unreachable JUMPDEST (after a ${haltingOp.name}) failed!`
@@ -220,7 +220,7 @@ describe('Purity Checker', () => {
for (const opcode of notWhitelisted) {
bytecode += opcode.code.toString('hex')
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid opcodes after a JUMPDEST preceded by a ${haltingOp.name} and reachable by ${jump.name} should have failed!`
@@ -236,7 +236,7 @@ describe('Purity Checker', () => {
for (const opcode of notWhitelisted) {
bytecode += opcode.code.toString('hex')
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid opcodes after reachble JUMPDEST should have failed!`
@@ -249,7 +249,7 @@ describe('Purity Checker', () => {
for (const opcode of notWhitelisted) {
bytecode += opcode.code.toString('hex')
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid opcodes after JUMPI should have failed!`
@@ -275,7 +275,7 @@ describe('Purity Checker', () => {
bytecode += opcode.code.toString('hex')
}
}
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
true,
`Long bytecode containing alternating valid reachable and invalid unreachable code failed!`
@@ -304,7 +304,7 @@ describe('Purity Checker', () => {
}
}
bytecode += notWhitelisted[0].code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Long bytecode ending in reachable, invalid code should have failed!`
@@ -334,7 +334,7 @@ describe('Purity Checker', () => {
bytecode += invalidOpcode.repeat(i)
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
true,
`Bytecode containing valid CALL using PUSH${i} to set gas failed!`
@@ -357,7 +357,7 @@ describe('Purity Checker', () => {
bytecode += Buffer.of(dup1Code + i - 1).toString('hex')
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
true,
`Bytecode containing valid CALL using DUP${i} to set gas failed!`
@@ -382,7 +382,7 @@ describe('Purity Checker', () => {
bytecode += opcode.code.toString('hex')
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid CALL using ${opcode.name} to set gas should have failed!`
@@ -412,7 +412,7 @@ describe('Purity Checker', () => {
bytecode += '11'.repeat(32) //PUSH32 0x11...11
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid CALL using ${opcode.name} to set value should have failed!`
@@ -442,7 +442,7 @@ describe('Purity Checker', () => {
bytecode += '11'.repeat(32) //PUSH32 0x11...11
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid CALL using ${opcode.name} to set value should have failed!`
@@ -462,7 +462,7 @@ describe('Purity Checker', () => {
bytecode += '11'.repeat(32) //PUSH32 0x11...11
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid CALL PUSH1ing non-zero value should have failed!`
@@ -481,7 +481,7 @@ describe('Purity Checker', () => {
bytecode += '11'.repeat(32) //PUSH32 0x11...11
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid CALL PUSH20ing non-Execution Manager address should have failed!`
@@ -497,7 +497,7 @@ describe('Purity Checker', () => {
bytecode += '11'.repeat(32) //PUSH32 0x11...11
// CALL
bytecode += Opcode.CALL.code.toString('hex')
- const res: boolean = await purityChecker.isBytecodePure(bytecode)
+ const res: boolean = await safetyChecker.isBytecodeSafe(bytecode)
res.should.eq(
false,
`Bytecode containing invalid CALL with only two preceding opcodes should have failed!`
diff --git a/packages/ovm/test/contracts/whitelist-mask-generator.spec.ts b/packages/ovm/test/contracts/whitelist-mask-generator.spec.ts
index 92218ebb3ebc..b7e7ccc02a3c 100644
--- a/packages/ovm/test/contracts/whitelist-mask-generator.spec.ts
+++ b/packages/ovm/test/contracts/whitelist-mask-generator.spec.ts
@@ -38,7 +38,7 @@ describe('generates whitelist masks -- this is a util, not a test', () => {
it('does the thing', () => {
// Produces a hex number of 256 bits where each bit represents an
// opcode, 0 - 255, which is set if whitelisted and unset otherwise.
- // Useful for the PurityChecker contract.
+ // Useful for the SafetyChecker contract.
console.log(
`WHITELISTED OPCODES: ${whitelistedOpcodes.map((x) => x.name).join(',')}`
)