swiftness 0.0.5

CLI toolkit to use Swiftness - Rust CairoVM Verifier implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# Swiftness CairoVM Verifier

![Version](https://img.shields.io/badge/v0.0.5-green?style=flat-square&logo=git&logoColor=white&label=version)
![Continuous Integration](https://img.shields.io/github/actions/workflow/status/iosis-tech/swiftness/ci.yml?style=flat-square&logo=githubactions&logoColor=white&label=Continuous%20Integration)

Swiftness is a Rust implementation of the Cairo-VM STARK verifier with layouts, inspired by StarkWare's [Cairo-verifier](https://github.com/starkware-libs/cairo-lang) in Cairo0.

## Getting Started

### Verify an Example Proof

1. **Install `swiftness`:**

   ```sh
   cargo install -f --path cli/ --features starknet_with_keccak,keccak --no-default-features
   ```

2. **Verify the proof:**

   Ensure you use a proof corresponding to the layout and hash used to build the binary.

   ```sh
   swiftness --proof examples/proofs/starknet_with_keccak/cairo0_example_proof.json
   ```

3. **Local Run:**

   ```sh
   cd cli && cargo run --release --bin swiftness --features starknet_with_keccak,keccak --no-default-features -- --proof ../examples/proofs/starknet_with_keccak/cairo0_example_proof.json
   ```

## Running Tests

```sh
cargo test
```

## WebAssembly (WASM) Setup

1. **Install `wasm-pack`:**

   ```sh
   cargo install wasm-pack
   ```

2. **Build WASM:**

   ```sh
   cd wasm_bindings && wasm-pack build --target web --features starknet_with_keccak,blake2s --no-default-features
   ```

## Features

### Usage

- [x] CLI

### Implemented Layouts

- [x] dex
- [x] recursive
- [x] recursive_with_poseidon
- [x] small
- [x] starknet
- [x] starknet_with_keccak

### Commitment Hashes

- [x] keccak
- [x] blake2s

### Web Support

- [x] WASM support
- [x] [Web Demo](https://swiftness-dataprocessor-demo.vercel.app/)
- [x] NPM packages:
  - [swiftness-dex-blake2s](https://www.npmjs.com/package/swiftness-dex-blake2s)
  - [swiftness-dex-keccak](https://www.npmjs.com/package/swiftness-dex-keccak)
  - [swiftness-recursive-blake2s](https://www.npmjs.com/package/swiftness-recursive-blake2s)
  - [swiftness-recursive-keccak](https://www.npmjs.com/package/swiftness-recursive-keccak)
  - [swiftness-recursive-with-poseidon-blake2s](https://www.npmjs.com/package/swiftness-recursive-with-poseidon-blake2s)
  - [swiftness-recursive-with-poseidon-keccak](https://www.npmjs.com/package/swiftness-recursive-with-poseidon-keccak)
  - [swiftness-small-blake2s](https://www.npmjs.com/package/swiftness-small-blake2s)
  - [swiftness-small-keccak](https://www.npmjs.com/package/swiftness-small-keccak)
  - [swiftness-starknet-blake2s](https://www.npmjs.com/package/swiftness-starknet-blake2s)
  - [swiftness-starknet-keccak](https://www.npmjs.com/package/swiftness-starknet-keccak)
  - [swiftness-starknet-with-keccak-blake2s](https://www.npmjs.com/package/swiftness-starknet-with-keccak-blake2s)
  - [swiftness-starknet-with-keccak-keccak](https://www.npmjs.com/package/swiftness-starknet-with-keccak-keccak)

### Other Platforms Support

- [x] Bare Armv7-R, Big Endian - `armebv7r-none-eabi`
- [x] Bare RISC-V (RV64IMAC ISA) - `riscv64imac-unknown-none-elf`
- [x] Bare ARM64, softfloat - `aarch64-unknown-none-softfloat`
- [x] Bare ARM64, hardfloat - `aarch64-unknown-none`

## Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve this project.