aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-cov/src/trace.ts
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2019-01-08 19:23:33 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2019-01-08 21:48:06 +0800
commit2c974b5f3ffa0e9736000273e39cdeee4a251b94 (patch)
treea1772f93d796e3b4ba7a988194a44a3e8bcd6d31 /packages/sol-cov/src/trace.ts
parent0ac36cef288deecd36caa601c53d13517eef5ca8 (diff)
downloaddexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.gz
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.bz2
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.lz
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.xz
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.zst
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.zip
Refactor out sol-cov, sol-profiler and sol-trace into their separate packages
Diffstat (limited to 'packages/sol-cov/src/trace.ts')
-rw-r--r--packages/sol-cov/src/trace.ts99
1 files changed, 0 insertions, 99 deletions
diff --git a/packages/sol-cov/src/trace.ts b/packages/sol-cov/src/trace.ts
deleted file mode 100644
index b38dbdce0..000000000
--- a/packages/sol-cov/src/trace.ts
+++ /dev/null
@@ -1,99 +0,0 @@
-import { logUtils } from '@0x/utils';
-import { OpCode, StructLog } from 'ethereum-types';
-import * as _ from 'lodash';
-
-import { utils } from './utils';
-
-export interface TraceByContractAddress {
- [contractAddress: string]: StructLog[];
-}
-
-export function getTracesByContractAddress(structLogs: StructLog[], startAddress: string): TraceByContractAddress {
- const traceByContractAddress: TraceByContractAddress = {};
- let currentTraceSegment = [];
- const addressStack = [startAddress];
- if (_.isEmpty(structLogs)) {
- return traceByContractAddress;
- }
- const normalizedStructLogs = utils.normalizeStructLogs(structLogs);
- // tslint:disable-next-line:prefer-for-of
- for (let i = 0; i < normalizedStructLogs.length; i++) {
- const structLog = normalizedStructLogs[i];
- if (structLog.depth !== addressStack.length - 1) {
- throw new Error("Malformed trace. Trace depth doesn't match call stack depth");
- }
- // After that check we have a guarantee that call stack is never empty
- // If it would: callStack.length - 1 === structLog.depth === -1
- // That means that we can always safely pop from it
- currentTraceSegment.push(structLog);
-
- if (utils.isCallLike(structLog.op)) {
- const currentAddress = _.last(addressStack) as string;
- const jumpAddressOffset = 1;
- const newAddress = utils.getAddressFromStackEntry(
- structLog.stack[structLog.stack.length - jumpAddressOffset - 1],
- );
-
- // Sometimes calls don't change the execution context (current address). When we do a transfer to an
- // externally owned account - it does the call and immediately returns because there is no fallback
- // function. We manually check if the call depth had changed to handle that case.
- const nextStructLog = normalizedStructLogs[i + 1];
- if (nextStructLog.depth !== structLog.depth) {
- addressStack.push(newAddress);
- traceByContractAddress[currentAddress] = (traceByContractAddress[currentAddress] || []).concat(
- currentTraceSegment,
- );
- currentTraceSegment = [];
- }
- } else if (utils.isEndOpcode(structLog.op)) {
- const currentAddress = addressStack.pop() as string;
- traceByContractAddress[currentAddress] = (traceByContractAddress[currentAddress] || []).concat(
- currentTraceSegment,
- );
- currentTraceSegment = [];
- if (structLog.op === OpCode.SelfDestruct) {
- // After contract execution, we look at all sub-calls to external contracts, and for each one, fetch
- // the bytecode and compute the coverage for the call. If the contract is destroyed with a call
- // to `selfdestruct`, we are unable to fetch it's bytecode and compute coverage.
- // TODO: Refactor this logic to fetch the sub-called contract bytecode before the selfdestruct is called
- // in order to handle this edge-case.
- logUtils.warn(
- "Detected a selfdestruct. Sol-cov currently doesn't support that scenario. We'll just skip the trace part for a destructed contract",
- );
- }
- } else if (structLog.op === OpCode.Create) {
- // TODO: Extract the new contract address from the stack and handle that scenario
- logUtils.warn(
- "Detected a contract created from within another contract. Sol-cov currently doesn't support that scenario. We'll just skip that trace",
- );
- return traceByContractAddress;
- } else {
- if (structLog !== _.last(normalizedStructLogs)) {
- const nextStructLog = normalizedStructLogs[i + 1];
- if (nextStructLog.depth === structLog.depth) {
- continue;
- } else if (nextStructLog.depth === structLog.depth - 1) {
- const currentAddress = addressStack.pop() as string;
- traceByContractAddress[currentAddress] = (traceByContractAddress[currentAddress] || []).concat(
- currentTraceSegment,
- );
- currentTraceSegment = [];
- } else {
- throw new Error('Malformed trace. Unexpected call depth change');
- }
- }
- }
- }
- if (addressStack.length !== 0) {
- logUtils.warn('Malformed trace. Call stack non empty at the end');
- }
- if (currentTraceSegment.length !== 0) {
- const currentAddress = addressStack.pop() as string;
- traceByContractAddress[currentAddress] = (traceByContractAddress[currentAddress] || []).concat(
- currentTraceSegment,
- );
- currentTraceSegment = [];
- logUtils.warn('Malformed trace. Current trace segment non empty at the end');
- }
- return traceByContractAddress;
-}