Skip to content

Commit 9374165

Browse files
authored
Merge pull request #35 from eigerco/doc/clean-up-leftovers
doc: clean up leftover patching sections
2 parents c36d69d + f2fd75f commit 9374165

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ See the [Introduction](https://eigerco.github.io/zair/introduction.html) for mor
1818

1919
## Crates
2020

21-
| Crate | Description |
22-
| --- | --- |
23-
| `zair-cli` | Primary `zair` CLI binary tool |
24-
| `zair-sdk` | The SDK and entrypoint for `zair` airdrops, used by the CLI |
25-
| `zair-core` | Core crate with shared types, config and schemas |
26-
| `zair-nonmembership` | Non-membership Merkle-tree primitive |
27-
| `zair-scan` | Lightwalletd gRPC client and chain scanning |
28-
| `zair-sapling-proofs` | Sapling proving and verification |
29-
| `zair-sapling-circuit` | Sapling claim circuit (Bellman/Groth16) |
30-
| `zair-orchard-proofs` | Orchard proving and verification |
31-
| `zair-orchard-circuit` | Orchard claim circuit (Halo2) |
21+
| Crate | Description |
22+
| ---------------------- | ----------------------------------------------------------- |
23+
| `zair-cli` | Primary `zair` CLI binary tool |
24+
| `zair-sdk` | The SDK and entrypoint for `zair` airdrops, used by the CLI |
25+
| `zair-core` | Core crate with shared types, config and schemas |
26+
| `zair-nonmembership` | Non-membership Merkle-tree primitive |
27+
| `zair-scan` | Lightwalletd gRPC client and chain scanning |
28+
| `zair-sapling-proofs` | Sapling proving and verification |
29+
| `zair-sapling-circuit` | Sapling claim circuit (Bellman/Groth16) |
30+
| `zair-orchard-proofs` | Orchard proving and verification |
31+
| `zair-orchard-circuit` | Orchard claim circuit (Halo2) |
3232

3333
## Getting started
3434

docs/src/airdrop-proofs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Outside the circuit:
2727

2828
Each pool has two crates and one or more patched upstream dependencies:
2929

30-
| | Sapling | Orchard |
31-
| ----------------- | ------------------------- | ------------------------------------------------ |
32-
| Circuit | `zair-sapling-circuit` | `zair-orchard-circuit` |
33-
| Prover / verifier | `zair-sapling-proofs` | `zair-orchard-proofs` |
34-
| Patched deps | `.patched-sapling-crypto` | `.patched-orchard`, `.patched-halo2-gadgets` |
30+
| | Sapling | Orchard |
31+
| ----------------- | ---------------------- | -------------------------- |
32+
| Circuit | `zair-sapling-circuit` | `zair-orchard-circuit` |
33+
| Prover / verifier | `zair-sapling-proofs` | `zair-orchard-proofs` |
34+
| Patched deps | `sapling-crypto` | `orchard`, `halo2-gadgets` |
3535

3636
The patches expose internal APIs (nullifier derivation with configurable domain, Pedersen/Sinsemilla
3737
hash internals, key types) so that host-side code can compute the same airdrop nullifiers and

docs/src/airdrop-proofs/orchard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Implementation:
99

1010
Patched dependencies:
1111

12-
- `.patched-orchard/` via `nix/airdrop-orchard-nullifier.patch`
13-
- `.patched-halo2-gadgets/` via `nix/airdrop-halo2-gadgets-sha256.patch`
12+
- `orchard/` from [https://github.com/eigerco/orchard](/url)
13+
- `halo2-gadgets/` from [https://github.com/eigerco/halo2](/url)
1414

1515
## Proof statement
1616

docs/src/airdrop-proofs/sapling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Implementation:
99

1010
Patched dependency:
1111

12-
- `.patched-sapling-crypto/` via `nix/airdrop-sapling-nullifier.patch`
12+
- `sapling-crypto/` from [https://github.com/eigerco/sapling-crypto](/url)
1313

1414
## Proof statement
1515

0 commit comments

Comments
 (0)