Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: multiple typos of different importance #305

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

The mission of DelphiusLab is to provide Web2 developers with a concise toolset to leverage the power of Web3 in their applications. The ZKWASM (ZKSNARK virtual machine that supports Web Assembly) serves as a trustless layer between rich applications running on WASM runtime and smart contracts on chain.

WASM (or WebAssembly) is an open standard binary code format similar to assembly. Its initial objective was to provide an alternative to java-script with improved performance for the current web ecosystem. Benefiting from its platform independence, front-end flexibility (can be compiled from the majority of languages including C, C++, assembly script, rust, etc.), good isolated runtime and speed comes closer to the speed of a native binary, its usage is arising in distributed cloud and edge computing. Recently it has become a popular binary format for users to run customized functions on AWS Lambda, Open Yurt, AZURE, etc.
WASM (or WebAssembly) is an open standard binary code format similar to assembly. Its initial objective was to provide an alternative to java-script with improved performance for the current web ecosystem. Benefiting from its platform independence, front-end flexibility (can be compiled from the majority of languages including C, C++, assembly script, rust, etc.), good isolated runtime and speed comes closer to the speed of a native binary, its usage is rising in distributed cloud and edge computing. Recently it has become a popular binary format for users to run customized functions on AWS Lambda, Open Yurt, AZURE, etc.

The idea of ZKWASM is derived from ZKSNARK (Zero-Knowledge Succinct Non-Interactive Argument of Knowledge) which is a combination of SNARG (Succinct non-interactive arguments) and zero-knowledge proof. In general, the adoption of ZKSNARK usually requires implementing a program in arithmetic circuits or circuit-friendly languages (Pinocchio, TinyRAM, Buffet/Pequin, Geppetto, xJsnark framework, ZoKrates) that forms a barrier for existing programs to leverage its power. An alternative approach is, instead of applying ZKSNARK on the source code, applying it on the bytecode level of a virtual machine and implementing a zksnark-backed virtual machine. In this work, we take the approach of writing the whole WASM virtual machine in ZKSNARK circuits so that existing WASM applications can benefit from ZKSNARK by simply running on the ZKWASM, without any modification. Therefore, the cloud service provider can prove to any user that the computation result is computed honestly and no private information is leaked.

Expand Down Expand Up @@ -132,7 +132,7 @@ We use z3 (https://github.com/Z3Prover/z3) to check that all operations are comp

# Issue tracking:

- chore: non-feature requirements such as CI/CD, building script or work flow enhancement.
- chore: non-feature requirements such as CI/CD, building script or workflow enhancement.
- feat: feature need, we could use feat(circuit), feat(lang), feat(CLI) to categorize features
- bug: bug report, we also could use bug(circuit), bug(lang) to categorize bugs
- doc: documents related issues.
Expand All @@ -142,4 +142,4 @@ We use z3 (https://github.com/Z3Prover/z3) to check that all operations are comp
- C project: There is a project template for compiling C to wasm with limited host functions (foreign circuits). (see https://github.com/DelphinusLab/zkWasm-C)
- Rust project demo: https://github.com/xgaozoyoe/zkWasm-Rust-Demo
- Assembly script demo: https://github.com/DelphinusLab/zkWasm-AssemblyScript-Demo
- Browser based project: See https://github.com/zkcrossteam/g1024/ for how to utilize zkWASM in javascript, how to generate proofs using PAAS service and verify it on chain (contact xgao@zoyoe.com for details about PAAS testnet).
- Browser-based project: See https://github.com/zkcrossteam/g1024/ for how to utilize zkWASM in javascript, how to generate proofs using PAAS service and verify it on chain (contact xgao@zoyoe.com for details about PAAS testnet).
2 changes: 1 addition & 1 deletion crates/host/src/host/hash_helper/poseidon.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use zkwasm_host_circuits::host::ForeignInst::PoseidonFinalize;
use zkwasm_host_circuits::host::ForeignInst::PoseidonNew;
use zkwasm_host_circuits::host::ForeignInst::PoseidonPush;

/// Foreign functions that supports the following C code library
/// Foreign functions that support the following C code library
///
/// void poseidon(uint64_t* data, uint32_t size, uint64_t* r)
/// {
Expand Down
2 changes: 1 addition & 1 deletion crates/host/src/host/hash_helper/sha256.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use zkwasm_host_circuits::host::ForeignInst::SHA256Push;

use sha2::Sha256;

/// Foreign functions that supports the following C code library
/// Foreign functions that support the following C code library
///
/// void sha256(uint8_t* data, uint32_t size, uint64_t* r)
/// {
Expand Down
4 changes: 2 additions & 2 deletions crates/playground/c/phantom.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
#include "foreign.h"

/*
* An example of phantom function which will not generate any traces.
* An example of a phantom function that will not generate any traces.
*
* To make the phantom function works, you should make sure the function
* To make the phantom function work, you should make sure the function
* not to be inlined.
*
* Since the phantom function will not produce any traces, memory/global
Expand Down