/zvm

Zero Knowledge based Ethereum Virtual Machine in Circom language

Primary LanguageJavaScriptMIT LicenseMIT

zvm

Zero Knowledge based Ethereum Virtual Machine in Circom language

Dependencies

You need node v14, snarkjs and circom.

You can easily install snarkjs and circom by entering the following commands after node v14 is successfully installed.

npm install -g circom@latest
npm install -g snarkjs@latest

Status

zvm is currently under busy construction. The circuit supports the EVM opcodes, the stack size upto eight (unsigned integers), memory size upto eight (unsigned integers) and sixteen input signals of array which represent the bytecodes of EVM.

Completion

The checked opcodes have been implemented.

  • 0x00 STOP; Halts execution

  • 0x01 ADD; Addition operation

  • 0x02 MUL; Multiplication operation

  • 0x03 SUB; Subtraction operation

  • 0x04 DIV; Integer division operation

  • 0x05 SDIV; Signed integer division operation (truncated)

  • 0x06 MOD; Modulo remainder operation

  • 0x07 SMOD; Signed modulo remainder operation

  • 0x08 ADDMOD; Modulo addition operation

  • 0x09 MULMOD; Modulo multiplication operation

  • 0x0a EXP; Exponential operation

  • 0x0b SIGNEXTEND; Extend length of two's complement signed integer

  • 0x0c GCD; Greatest common divisor operation - Only referenced in simple-vm

  • 0x0d LCM; Least common multiple operation - Only referenced in simple-vm

  • 0x0e COMBINATION; Combination operation (nCr) - Only referenced in simple-vm

  • 0x0f FACTORIAL; Factorial operation (n!) - Only referenced in simple-vm

  • 0x10 LT; Less-than comparison

  • 0x11 GT; Greater-than comparison

  • 0x12 SLT; Signed less-than comparison

  • 0x13 SGT; Signed greater-than comparison

  • 0x14 EQ; Equality comparison

  • 0x15 ISZERO; Simple not operator

  • 0x16 AND; Bitwise AND operation

  • 0x17 OR; Bitwise OR operation

  • 0x18 XOR; Bitwise XOR operation

  • 0x19 NOT; Bitwise NOT operation

  • 0x1a BYTE; Retrieve single byte from word

  • 0x1b SHL; Shift Left

  • 0x1c SHR; Logical Shift Right

  • 0x1d SAR; Arithmetic Shift Right

  • 0x20 KECCAK256; Compute Keccak-256 hash

  • 0x30 ADDRESS; Get address of currently executing account

  • 0x31 BALANCE; Get balance of the given account

  • 0x32 ORIGIN; Get execution origination address

  • 0x33 CALLER; Get caller address

  • 0x34 CALLVALUE; Get deposited value by the instruction/transaction responsible for this execution

  • 0x35 CALLDATALOAD; Get input data of current environment

  • 0x36 CALLDATASIZE; Get size of input data in current environment

  • 0x37 CALLDATACOPY; Copy input data in current environment to memory

  • 0x38 CODESIZE; Get size of code running in current environment

  • 0x39 CODECOPY; Copy code running in current environment to memory

  • 0x3a GASPRICE; Get price of gas in current environment

  • 0x3b EXTCODESIZE; Get size of an account's code

  • 0x3c EXTCODECOPY; Copy an account's code to memory

  • 0x3d RETURNDATASIZE; Pushes the size of the return data buffer onto the stack

  • 0x3e RETURNDATACOPY; Copies data from the return data buffer to memory

  • 0x3f EXTCODEHASH; Returns the keccak256 hash of a contract's code

  • 0x40 BLOCKHASH; Get the hash of one of the 256 most recent complete blocks 0

  • 0x41 COINBASE; Get the block's beneficiary address

  • 0x42 TIMESTAMP; Get the block's timestamp

  • 0x43 NUMBER; Get the block's number

  • 0x44 DIFFICULTY; Get the block's difficulty

  • 0x45 GASLIMIT; Get the block's gas limit

  • 0x46 CHAINID; Returns the current chain’s EIP-155 unique identifier

  • 0x50 POP; Remove an item from stack

  • 0x51 MLOAD; Load an item from memory

  • 0x52 MSTORE; Save an item to memory

  • 0x53 MSTORE8; Save byte to memory

  • 0x54 SLOAD; Load word from storage

  • 0x55 SSTORE; Save word to storage

  • 0x56 JUMP; Alter the program counter

  • 0x57 JUMPI; Conditionally alter the program counter

  • 0x58 GETPC; Get the value of the program counter prior to the increment

  • 0x59 MSIZE; Get the size of active memory in bytes

  • 0x5a GAS; Get the amount of available gas, including the corresponding reduction the amount of available gas

  • 0x5b JUMPDEST; Mark a valid destination for jumps

  • 0x60 PUSH; Place one uint item on stack ([NOTE] Not n-byte item)

  • 0x80 DUP1; Duplicate 1st stack item

  • 0x81 DUP2; Duplicate 2nd stack item

  • 0x82 DUP3; Duplicate 3rd stack item

  • 0x83 DUP4; Duplicate 4th stack item

  • 0x84 DUP5; Duplicate 5th stack item

  • 0x85 DUP6; Duplicate 6th stack item

  • 0x86 DUP7; Duplicate 7th stack item

  • 0x87 DUP8; Duplicate 8th stack item

  • 0x88 DUP9; Duplicate 9th stack item

  • 0x89 DUP10; Duplicate 10th stack item

  • 0x8a DUP11; Duplicate 11th stack item

  • 0x8b DUP12; Duplicate 12th stack item

  • 0x8c DUP13; Duplicate 13th stack item

  • 0x8d DUP14; Duplicate 14th stack item

  • 0x8e DUP15; Duplicate 15th stack item

  • 0x8f DUP16; Duplicate 16th stack item

  • 0x90 SWAP1; Exchange 1st and 2nd stack items

  • 0x91 SWAP2; Exchange 1st and 3rd stack items

  • 0x92 SWAP3; Exchange 1st and 4th stack items

  • 0x93 SWAP4; Exchange 1st and 5th stack items

  • 0x94 SWAP5; Exchange 1st and 6th stack items

  • 0x95 SWAP6; Exchange 1st and 7th stack items

  • 0x96 SWAP7; Exchange 1st and 8th stack items

  • 0x97 SWAP8; Exchange 1st and 9th stack items

  • 0x98 SWAP9; Exchange 1st and 10th stack items

  • 0x99 SWAP10; Exchange 1st and 11th stack items

  • 0x9a SWAP11; Exchange 1st and 12th stack items

  • 0x9b SWAP12; Exchange 1st and 13th stack items

  • 0x9c SWAP13; Exchange 1st and 14th stack items

  • 0x9d SWAP14; Exchange 1st and 15th stack items

  • 0x9e SWAP15; Exchange 1st and 16th stack items

  • 0x9f SWAP16; Exchange 1st and 17th stack items

  • 0xa0 LOG0; Append log record with no topics

  • 0xa1 LOG1; Append log record with one topic

  • 0xa2 LOG2; Append log record with two topics

  • 0xa3 LOG3; Append log record with three topics

  • 0xa4 LOG4; Append log record with four topics

  • 0xb0 JUMPTO; Tentative libevmasm has different numbers

  • 0xb1 JUMPIF; Tentative

  • 0xb2 JUMPSUB; Tentative

  • 0xb4 JUMPSUBV; Tentative

  • 0xb5 BEGINSUB; Tentative

  • 0xb6 BEGINDATA; Tentative

  • 0xb8 RETURNSUB; Tentative

  • 0xb9 PUTLOCAL; Tentative

  • 0xba GETLOCAL; Tentative

  • 0xf0 CREATE; Create a new account with associated code

  • 0xf1 CALL; Message-call into an account

  • 0xf2 CALLCODE; Message-call into this account with alternative account's code

  • 0xf3 RETURN; Halt execution returning output data

  • 0xf4 DELEGATECALL; Message-call into this account with an alternative account's code, but persisting into this account with an alternative account's code

  • 0xf5 CREATE2; Create a new account and set creation address to sha3(sender + sha3(init code)) % 2**160

  • 0xfa STATICCALL; Similar to CALL, but does not modify state

  • 0xfc TXEXECGAS; Not in yellow paper FIXME

  • 0xfd REVERT; Stop execution and revert state changes, without consuming all provided gas and providing a reason

  • 0xfe INVALID; Designated invalid instruction

  • 0xff SELFDESTRUCT; Halt execution and register account for later deletion

