# simplechainjs-vm > An Simplechain VM implementation Latest version **2.6.5-sipc.1** (published 2019-08-08) · MPL-2.0 license · 0 weekly downloads ## Install ```sh npm install simplechainjs-vm pnpm add simplechainjs-vm yarn add simplechainjs-vm bun add simplechainjs-vm ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.6.5-sipc.1 | | Published | 2019-08-08 | | First published | 2019-05-14 | | Weekly downloads | 0 | | License | MPL-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 11 | | Unpacked size | 177.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | mjbecze | | Maintainers | qcd | | Keywords | ethereum, VM | ## Links - npm: https://www.npmjs.com/package/simplechainjs-vm - Repository: https://github.com/ethereumjs/ethereumjs-vm - Issues: https://github.com/ethereumjs/ethereumjs-vm/issues - npm.io page: https://npm.io/package/simplechainjs-vm ## Dependencies (11) - [async](https://npm.io/package/async.md) ^2.1.2 - [rustbn.js](https://npm.io/package/rustbn.js.md) ~0.2.0 - [safe-buffer](https://npm.io/package/safe-buffer.md) ^5.1.1 - [ethereumjs-block](https://npm.io/package/ethereumjs-block.md) ~2.2.0 - [ethereumjs-common](https://npm.io/package/ethereumjs-common.md) ^1.1.0 - [async-eventemitter](https://npm.io/package/async-eventemitter.md) ^0.2.2 - [ethereumjs-account](https://npm.io/package/ethereumjs-account.md) ^2.0.3 - [simplechainjs-util](https://npm.io/package/simplechainjs-util.md) ^6.1.2-sipc - [merkle-patricia-tree](https://npm.io/package/merkle-patricia-tree.md) ^2.3.2 - [fake-merkle-patricia-tree](https://npm.io/package/fake-merkle-patricia-tree.md) ^1.0.1 - [functional-red-black-tree](https://npm.io/package/functional-red-black-tree.md) ^1.0.1 ## Recent versions - 2.6.5-sipc.1 (latest) — 2019-08-08 - 2.6.5-sipc — 2019-05-30 - 2.6.4-sipc — 2019-05-30 - 2.6.3-sipc — 2019-05-30 - 2.5.0 — 2019-05-29 - 2.6.1-sipc — 2019-05-29 - 3.0.0-sipc — 2019-05-29 - 2.6.0-sipc — 2019-05-15 - 3.0.0 — 2019-05-14 ## README # SYNOPSIS [![NPM Package](https://img.shields.io/npm/v/ethereumjs-vm.svg?style=flat-square)](https://www.npmjs.org/package/ethereumjs-vm) [![Build Status]( https://img.shields.io/circleci/project/github/ethereumjs/ethereumjs-vm/master.svg )](https://circleci.com/gh/ethereumjs/ethereumjs-vm) [![Coverage Status](https://img.shields.io/coveralls/ethereumjs/ethereumjs-vm.svg?style=flat-square)](https://coveralls.io/r/ethereumjs/ethereumjs-vm) [![Gitter](https://img.shields.io/gitter/room/ethereum/ethereumjs-lib.svg?style=flat-square)](https://gitter.im/ethereum/ethereumjs-lib) or #ethereumjs on freenode [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) Implements Ethereum's VM in Javascript. #### Fork Support The VM (`v2.6.x` release series) currently supports the following hardforks (default: `Byzantium`): - `Byzantium` - `Constantinople` - `Petersburg` Parallel HF support was introduced in the `v2.5.0` release, if you want some background have a look at the respective [release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/v2.5.0). If you are still looking for a [Spurious Dragon](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-607.md) compatible version of this library install the latest of the ``2.2.x`` series (see [Changelog](./CHANGELOG.md)). # INSTALL `npm install ethereumjs-vm` # USAGE ```javascript var VM = require('ethereumjs-vm') //create a new VM instance var vm = new VM() var code = '7f4e616d65526567000000000000000000000000000000000000000000000000003055307f4e616d6552656700000000000000000000000000000000000000000000000000557f436f6e666967000000000000000000000000000000000000000000000000000073661005d2720d855f1d9976f88bb10c1a3398c77f5573661005d2720d855f1d9976f88bb10c1a3398c77f7f436f6e6669670000000000000000000000000000000000000000000000000000553360455560df806100c56000396000f3007f726567697374657200000000000000000000000000000000000000000000000060003514156053576020355415603257005b335415603e5760003354555b6020353360006000a233602035556020353355005b60007f756e72656769737465720000000000000000000000000000000000000000000060003514156082575033545b1560995733335460006000a2600033545560003355005b60007f6b696c6c00000000000000000000000000000000000000000000000000000000600035141560cb575060455433145b1560d25733ff5b6000355460005260206000f3' vm.runCode({ code: Buffer.from(code, 'hex'), // code needs to be a Buffer gasLimit: Buffer.from('ffffffff', 'hex') }, function(err, results){ console.log('returned: ' + results.return.toString('hex')); }) ``` Also more examples can be found here - [examples](./examples) - [old blog post](https://wanderer.github.io/ethereum/nodejs/code/2014/08/12/running-contracts-with-vm/) # BROWSER To build for standalone use in the browser, install `browserify` and check [run-transactions-simple example](https://github.com/ethereumjs/ethereumjs-vm/tree/master/examples/run-transactions-simple). This will give you a global variable `EthVM` to use. The generated file will be at `./examples/run-transactions-simple/build.js`. # API ## VM For documentation on ``VM`` instantiation, exposed API and emitted ``events`` see generated [API docs](./docs/index.md). ## StateManger The API for the ``StateManager`` is currently in ``Beta``, separate documentation can be found [here](./docs/stateManager.md). The ``StateManager`` API has been largely reworked recently and the ``StateManager`` will be removed from the VM and provided as a separate package in a future ``v3.0.0`` release, see [release notes](https://github.com/ethereumjs/ethereumjs-vm/releases/tag/v2.5.0) for the ``v2.5.0`` VM release for further details. # Internal Structure The VM processes state changes at many levels. * **runBlockchain** * for every block, runBlock * **runBlock** * for every tx, runTx * pay miner and uncles * **runTx** * check sender balance * check sender nonce * runCall * transfer gas charges * **runCall** * checkpoint state * transfer value * load code * runCode * materialize created contracts * revert or commit checkpoint * **runCode** * iterate over code * run op codes * track gas usage * **OpFns** * run individual op code * modify stack * modify memory * calculate fee The opFns for `CREATE`, `CALL`, and `CALLCODE` call back up to `runCall`. # DEVELOPMENT Developer documentation - currently mainly with information on testing and debugging - can be found [here](./docs/developer.md). # LICENSE [MPL-2.0](https://www.mozilla.org/MPL/2.0/) --- _Source: https://npm.io/package/simplechainjs-vm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._