Add circuit download tool build note and update references (#23)

This commit is contained in:
Slava 2024-09-29 10:40:55 +03:00 committed by GitHub
parent 39d772176b
commit 7697d87724
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 1 deletions

View File

@ -146,6 +146,16 @@ make
The default `make` target creates the `build/codex` executable.
## Tools
### Circuit download tool
To build the circuit download tool located in `tools/cirdl` run:
```shell
make cirdl
```
## Example usage
See the instructions in the [Quick Start](/learn/quick-start).

View File

@ -311,7 +311,7 @@ That sub-command will make Codex to listen for a proof requests on the blockchai
Every [network](/networks/networks) uses its own generated set of the files which are stored in the [codex-contracts-eth](https://github.com/codex-storage/codex-contracts-eth/tree/master/verifier/networks) repository and also uploaded to the CDN. Hash of the files set is also known by the [marketplace smart contract](/learn/architecture#smart-contract).
To download circuit files and make them available to Codex app, we have a stand-alone utility - `cirdl`. It can be compiled from the sources (`make cirdl`) or downloaded from the [GitHub release page](https://github.com/codex-storage/nim-codex/releases).
To download circuit files and make them available to Codex app, we have a stand-alone utility - `cirdl`. It can be [compiled from the sources](/learn/build#circuit-download-tool) or downloaded from the [GitHub release page](https://github.com/codex-storage/nim-codex/releases).
> [!TIP]
> You would need to pass a bootstrap nodes, blockchain RPC endpoint and marketplace address based on the [network](/networks/networks) you would like to join.