github/circom-stark
1
1
Fork 0
mirror of https://github.com/chancehudson/circom-stark.git synced 2026-01-09 13:57:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
Chance
2023-12-07 11:14:16 -06:00
parent c426911f1f
commit 54e8e81b7b
1 changed files with 3 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -1,54 +1,7 @@
# circom-stark [![CircleCI](https://img.shields.io/circleci/build/github/vimwitch/circom-stark/main)](https://app.circleci.com/pipelines/github/vimwitch/circom-stark)
A lightweight turing-incomplete assembly language for STARK proofs. Designed to express r1cs proofs in STARKs.
A binding to make R1CS proofs using [rstark](https://github.com/vimwitch/rstark).
## Syntax
## About
Each line of a circuitvm `asm` file should contain an opcode, followed by registers to operate on. Each argument should be separated by exactly 1 space. Numbers may be prefixed by `0x` for hex, or written normally for decimal.
Lines starting with `;` or containing only whitespace are ignored.
## Opcodes
`set` - Store a value in a register. No assertion is made about the previous value. `value` may be a named variable accepted as an argument during compilation.
```
# set {register} {value}
set 0x0 0x1920490
set 0x1 secret_input
```
`add` - Add two registers together, store the result in a third register. Output register may be one of the input registers (e.g. overwrite the previous value).
```
# add {output_register} {register1} {register2}
add 0x2 0x0 0x1
```
`mul` - Multiply two registers, store the result in a third register. Output register may be one of the input registers (e.g. overwrite the previous value).
```
# mul {output_register} {register1} {register2}
mul 0x2 0x0 0x1
```
`neg` - Negate a value in a register, store the result in an output register. Output register may be the input register (e.g. negate in place).
```
# neg {output} {register}
neg 0x1 0x0
```
`eq` - Assert equality of two registers. The output register is implicity `F_p - 1` indicating that no register in the trace should be mutated.
```
# eq {register1} {register2}
eq 0x0 0x1
```
`out` - Create a boundary constraint for a register publicly constraining a value. This is analogous to a public signal.
```
# out {register} {value}
out 0x1 0x1000100001
```
R1CS proofs are based on sets of constraints of the form `A*B - C = 0` where `A`, `B`, and `C` are scalar sums. We can take such a system and reduce it to a single constraint using a random linear combination. This reduces to a STARK proof with trace length 1 and 1 constraint. The proof speed is limited by the total number of variables (aka signals) in the R1CS.