ethereumjs-ovm comparison

README.md

@@ -73,14 +73,14 @@ Produces `dist` files for all sub-packages. This command can be scoped
 
 #### `npm run build:tree -- --scope @ethereumjs/blockchain`
 
-Builds all local packages that the provided package (eg: @ethereumjs/blockchain) depends on, and itself. This unusual syntax just means: pass whatever arguments are after `--` to the underlying script. 
+Builds all local packages that the provided package (eg: @ethereumjs/blockchain) depends on, and itself. This unusual syntax just means: pass whatever arguments are after `--` to the underlying script.
 
 If no scope is provided, `npm run build:tree`, will build all sub-packages.
 
 ### Package scripts — run from `./packages/<name>`
 
  **⚠️ Important: if you run `npm install` from the package directory, it will remove all links to the local packages, pulling all dependencies from npm. Run `npm install` from the root only.**
- 
+
 There's a set of rather standardized commands you will find in each package of this repository.
 
 #### `npm run build`
@@ -101,7 +101,7 @@ Checks code style, according to the rules defined in [ethereumjs-config](https:/
 
 #### `npm run lint:fix`
 
-Fixes code style, according to the rules 
+Fixes code style, according to the rules
 
 #### `npm run test`
 

lib/ovm/ovm-state-manager.ts

@@ -0,0 +1,126 @@
+/* External Imports */
+import BN = require('bn.js')
+import { BigNumber, ethers } from 'ethers'
+
+/* Internal Imports */
+import VM from '../index'
+import Message from '../evm/message'
+import { fromHexString, toHexString } from './utils/buffer-utils'
+import { NULL_BYTES32 } from './utils/constants'
+
+export interface OvmStateManagerOpts {
+  vm: VM
+}
+
+export class OvmStateManager {
+  public vm: VM
+  private _iface: any
+  private _handlers: {
+    [name: string]: any
+  }
+
+  constructor(opts: OvmStateManagerOpts) {
+    this.vm = opts.vm
+    this._iface = this.vm.contracts.OVM_StateManager.iface
+
+    this._handlers = {
+      hasAccount: this.hasAccount.bind(this),
+      hasEmptyAccount: this.hasEmptyAccount.bind(this),
+      setAccountNonce: this.setAccountNonce.bind(this),
+      getAccountNonce: this.getAccountNonce.bind(this),
+      getAccountEthAddress: this.getAccountEthAddress.bind(this),
+      getContractStorage: this.getContractStorage.bind(this),
+      hasContractStorage: this.hasContractStorage.bind(this),
+      putContractStorage: this.putContractStorage.bind(this),
+      testAndSetAccountLoaded: this.testAndSetAccountLoaded.bind(this),
+      testAndSetAccountChanged: this.testAndSetAccountChanged.bind(this),
+      testAndSetContractStorageLoaded: this.testAndSetContractStorageLoaded.bind(this),
+      testAndSetContractStorageChanged: this.testAndSetContractStorageChanged.bind(this),
+      isAuthenticated: this.isAuthenticated.bind(this),
+    }
+  }
+
+  async isAuthenticated(message: Message, context: any): Promise<boolean> {
+    return true
+  }
+
+  async handleCall(message: Message, context: any): Promise<any> {
+    const methodId = '0x' + message.data.slice(0, 4).toString('hex')
+    const fragment = this._iface.getFunction(methodId)
+    const functionArgs = this._iface.decodeFunctionData(fragment, toHexString(message.data))
+
+    let ret: any
+    if (fragment.name in this._handlers) {
+      ret = await this._handlers[fragment.name](...functionArgs)
+      ret = ret === null || ret === undefined ? ret : [ret]
+    }
+
+    try {
+      const encodedRet = this._iface.encodeFunctionResult(fragment, ret)
+      return fromHexString(encodedRet)
+    } catch (err) {
+      console.log(`Caught encoding error in ovmStateManager: ${err}`)
+      throw err
+    }
+  }
+
+  async hasAccount(address: string): Promise<boolean> {
+    return true
+  }
+
+  async hasEmptyAccount(address: string): Promise<boolean> {
+    return true
+  }
+
+  async setAccountNonce(address: string, nonce: BigNumber): Promise<void> {
+    const account = await this.vm.pStateManager.getAccount(fromHexString(address))
+    account.nonce = new BN(nonce.toNumber()).toArrayLike(Buffer)
+    return this.vm.pStateManager.putAccount(fromHexString(address), account)
+  }
+
+  async getAccountNonce(address: string): Promise<number> {
+    const account = await this.vm.pStateManager.getAccount(fromHexString(address))
+    return new BN(account.nonce).toNumber()
+  }
+
+  async getAccountEthAddress(address: string): Promise<string> {
+    return address
+  }
+
+  async getContractStorage(address: string, key: string): Promise<string> {
+    const ret = await this.vm.pStateManager.getContractStorage(
+      fromHexString(address),
+      fromHexString(key),
+    )
+
+    return ret.length ? toHexString(ret) : NULL_BYTES32
+  }
+
+  async hasContractStorage(address: string, key: string): Promise<boolean> {
+    return true
+  }
+
+  async putContractStorage(address: string, key: string, value: string): Promise<void> {
+    return this.vm.pStateManager.putContractStorage(
+      fromHexString(address),
+      fromHexString(key),
+      fromHexString(value),
+    )
+  }
+
+  async testAndSetAccountLoaded(address: string): Promise<boolean> {
+    return true
+  }
+
+  async testAndSetAccountChanged(address: string): Promise<boolean> {
+    return true
+  }
+
+  async testAndSetContractStorageLoaded(address: string, key: string): Promise<boolean> {
+    return true
+  }
+
+  async testAndSetContractStorageChanged(address: string, key: string): Promise<boolean> {
+    return true
+  }
+}

lib/ovm/utils/buffer-utils.ts

@@ -0,0 +1,26 @@
+export const toHexAddress = (buf: any): string => {
+  // pad shorter values out
+  if (buf.length < 20) {
+    buf = Buffer.concat([Buffer.alloc(31), buf])
+  }
+
+  return (
+    '0x' +
+    buf
+      .slice(buf.length - 20)
+      .toString('hex')
+      .padStart(40, '0')
+  )
+}
+
+export const toHexString = (buf: any): string => {
+  return '0x' + buf.toString('hex')
+}
+
+export const fromHexString = (str: string): Buffer => {
+  return Buffer.from(str.slice(2), 'hex')
+}
+
+export const toAddressBuf = (address: string | Buffer): Buffer => {
+  return typeof address === 'string' ? fromHexString(address) : address
+}

lib/ovm/utils/constants.ts

@@ -0,0 +1,6 @@
+const makeNullBytes = (length: number): string => {
+  return '0x' + '00'.repeat(length)
+}
+
+export const NULL_ADDRESS = makeNullBytes(20)
+export const NULL_BYTES32 = makeNullBytes(32)

lib/ovm/utils/logger.ts

@@ -0,0 +1,48 @@
+import debug, { Debugger } from 'debug'
+import { v4 as uuidv4 } from 'uuid'
+
+export class Logger {
+  private _namespace: string
+  private _debugger: Debugger
+  private _section: string | undefined
+
+  constructor(namespace: string) {
+    this._namespace = namespace
+    this._debugger = debug(namespace)
+  }
+
+  log(message: string): void {
+    this._debugger(message)
+  }
+
+  scope(namespace: string, id?: string): Logger {
+    return new Logger(`${this._namespace}:${namespace}:${id || uuidv4()}`)
+  }
+
+  get enabled(): boolean {
+    return this._debugger.enabled
+  }
+
+  get namespace(): string {
+    return this._namespace
+  }
+
+  logSection(message: string): void {
+    this.log(`------${'-'.repeat(message.length)}------`)
+    this.log(`----- ${message} -----`)
+    this.log(`------${'-'.repeat(message.length)}------`)
+  }
+
+  open(message: string): void {
+    this._section = message
+    this.logSection(`BEGIN: ${this._section}`)
+  }
+
+  close(): void {
+    if (!this._section) {
+      return
+    }
+
+    this.logSection(`END  : ${this._section}`)
+  }
+}

packages/vm/CHANGELOG.md

@@ -147,7 +147,7 @@ Added EIPs:
 - [EIP-152](https://eips.ethereum.org/EIPS/eip-152): Blake 2b `F` precompile,
   PR [#584](https://github.com/ethereumjs/ethereumjs-vm/pull/584)
 - [EIP-1108](https://eips.ethereum.org/EIPS/eip-1108): Reduce `alt_bn128`
-  precompile gas costs,  
+  precompile gas costs,
   PR [#540](https://github.com/ethereumjs/ethereumjs-vm/pull/540)
   (already released in `v4.0.0`)
 - [EIP-1344](https://eips.ethereum.org/EIPS/eip-1344): Add ChainID Opcode,

packages/vm/lib/evm/eei.ts

@@ -27,6 +27,9 @@ export interface Env {
   contract: Account
   // Different than address for DELEGATECALL and CALLCODE
   codeAddress: Buffer
+
+  // Custom variables
+  originalTargetAddress: Buffer
 }
 
 /**
@@ -402,6 +405,7 @@ export default class EEI {
       data: data,
       isStatic: this._env.isStatic,
       depth: this._env.depth + 1,
+      originalTargetAddress: this._env.originalTargetAddress,
     })
 
     return this._baseCall(msg)
@@ -420,6 +424,7 @@ export default class EEI {
       data: data,
       isStatic: this._env.isStatic,
       depth: this._env.depth + 1,
+      originalTargetAddress: this._env.originalTargetAddress,
     })
 
     return this._baseCall(msg)
@@ -439,6 +444,7 @@ export default class EEI {
       data: data,
       isStatic: true,
       depth: this._env.depth + 1,
+      originalTargetAddress: this._env.originalTargetAddress,
     })
 
     return this._baseCall(msg)
@@ -459,6 +465,7 @@ export default class EEI {
       isStatic: this._env.isStatic,
       delegatecall: true,
       depth: this._env.depth + 1,
+      originalTargetAddress: this._env.originalTargetAddress,
     })
 
     return this._baseCall(msg)
@@ -520,6 +527,7 @@ export default class EEI {
       salt: salt,
       depth: this._env.depth + 1,
       selfdestruct: selfdestruct,
+      originalTargetAddress: this._env.originalTargetAddress,
     })
 
     // empty the return data buffer