Quick Start

You can simply do following things with zvm.sh

  1. Building trusted setups
  2. Compile Circom circuits
  3. Debug
  4. Generate and verify a proof
$ cd src
$ ./zvm.sh
Commands
1. Setup phase 1:          $ ./zvm.sh phase1
2. Setup phase 2:          $ ./zvm.sh phase2 [circuit name]
3. Debug with the witness: $ ./zvm.sh debug [circuit name] [input json file path]
4. Generate a proof:       $ ./zvm.sh generate-proof [proof file name] [public file name]
5. Verify a proof:         $ ./zvm.sh verify-proof [proof file path] [public file path] 

Please check snarkjs and circom if you need how it works.

Tutorial

This tutorial leads you how to play with zvm circuit.

Phase 1: General setup

In this phase, you start a new powers of tau ceremony, contribute to the ceremony and apply a random beacon.

$ cd src
$ ./zvm.sh phase1

... 

[DEBUG] snarkJS: betaTauG1: fft 12 join  12/12  1/1 0/2
[DEBUG] snarkJS: betaTauG1: fft 12 join  12/12  1/1 1/2

[NOTE] You can customize the randomness on this step by modifying the script.

Phase 2: Circuit specific setup

You compile a circuit, generate the reference zkey and contribute to the phase 2 ceremony, similar to the previous step. Finally, you export the verification key which is used for verifying a proof.

$ ./zvm.sh phase2 vm

... 

[INFO]  snarkJS: ZKey Ok!

Debug: Calculate a witness and debug the circuit

You execute the circuit with your input file and get debugging result.

$ cat vm-input.json
{"code": ["0x60","0x2","0x60","0x6","0x1","0x0","0x0","0x0","0x0","0x0","0x0","0x0","0x0","0x0","0x0","0x0"]}
  • code array represents bytecodes that EVM takes. For example, vm-input.json describes the following instructions.
PUSH 0x2
PUSH 0x6
ADD
STOP
  • You can read the details of circuit input here
$ ./zvm.sh debug vm vm-input.json

...

[INFO]  snarkJS: START: main
[INFO]  snarkJS: GET main.code[0] --> 96
[INFO]  snarkJS: GET main.code[1] --> 2
[INFO]  snarkJS: GET main.code[2] --> 96
[INFO]  snarkJS: GET main.code[3] --> 6
[INFO]  snarkJS: GET main.code[4] --> 1
[INFO]  snarkJS: GET main.code[5] --> 0
[INFO]  snarkJS: FINISH: main

Generate a proof

You generate a proof using the calculated witness.

$ ./zvm.sh generate-proof proof public

Verify the proof

You verify the proof and it prints the verification result.

$ ./zvm.sh verify-proof proof.json public.json
[INFO]  snarkJS: OK!

Please create an issue if you have any questions.