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

Updated README.md to reflect recent changes in the config formats. #692

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
33 changes: 29 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,36 @@ you will have a generated keys file that is used by semaphore-mtb.
docker run --rm -ti -p 5432:5432 -e POSTGRES_PASSWORD=password postgres
```

Now you are ready to start up sequencer service!
### Relayer

```shell
TREE_DEPTH=*your tree depth (eg. 16)* cargo run -- --batch-size *batch size for semaphore-mtb (eg. 3)* --batch-timeout-seconds 10 --database postgres://postgres:[email protected]:5432 --identity-manager-address *address from worldcoin id contracts identity manager*
--signing-key *private key you used to deploy smart contracts*
You will also need a relayer (which is part of critical infrastructue and is not open sourced) - you can configure a sitter to be between [tx-sitter-monolith](https://github.com/worldcoin/tx-sitter-monolith) (if you run the tx-sitter and the signup-sequencer on the same machine then make sure that you launch databases on different ports).

### Configuration

The minimal TOML config for the sequencer can be found below (sitter at port 3000, sequencer at 3001). Use the identity manager address from your contract-deployer report.yml. [config.rs](src/config.rs) has an example of a full config file if you need to make changes.

```toml
[app]
provers_urls = "[]"

[tree]

[network]
identity_manager_address = "0x0000000000000000000000000000000000000000"

[providers]
primary_network_provider = "http://localhost:8545"

[relayer]
kind = "tx_sitter"
tx_sitter_url = "http://localhost:3000"
tx_sitter_address = "0x0000000000000000000000000000000000000000"

[database]
database = "postgres://user:password@localhost:5432/database"

[server]
address = "0.0.0.0:3001"
```

## Tests
Expand Down