From 743efea1c3e554b540359c385c87c5f6af33beee Mon Sep 17 00:00:00 2001 From: Federico Giacon <58218759+fedgiac@users.noreply.github.com> Date: Wed, 10 Jan 2024 19:01:29 +0100 Subject: [PATCH] Update readme with script details --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 303e2729..55238f3a 100644 --- a/README.md +++ b/README.md @@ -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=`. +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=`. 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: @@ -159,6 +162,16 @@ export PK= 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).