@eth-optimism/ethereumjs-vm
Version:
An Ethereum VM implementation
390 lines • 20.2 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __spreadArrays = (this && this.__spreadArrays) || function () {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
Object.defineProperty(exports, "__esModule", { value: true });
var BN = require("bn.js");
var exceptions_1 = require("../exceptions");
var memory_1 = require("./memory");
var stack_1 = require("./stack");
var opFns_1 = require("./opFns");
var logger_1 = require("../ovm/utils/logger");
var process_1 = require("process");
var buffer_utils_1 = require("../ovm/utils/buffer-utils");
var logger = new logger_1.Logger('js-ovm:intrp');
/**
* Parses and executes EVM bytecode.
*/
var Interpreter = /** @class */ (function () {
function Interpreter(vm, eei) {
this._printNextMemory = false;
this._vm = vm; // TODO: remove when not needed
this._state = vm.pStateManager;
this._eei = eei;
this._runState = {
programCounter: 0,
opCode: 0xfe,
memory: new memory_1.default(),
memoryWordCount: new BN(0),
highestMemCost: new BN(0),
stack: new stack_1.default(),
code: Buffer.alloc(0),
validJumps: [],
// TODO: Replace with EEI methods
_common: this._vm._common,
stateManager: this._state._wrapped,
eei: this._eei,
};
this._loggers = {};
this._firstStep = true;
this._initialGas = new BN(0);
}
Interpreter.prototype.run = function (code, opts) {
if (opts === void 0) { opts = {}; }
return __awaiter(this, void 0, void 0, function () {
var pc, err, opCode, e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
this._runState.code = code;
this._runState.programCounter = opts.pc || this._runState.programCounter;
this._runState.validJumps = this._getValidJumpDests(code);
pc = this._runState.programCounter;
if (pc !== 0 && (pc < 0 || pc >= this._runState.code.length)) {
throw new Error('Internal error: program counter not in range');
}
_a.label = 1;
case 1:
if (!(this._runState.programCounter < this._runState.code.length)) return [3 /*break*/, 7];
opCode = this._runState.code[this._runState.programCounter];
this._runState.opCode = opCode;
return [4 /*yield*/, this._runStepHook()];
case 2:
_a.sent();
_a.label = 3;
case 3:
_a.trys.push([3, 5, , 6]);
return [4 /*yield*/, this.runStep()];
case 4:
_a.sent();
return [3 /*break*/, 6];
case 5:
e_1 = _a.sent();
// STOP is not an exception
if (e_1.error !== exceptions_1.ERROR.STOP) {
err = e_1;
}
// TODO: Throw on non-VmError exceptions
return [3 /*break*/, 7];
case 6: return [3 /*break*/, 1];
case 7: return [2 /*return*/, {
runState: this._runState,
exceptionError: err,
}];
}
});
});
};
/**
* Executes the opcode to which the program counter is pointing,
* reducing it's base gas cost, and increments the program counter.
*/
Interpreter.prototype.runStep = function () {
return __awaiter(this, void 0, void 0, function () {
var opInfo, opFn;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
opInfo = this.lookupOpInfo(this._runState.opCode);
// Check for invalid opcode
if (opInfo.name === 'INVALID') {
throw new exceptions_1.VmError(exceptions_1.ERROR.INVALID_OPCODE);
}
// Reduce opcode's base fee
this._eei.useGas(new BN(opInfo.fee));
// Advance program counter
this._runState.programCounter++;
opFn = this.getOpHandler(opInfo);
if (!opInfo.isAsync) return [3 /*break*/, 2];
return [4 /*yield*/, opFn.apply(null, [this._runState])];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
opFn.apply(null, [this._runState]);
_a.label = 3;
case 3: return [2 /*return*/];
}
});
});
};
/**
* Get the handler function for an opcode.
*/
Interpreter.prototype.getOpHandler = function (opInfo) {
return opFns_1.handlers[opInfo.name];
};
/**
* Get info for an opcode from VM's list of opcodes.
*/
Interpreter.prototype.lookupOpInfo = function (op, full) {
if (full === void 0) { full = false; }
var opcode = this._vm._opcodes[op]
? this._vm._opcodes[op]
: { name: 'INVALID', fee: 0, isAsync: false };
if (full) {
var name = opcode.name;
if (name === 'LOG') {
name += op - 0xa0;
}
if (name === 'PUSH') {
name += op - 0x5f;
}
if (name === 'DUP') {
name += op - 0x7f;
}
if (name === 'SWAP') {
name += op - 0x8f;
}
return __assign(__assign({}, opcode), { name: name });
}
return opcode;
};
Interpreter.prototype._runStepHook = function () {
return __awaiter(this, void 0, void 0, function () {
var eventObj, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
eventObj = {
pc: this._runState.programCounter,
gasLeft: this._eei.getGasLeft(),
opcode: this.lookupOpInfo(this._runState.opCode, true),
stack: this._runState.stack._store,
depth: this._eei._env.depth,
address: this._eei._env.address,
account: this._eei._env.contract,
stateManager: this._runState.stateManager,
memory: this._runState.memory._store,
memoryWordCount: this._runState.memoryWordCount,
codeAddress: this._eei._env.codeAddress,
};
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, this._logStep(eventObj)];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
err_1 = _a.sent();
logger.log("STEP LOGGING ERROR: " + err_1.toString());
return [3 /*break*/, 4];
case 4:
/**
* The `step` event for trace output
*
* @event Event: step
* @type {Object}
* @property {Number} pc representing the program counter
* @property {String} opcode the next opcode to be ran
* @property {BN} gasLeft amount of gasLeft
* @property {Array} stack an `Array` of `Buffers` containing the stack
* @property {Account} account the [`Account`](https://github.com/ethereum/ethereumjs-account) which owns the code running
* @property {Buffer} address the address of the `account`
* @property {Number} depth the current number of calls deep the contract is
* @property {Buffer} memory the memory of the VM as a `buffer`
* @property {BN} memoryWordCount current size of memory in words
* @property {StateManager} stateManager a [`StateManager`](stateManager.md) instance (Beta API)
*/
return [2 /*return*/, this._vm._emit('step', eventObj)];
}
});
});
};
// Returns all valid jump destinations.
Interpreter.prototype._getValidJumpDests = function (code) {
var jumps = [];
for (var i = 0; i < code.length; i++) {
var curOpCode = this.lookupOpInfo(code[i]).name;
// no destinations into the middle of PUSH
if (curOpCode === 'PUSH') {
i += code[i] - 0x5f;
}
if (curOpCode === 'JUMPDEST') {
jumps.push(i);
}
}
return jumps;
};
Interpreter.prototype._logStep = function (step) {
return __awaiter(this, void 0, void 0, function () {
var isEntryPoint, contractName, description, addressStart, addressEnd, callLogger, stepLogger, memLogger, memSizeLogger, gasLogger, loggers, stack, memory, op, offset, length, data, target, offset, length, calldata, code, isECDSAContractAccount, targetContract, methodId, fragment, logString, decodedArgs, memsize;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (process_1.env.DEBUG_OVM != 'true') {
return [2 /*return*/];
}
if (this._firstStep && step.depth == 0) {
this._initialGas = step.gasLeft;
this._firstStep = false;
}
isEntryPoint = step.depth === 0;
if (!(step.depth in this._loggers)) {
contractName = this._vm.getContract(step.address);
description = isEntryPoint ? 'OVM TX starts with' : 'EVM STEPS for';
addressStart = step.address.slice(0, 3).toString('hex');
addressEnd = step.address.slice(step.address.length - 3).toString('hex');
callLogger = new logger_1.Logger(logger.namespace + ':0x' + addressStart + '..' + addressEnd + ':d' + step.depth + ':calls');
stepLogger = new logger_1.Logger(callLogger.namespace + ':steps');
memLogger = new logger_1.Logger(callLogger.namespace + ':memory');
memSizeLogger = new logger_1.Logger(callLogger.namespace + ':memorysize');
gasLogger = new logger_1.Logger(callLogger.namespace + ':steps');
if (isEntryPoint) {
callLogger.open(description + " " + contractName + " at depth " + step.depth);
}
else {
stepLogger.open(description + " " + contractName + " at depth " + step.depth);
}
this._loggers[step.depth] = {
callLogger: callLogger,
stepLogger: stepLogger,
memLogger: memLogger,
gasLogger: gasLogger,
memSizeLogger: memSizeLogger,
};
}
loggers = this._loggers[step.depth];
stack = new (Array.bind.apply(Array, __spreadArrays([void 0], step.stack)))().reverse();
memory = step.memory;
op = step.opcode.name;
if (!['RETURN', 'REVERT', 'STOP', 'INVALID'].includes(op)) return [3 /*break*/, 1];
if (step.depth === 0) {
loggers.gasLogger.log("OVM tx completed having used " + this._initialGas.sub(step.gasLeft).toString() + " gas.");
}
if (['RETURN', 'REVERT'].includes(op)) {
offset = stack[0].toNumber();
length = stack[1].toNumber();
data = Buffer.from(memory.slice(offset, offset + length));
loggers.callLogger.log(op + " with data: " + buffer_utils_1.toHexString(data));
}
else {
loggers.callLogger.log(op);
}
if (isEntryPoint) {
loggers.callLogger.close();
}
else {
loggers.stepLogger.close();
}
delete this._loggers[step.depth];
return [3 /*break*/, 4];
case 1:
if (!(op === 'CALL')) return [3 /*break*/, 3];
target = stack[1].toBuffer();
offset = stack[3].toNumber();
length = stack[4].toNumber();
calldata = Buffer.from(memory.slice(offset, offset + length));
return [4 /*yield*/, this._state.getContractCode(target)];
case 2:
code = _a.sent();
isECDSAContractAccount = buffer_utils_1.toHexString(code) === this._vm.contracts.mockOVM_ECDSAContractAccount.code;
targetContract = isECDSAContractAccount
? this._vm.getContractByName('mockOVM_ECDSAContractAccount')
: this._vm.getContract(target);
if (targetContract) {
methodId = '0x' + calldata.slice(0, 4).toString('hex');
fragment = targetContract.iface.getFunction(methodId);
logString = void 0;
try {
decodedArgs = targetContract.iface.decodeFunctionData(fragment, buffer_utils_1.toHexString(calldata));
logString = "CALL to " + targetContract.name + "." + fragment.name + " with args: " + decodedArgs;
}
catch (_b) {
logString = "CALL to " + targetContract.name + "." + fragment.name + " with raw data (failed to decode): 0x" + calldata.toString('hex');
}
loggers.callLogger.log(logString);
}
else {
loggers.callLogger.log("CALL to unknown contract (" + buffer_utils_1.toHexString(target) + ") with data: " + buffer_utils_1.toHexString(calldata));
}
return [3 /*break*/, 4];
case 3:
loggers.stepLogger.log("opcode: " + op.padEnd(10, ' ') + " pc: " + step.pc
.toString()
.padEnd(10, ' ') + " gasLeft: " + step.gasLeft.toString() + "\nstack: [" + stack
.map(function (el, idx) {
return " " + idx + ": " + buffer_utils_1.toHexString(el);
})
.join('') + "]");
if (this._printNextMemory ||
['CALL', 'CREATE', 'CREATE2', 'STATICCALL', 'DELEGATECALL'].includes(op)) {
memsize = memory.length;
if (memsize > 20000) {
loggers.memSizeLogger.log("MSIZE of " + memsize + " in memory modifying step.");
}
loggers.memLogger.log("$[" + buffer_utils_1.toHexString(Buffer.from(memory)) + "]");
}
this._printNextMemory = ['MSTORE', 'CALLDATACOPY', 'RETURNDATACOPY', 'CODECOPY'].includes(op);
_a.label = 4;
case 4: return [2 /*return*/];
}
});
});
};
return Interpreter;
}());
exports.default = Interpreter;
//# sourceMappingURL=interpreter.js.map