Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Arvolear committed Oct 8, 2024
1 parent 1f8345c commit ddf0f13
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,21 @@ npm run coverage

### Deployment

Prior deployment create the `.env` file following the example provided in `.env.example`. Also check out the required config in the `deploy/config/config.json` file.
Prior deployment create the `.env` file following the example provided in `.env.example`. Also check out the config files in the `deploy/config/` directory.

The config structure is the following:

```json
{
"signer": "0x0000000000000000000000000000000000000000",
"sourceStateContract": "0x0000000000000000000000000000000000000000",
"chainName": "CHAIN_NAME"
}
```ts
export const signer = "0x0000000000000000000000000000000000000000";
export const sourceStateContract = "0x0000000000000000000000000000000000000000";
export const chainName = "DEPLOYMENT_CHAIN_NAME";
```

Where `signer` is the address of Rarimo TSS signer, `sourceStateContract` is the address of WorldID manager contract to listed to, and `chainName` is the name of the network (e.g. Ethereum, Sepolia, Mumbai) where the contracts are being deployed to.

> [!NOTE]
> The appropriate config file gets chosen automatically upon the deployment network.
After the configuration is provided, execute:

```bash
Expand Down

0 comments on commit ddf0f13

Please sign in to comment.