diff --git a/README.md b/README.md index db30d67..55aa559 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Cairo-VM Verifier -![Version](https://img.shields.io/badge/v0.1.1-green?style=flat-square&logo=git&logoColor=white&label=version) +![Version](https://img.shields.io/badge/v0.0.3-green?style=flat-square&logo=git&logoColor=white&label=version) ![Continuous Integration](https://img.shields.io/github/actions/workflow/status/iosis-tech/cairovm-verifier/ci.yml?style=flat-square&logo=githubactions&logoColor=white&label=Continuous%20Integration) This is the Rust implementation of the Cairo-VM STARK verifier with layouts. The code is inspired by StarkWare's [Cairo-verifier](https://github.com/starkware-libs/cairo-lang) implementation in Cairo0. @@ -32,9 +32,9 @@ cargo test - [x] starknet - [x] starknet_with_keccak -- **WASM Support:** - - [ ] Wasm bindings for integration with web applications - - [ ] Example Cairo-VM STARK verifier web client +- **Web Support:** + - [x] Wasm Support + - [x] NPM package ## Contributing diff --git a/wasm-binding/Cargo.toml b/wasm-binding/Cargo.toml index 0943433..ebe53aa 100644 --- a/wasm-binding/Cargo.toml +++ b/wasm-binding/Cargo.toml @@ -1,9 +1,9 @@ [package] name = "cairovm_verifier_wasm" -description.workspace = true +description = "CairoVM verifier - starknet_with_keccak & blake2s" edition.workspace = true homepage.workspace = true -license-file.workspace = true +license = "Apache-2.0" readme.workspace = true repository.workspace = true version.workspace = true @@ -23,7 +23,7 @@ crate-type = ["cdylib", "rlib"] getrandom = { version = "0.2.15", features = ["js"] } [features] -default = ["recursive", "keccak"] +default = ["starknet_with_keccak", "keccak"] dex = [] recursive = [] recursive_with_poseidon = [] diff --git a/wasm-binding/LICENSE b/wasm-binding/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/wasm-binding/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/wasm-binding/README.md b/wasm-binding/README.md index 2589cc8..5557fe6 100644 --- a/wasm-binding/README.md +++ b/wasm-binding/README.md @@ -1,6 +1,6 @@ -# Cairo-VM Verifier WASM +# Cairo-VM Verifier -![Version](https://img.shields.io/badge/v0.1.1-green?style=flat-square&logo=git&logoColor=white&label=version) +![Version](https://img.shields.io/badge/v0.0.3-green?style=flat-square&logo=git&logoColor=white&label=version) ![Continuous Integration](https://img.shields.io/github/actions/workflow/status/iosis-tech/cairovm-verifier/ci.yml?style=flat-square&logo=githubactions&logoColor=white&label=Continuous%20Integration) This is the Rust implementation of the Cairo-VM STARK verifier with layouts. The code is inspired by StarkWare's [Cairo-verifier](https://github.com/starkware-libs/cairo-lang) implementation in Cairo0. @@ -13,9 +13,5 @@ cargo install wasm-pack ### Build WASM: ```sh -wasm-pack build --workspace --features starknet_with_keccak,blake2s --no-default-features --target wasm32-unknown-unknown -``` - -## Contributing - -Feel free to open issues or submit pull requests to help improve this project. +wasm-pack build --target bundler --workspace --features starknet_with_keccak,blake2s --no-default-features +``` \ No newline at end of file diff --git a/wasm-binding/pkg/README.md b/wasm-binding/pkg/README.md new file mode 100644 index 0000000..f422517 --- /dev/null +++ b/wasm-binding/pkg/README.md @@ -0,0 +1,24 @@ +# Cairo-VM Verifier + +![Version](https://img.shields.io/badge/v0.0.3-green?style=flat-square&logo=git&logoColor=white&label=version) +![Continuous Integration](https://img.shields.io/github/actions/workflow/status/iosis-tech/cairovm-verifier/ci.yml?style=flat-square&logo=githubactions&logoColor=white&label=Continuous%20Integration) + +This is the Rust implementation of the Cairo-VM STARK verifier with layouts. The code is inspired by StarkWare's [Cairo-verifier](https://github.com/starkware-libs/cairo-lang) implementation in Cairo0. + +### Example usage +```js +import init, { cairovm_verify } from 'cairovm_verifier'; + +async function run(proof_json) { + await init(); // Initialize the Wasm module + try { + const [programHash, programOutput] = JSON.parse( await cairovm_verify(proof_json) ); + } catch (err) { + console.error(`Verification failed: ${err}`); + } +} +``` + +## Contributing + +Feel free to open issues or submit pull requests to help improve this project. diff --git a/wasm-binding/pkg/package.json b/wasm-binding/pkg/package.json new file mode 100644 index 0000000..3674ad6 --- /dev/null +++ b/wasm-binding/pkg/package.json @@ -0,0 +1,23 @@ +{ + "name": "cairovm_verifier", + "type": "module", + "keywords": ["stark", "wasm", "verifier", "cairovm"], + "description": "CairoVM verifier - starknet_with_keccak & blake2s", + "version": "0.0.3", + "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/iosis-tech/cairovm-verifier" + }, + "files": [ + "cairovm_verifier_wasm_bg.wasm", + "cairovm_verifier_wasm.js", + "cairovm_verifier_wasm.d.ts" + ], + "main": "cairovm_verifier_wasm.js", + "homepage": "", + "types": "cairovm_verifier_wasm.d.ts", + "sideEffects": [ + "./snippets/*" + ] +} \ No newline at end of file diff --git a/wasm-binding/src/lib.rs b/wasm-binding/src/lib.rs index 2ae058c..5fd8925 100644 --- a/wasm-binding/src/lib.rs +++ b/wasm-binding/src/lib.rs @@ -15,21 +15,21 @@ use cairovm_verifier_proof_parser::parse; use wasm_bindgen::prelude::*; #[wasm_bindgen] -pub fn wasm_verify(proof: JsValue) -> Result { +pub fn cairovm_verify(proof: JsValue) -> Result { // Deserialize input from JsValue to Rust types - let proof_str: String = proof.as_string().ok_or_else(|| JsValue::from_str("Invalid input"))?; + let proof_str: String = proof.as_string().ok_or_else(|| JsError::new("Invalid input"))?; // Parse the proof - let stark_proof = parse(proof_str).map_err(|e| JsValue::from_str(&e.to_string()))?; + let stark_proof = parse(proof_str).map_err(|e| JsError::new(&e.to_string()))?; // Get security bits and verify let security_bits = stark_proof.config.security_bits(); let (program_hash, output_hash) = stark_proof .verify::(security_bits) - .map_err(|e| JsValue::from_str(&e.to_string()))?; + .map_err(|e| JsError::new(&e.to_string()))?; // Serialize result to JsValue let result = serde_json::to_value((program_hash, output_hash)) - .map_err(|e| JsValue::from_str(&e.to_string()))?; + .map_err(|e| JsError::new(&e.to_string()))?; Ok(JsValue::from_str(&result.to_string())) } diff --git a/wasm-binding/web/index.html b/wasm-binding/web/index.html deleted file mode 100644 index a2ad953..0000000 --- a/wasm-binding/web/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - Test Rust WASM - - -

Rust Cairo VM Verifier in wasm

-

Layout: starknet_with_keccak

-

Commitment Hash: blake2s

-

Proof of Work Hash: blake2s

- - -
-

Program Hash:

-

Output Hash:

-

Verification Time:

-
- 

-    
-  
-
diff --git a/wasm-binding/web/main.js b/wasm-binding/web/main.js
deleted file mode 100644
index 0ccb29c..0000000
--- a/wasm-binding/web/main.js
+++ /dev/null
@@ -1,39 +0,0 @@
-import init, { wasm_verify } from '../pkg/wasm_binding.js';
-
-async function run() {
-    await init();  // Initialize the Wasm module
-
-    document.getElementById('verify-button').addEventListener('click', async () => {
-        const fileInput = document.getElementById('file-input');
-        const file = fileInput.files[0];
-
-        if (!file) {
-            alert('Please select a file.');
-            return;
-        }
-
-        const reader = new FileReader();
-        reader.onload = async function() {
-            const proof = reader.result;
-            try {
-                const startTime = Date.now(); // Start timing
-                const result = await wasm_verify(proof);
-                const endTime = Date.now(); // End timing
-                const elapsedTime = endTime - startTime; // Calculate elapsed time
-
-                const parsedResult = JSON.parse(result);
-                
-                // Display program_hash and output_hash
-                document.getElementById('program-hash').innerText = `Program Hash: ${parsedResult[0]}`;
-                document.getElementById('output-hash').innerText = `Output Hash: ${parsedResult[1]}`;
-                document.getElementById('verification-time').innerText = `Verification Time: ${elapsedTime} ms`;
-            } catch (err) {
-                console.error(err);
-                document.getElementById('output').innerText = `Verification failed: ${err}`;
-            }
-        };
-        reader.readAsText(file);
-    });
-}
-
-run();