Skip to content

Commit

Permalink
Update README.md (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
nmohnblatt authored Nov 21, 2023
1 parent 722c598 commit 31aea3c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
# StarkNet signature
> Warning: this repo uses Cairo 0 and points to a deprecated verifier contract on the Starknet Goerli testnet.
## Arkworks and WASM meet StarkNet

This demo shows how you can use Rust and the <a href="https://github.com/arkworks-rs">arkworks ecosystem</a> to write webapps that perform cryptography compatible with <a href="https://starkware.co/starknet/">StarkNet</a>.

Following the steps on the [front end](https://geometryresearch.github.io/starknet-signatures/), you will be prompted to generate a key pair, sign a message and submit it to <a href="https://goerli.voyager.online/contract/0x026c8bc8bf071a54c4b0713ad52715fe92a471f85bf7f224322cbb0a29666ce1#transactions">our StarkNet contract</a> for verification. This final step requires an <a href="https://www.argent.xyz/argent-x/">Argent X wallet</a> (only compatible with Chrome and Firefox).

All the code performing cryptography was written in Rust using arkworks and <a href="https://github.com/geometryresearch/proof-toolbox/tree/main/starknet-curve">our implementation</a> of the <a href="https://starknet.io/docs/how_cairo_works/cairo_intro.html#field-elements">StarkNet finite field</a> and the <a href="https://docs.starkware.co/starkex-v4/crypto/stark-curve">STARK-friendly elliptic curve</a>. The code is then compiled to WebAssembly to be executed in browser.


## License

Expand All @@ -11,4 +21,4 @@ This project is licensed under either of

at your option.

The [SPDX](https://spdx.dev) license identifier for this project is `MIT OR Apache-2.0`.
The [SPDX](https://spdx.dev) license identifier for this project is `MIT OR Apache-2.0`.

0 comments on commit 31aea3c

Please sign in to comment.