Go to file
Jack Grigg 872471af17 Fix Poseidon instance definition
For Orchard, we want a Poseidon instance with a width of 3 field
elements and an output of one field element. The Poseidon instances
defined in the Poseidon paper have their output size equal to their
capacity size; with a capacity of 1 and pallas::Base as the field,
Poseidon-128 has the corresponding security level.

We do deviate from the paper's instance by adding a single partial
round, which makes the circuit easier to implement in Halo 2.
2021-03-18 16:39:09 +13:00
.github/workflows CI: Update benchmarks runner 2021-01-21 12:12:43 +00:00
book book: Update commitment tree section with the design decision 2021-02-12 01:47:04 +00:00
src Fix Poseidon instance definition 2021-03-18 16:39:09 +13:00
.gitignore Initial commit 2020-10-20 15:12:37 -06:00
CHANGELOG.md Initialize the changelog 2021-01-22 23:57:34 +00:00
COPYING Change to TGPPL 2020-10-20 15:13:21 -06:00
Cargo.toml Add test vectors from the reference implementation 2021-03-18 16:38:06 +13:00
LICENSE-TGPPL Change to TGPPL 2020-10-20 15:13:21 -06:00
README.md Rename to Orchard 2021-01-08 16:51:10 +00:00
katex-header.html Initial commit 2020-10-20 15:12:37 -06:00

README.md

orchard Crates.io

IMPORTANT: This library is being actively developed and should not be used in production software.

Documentation

License

Copyright 2020 The Electric Coin Company.

You may use this package under the Transitive Grace Period Public Licence, version 1.0, or at your option, any later version. See the file LICENSE-TGPPL for the terms of the Transitive Grace Period Public Licence, version 1.0.

The purpose of the TGPPL is to allow commercial improvements to the package while ensuring that all improvements are eventually open source. See here for why the TGPPL exists, graphically illustrated on three slides.