Skip to content

Commit

Permalink
Update readme with script details (#71)
Browse files Browse the repository at this point in the history
Adds information on the readme about the available scripts.
This may be helpful when deploying to a new network.

### Test Plan

Try out the commands. `setManager` was previously tested
[here](dfea3b6).
  • Loading branch information
fedgiac authored Jan 12, 2024
1 parent aaffdc5 commit 4c264fe
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,14 @@ yarn solvers command [arg ...]
```

Here is a list of available commands.
The commands flagged with [*] require the private key of the authentication contract owner to be available to the script, for example by exporting it with `export PK=<private key>`.
The commands flagged with [**] require exporting the private key of the authentication contract owner, while those flagged with [*] require the address of either the owner or the manager.
The private key can be exported with `export PK=<private key>`.

1. `add $ADDRESS` [*]. Adds the address to the list of registered solvers.
2. `remove $ADDRESS` [*]. Removes the address from the list of registered solvers.
3. `check $ADDRESS`. Checks if the given address is in the list of registered solvers.
3. `list`. Lists all registered solvers.
3. `setManager $ADDRESS` [**]. Sets the manager of the authenticator to the input address.

For example, adding the address `0x0000000000000000000000000000000000000042` to the solver list:

Expand All @@ -159,6 +162,16 @@ export PK=<private key>
yarn solvers add 0x0000000000000000000000000000000000000042
```

### Transfer Ownership

There is a dedicated script to change the owner of the authenticator proxy.

Usage and parameters can be seen by running:

```sh
yarn hardhat transfer-ownership --help
```

### Fee Withdrawals

Script to withdraw all balances of the Settlement contract. Allows to specify what minimum value the contract must have for a token to be considered (breadcrumbs might not be worth the gas costs) and how much remaining value should be left in the contract (e.g. to feed token buffers).
Expand Down

0 comments on commit 4c264fe

Please sign in to comment.