Coder Social home page Coder Social logo

amirgamil / cannon Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ethereum-optimism/cannon

2.0 1.0 0.0 12.65 MB

On chain interactive fault prover for Ethereum

License: MIT License

Shell 0.50% JavaScript 12.12% Python 1.25% Go 13.96% Assembly 28.60% Makefile 1.28% Solidity 42.29%

cannon's Introduction

cannon


NEW: Cannon is currently the object of a bug bounty on Immunefi. Find vulnerabilities in Cannon for up to a $50.000 payout.


The cannon (cannon cannon cannon) is an on chain interactive dispute engine implementing EVM-equivalent fault proofs.

It's half geth, half MIPS, and whole awesome.

  • It's Go code
  • ...that runs an EVM
  • ...emulating a MIPS machine
  • ...running compiled Go code
  • ...that runs an EVM

For more information on Cannon's inner workings, check this overview.

Directory Layout

minigeth -- A standalone "geth" capable of computing a block transition
mipigo -- minigeth compiled for MIPS. Outputs a MIPS binary that's run and mapped at 0x0
mipsevm -- A MIPS runtime in the EVM (works with contracts)
contracts -- A Merkleized MIPS processor on chain + the challenge logic

Building

Pre-requisites: Go, Node.js, and Make.

make build
make test # verify everything works correctly

Usage

The following commands should be run from the root directory unless otherwise specified:

# compute the transition from 13284469 -> 13284470 on PC
TRANSITION_BLOCK=13284469
mkdir -p /tmp/cannon
minigeth/go-ethereum $TRANSITION_BLOCK

# write out the golden MIPS minigeth start state
mipsevm/mipsevm

# if you run into "digital envelope routines::unsupported", rerun after this:
# export NODE_OPTIONS=--openssl-legacy-provider

# generate MIPS checkpoints
mipsevm/mipsevm $TRANSITION_BLOCK

# deploy the MIPS and challenge contracts
npx hardhat run scripts/deploy.js

Examples

The script files demo/challenge_simple.sh and demo/challenge_fault.sh present two example scenarios demonstrating the whole process of a fault proof, including the challenge game and single step verification.

  • In the simple challenge, the challenger uses the wrong block data in his challenge.
  • In the fault scenario, fault injection is used to alter the challenger's memory at a specific step of the execution.

In both cases, the challenger fails to challenge the block. Refer to the documentation string at the top of these file for more details regarding the scenario.

State Oracle API

On chain / in MIPS, we have two simple oracles

  • InputHash() -> hash
  • Preimage(hash) -> value

We generate the Preimages in x86 using geth RPC

  • PrefetchAccount
  • PrefetchStorage
  • PrefetchCode
  • PrefetchBlock

These are NOP in the VM

License

Most of this code is MIT licensed, minigeth is LGPL3.

Note: This code is unaudited. It in NO WAY should be used to secure any money until a lot more testing and auditing are done. I have deployed this nowhere, have advised against deploying it, and make no guarantees of security of ANY KIND.

cannon's People

Contributors

0xrin1 avatar avahowell avatar ben-chain avatar cfromknecht avatar geohot avatar han0110 avatar mariobyn avatar maurelian avatar norswap avatar rootulp avatar sblowpckcr avatar shazow avatar snario avatar tynes avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.