Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ETCDEVTeam/sputnikvm
A Blockchain Virtual Machine
https://github.com/ETCDEVTeam/sputnikvm
ethereum ethereum-classic evm rust virtual-machine
Last synced: 3 months ago
JSON representation
A Blockchain Virtual Machine
- Host: GitHub
- URL: https://github.com/ETCDEVTeam/sputnikvm
- Owner: ETCDEVTeam
- License: apache-2.0
- Created: 2017-03-31T14:42:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T17:43:42.000Z (about 4 years ago)
- Last Synced: 2024-05-18T21:56:05.837Z (6 months ago)
- Topics: ethereum, ethereum-classic, evm, rust, virtual-machine
- Language: Rust
- Homepage:
- Size: 6 MB
- Stars: 274
- Watchers: 35
- Forks: 61
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ethereum-virtual-machine - SputnikVM
README
# SputnikVM: A Blockchain Virtual Machine
[](https://travis-ci.org/ETCDEVTeam/sputnikvm)
[](./LICENSE)
| Name | Description | Crates.io | Documentation |
|--------------------|:---------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|
| sputnikvm | Core library for the Ethereum Virtual Machine | [](https://crates.io/crates/sputnikvm) | [](https://docs.rs/sputnikvm) |
| sputnikvm-stateful | Merkle Trie stateful wrapper for SputnikVM | [](https://crates.io/crates/sputnikvm-stateful) | [](https://docs.rs/sputnikvm-stateful) |
SputnikVM is an implementation of an Ethereum Virtual Machine. It aims to be an
efficient, pluggable virtual machine for different Ethereum-based blockchains.
We encourage all Ethereum'esque blockchains to adopt SputnikVM, and to make use
of SputnikVM's [RFC governance project](https://etcrfc.that.world/) which
governs the parameters of each blockchain's VM. This way we can draw from the
experience of the community and learn from other proposed RFCs.
## Features
* *Standalone* - can be launched as an independent process or integrated into other apps
* *Universal* - supports different Ethereum chains, such as ETC, ETH or private ones
* *Stateless* - only an execution environment connected to independent State storage
* *Fast* - main focus is on performance
* *IoT compatible* - designed to support hardware used in embedded devices
* FFI, Protobuf and JSON interface
* written in Rust, can be used as a binary, cargo crate or shared library
## Supported Networks
| Network | Crates.io | Documentation |
|------------------|:---------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------:|
| Ethereum Classic | [](https://crates.io/crates/sputnikvm-network-classic) | [](https://docs.rs/sputnikvm-network-classic) |
| Ethereum | [](https://crates.io/crates/sputnikvm-network-foundation) | [](https://docs.rs/sputnikvm-network-foundation) |
| Ellaism | [](https://crates.io/crates/sputnikvm-network-ellaism) | [](https://docs.rs/sputnikvm-network-ellaism) |
| Ubiq | [](https://crates.io/crates/sputnikvm-network-ubiq) | [](https://docs.rs/sputnikvm-network-ubiq) |
| Expanse | [](https://crates.io/crates/sputnikvm-network-expanse) | [](https://docs.rs/sputnikvm-network-expanse) |
| Musicoin | [](https://crates.io/crates/sputnikvm-network-musicoin) | [](https://docs.rs/sputnikvm-network-musicoin) |
## Precompiled Contracts
The core library has the initial four precompiled contracts embedded. To use the bn128 and modexp precompiled contracts introduced by the Byzantium hard fork, pull the following crates.
| Name | Description | Crates.io | Documentation |
|------------------------------|:----------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------:|
| sputnikvm-precompiled-bn128 | bn128 precompiled contracts | [](https://crates.io/crates/sputnikvm-precompiled-bn128) | [](https://docs.rs/sputnikvm-precompiled-bn128) |
| sputnikvm-precompiled-modexp | modexp precompiled contracts | [](https://crates.io/crates/sputnikvm-precompiled-modexp) | [](https://docs.rs/sputnikvm-precompiled-modexp) |
## Related projects
* [SputnikVM Dev](https://github.com/ETCDEVTeam/sputnikvm-dev) - SputnikVM instance for Smart Contract development,
provides testing environment and mock for JSON RPC API
* [SputnikVM in Browser](https://github.com/sorpaas/sputnikvm-in-browser) - experimental version of SputnikVM
compiled into WebAssembly, therefore can be launched in a browser on Node.js
* [SputnikVM for embedded devices](https://github.com/sorpaas/sputnikvm-on-rux) - experimental project to run on
full functional EVM on embedded devices
## Dependencies
Ensure you have at least `rustc 1.26.2 (594fb253c 2018-06-01)`. Rust 1.25.0 and
before is not supported.
## Documentation
* [Latest release documentation](https://docs.rs/sputnikvm)
* [Unstable documentation](https://that.world/~docs/sputnikvm/sputnikvm)
## Build from sources
SputnikVM is written Rust. If you are not familiar with Rust please
see the
[getting started guide](https://doc.rust-lang.org/book/ch01-00-getting-started.html).
### Build
To start working with SputnikVM you'll
need to install [rustup](https://www.rustup.rs/), then you can do:
```bash
$ git clone [email protected]:ETCDEVTeam/sputnikvm.git
$ cd sputnikvm
$ cargo build --release --all
```
### Testing
We currently use two ways to test SputnikVM and ensure its execution
aligns with other Ethereum Virtual Machine implementations:
* [jsontests](/jsontests): This uses part of the Ethereum
[tests](https://github.com/ETCDEVTeam/tests). Those tests
currently does not have good coverage for system operation
opcodes. Besides, some tests are incorrect so they are disabled.
* [regtests](/regtests): A complete regression tests is done on the
Ethereum Classic mainnet from genesis block to block 4 million. Some
of the previously failed tests are also integrated into Rust's test
system. See
[wiki](https://github.com/ETCDEVTeam/sputnikvm/wiki/Building-and-Testing)
for how to reproduce the regression tests.
To learn more about building SputnikVM from source please read wiki page
[Building and Testing](https://github.com/ETCDEVTeam/sputnikvm/wiki/Building-and-Testing)
## License
Apache 2.0