Skip to content

Commit

Permalink
remove the recommnedation to use zk-contariners in examples (#569)
Browse files Browse the repository at this point in the history
  • Loading branch information
yshekel committed Aug 1, 2024
1 parent 0cb0b49 commit 6a67893
Show file tree
Hide file tree
Showing 8 changed files with 0 additions and 32 deletions.
4 changes: 0 additions & 4 deletions examples/c++/msm/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Icicle example: Muli-Scalar Multiplication (MSM)

## Best-Practices

We recommend to run our examples in [ZK-containers](../../ZK-containers.md) to save your time and mental energy.

## Key-Takeaway

`Icicle` provides CUDA C++ template function `MSM` to accelerate [Multi-Scalar Multiplication](https://github.com/ingonyama-zk/ingopedia/blob/master/src/msm.md).
Expand Down
4 changes: 0 additions & 4 deletions examples/c++/multiply/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Icicle example: Multiplication

## Best-Practices

We recommend to run our examples in [ZK-containers](../../ZK-containers.md) to save your time and mental energy.

## Key-Takeaway

`Icicle` accelerates multiplication operation `*` using [Karatsuba algorithm](https://en.wikipedia.org/wiki/Karatsuba_algorithm)
Expand Down
4 changes: 0 additions & 4 deletions examples/c++/ntt/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Icicle example: Number-Theoretical Transform (NTT)

## Best-Practices

We recommend to run our examples in [ZK-containers](../../ZK-containers.md) to save your time and mental energy.

## Key-Takeaway

`Icicle` provides CUDA C++ template function NTT for [Number Theoretical Transform](https://github.com/ingonyama-zk/ingopedia/blob/master/src/fft.md), also known as Discrete Fourier Transform.
Expand Down
4 changes: 0 additions & 4 deletions examples/c++/pedersen-commitment/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# ICICLE example: Pedersen Commitment

## Best-Practices

We recommend to run our examples in [ZK-containers](../../ZK-containers.md) to save your time and mental energy.

## Key-Takeaway

A Pedersen Commitment is a cryptographic primitive to commit to a value or a vector of values while keeping it hidden, yet enabling the committer to reveal the value later. It provides both hiding (the commitment does not reveal any information about the value) and binding properties (once a value is committed, it cannot be changed without detection).
Expand Down
4 changes: 0 additions & 4 deletions examples/c++/polynomial-api/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# ICICLE examples: computations with polynomials

## Best-Practices

We recommend to run our examples in [ZK-containers](../../ZK-containers.md) to save your time and mental energy.

## Key-Takeaway

Polynomials are crucial for Zero-Knowledge Proofs (ZKPs): they enable efficient representation and verification of computational statements, facilitate privacy-preserving protocols, and support complex mathematical operations essential for constructing and verifying proofs without revealing underlying data. Polynomial API is documented [here](https://dev.ingonyama.com/icicle/polynomials/overview)
Expand Down
4 changes: 0 additions & 4 deletions examples/c++/poseidon/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Icicle example: build a Merkle tree using Poseidon hash

## Best-Practices

We recommend to run our examples in [ZK-containers](../../ZK-containers.md) to save your time and mental energy.

## Key-Takeaway

`Icicle` provides CUDA C++ template `poseidon_hash` to accelerate the popular [Poseidon hash function](https://www.poseidon-hash.info/).
Expand Down
4 changes: 0 additions & 4 deletions examples/rust/msm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

`ICICLE` provides Rust bindings to CUDA-accelerated C++ implementation of [Multi-Scalar Multiplication](https://github.com/ingonyama-zk/ingopedia/blob/master/src/msm.md).

## Best Practices

In order to save time and setting up prerequisites manually, we recommend running this example in our [ZKContainer](../../ZKContainer.md).

## Usage

```rust
Expand Down
4 changes: 0 additions & 4 deletions examples/rust/ntt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@

`ICICLE` provides Rust bindings to CUDA-accelerated C++ implementation of [Number Theoretic Transform](https://github.com/ingonyama-zk/ingopedia/blob/master/src/fft.md).

## Best Practices

In order to save time and setting up prerequisites manually, we recommend running this example in our [ZKContainer](../../ZKContainer.md).

## Usage

```rust
Expand Down

0 comments on commit 6a67893

Please sign in to comment.