Skip to content

Commit

Permalink
docs: document anonymous user environment variable
Browse files Browse the repository at this point in the history
  • Loading branch information
Westlad committed Apr 11, 2023
1 parent cb99270 commit b8fce80
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/whitelist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nightfall Whitelisting adaptions

Nightfall now incorporates the ability to manage a whitelist of accounts. It is an abstract contract, intended to be subclassed by a form of Whitelist Manager contract (currentyl `X509.sol` performs this role). When whitelisting is enabled, only accounts that are added to the whitelist are able to move funds from Layer 1 to Layer 2 and to withdraw Layer 1 funds from the Shield contract.
Nightfall now incorporates the ability to manage a whitelist of accounts. It is an abstract contract, intended to be subclassed by a form of Whitelist Manager contract (currentyl `X509.sol` performs this role). When whitelisting is enabled, only accounts that are added to the whitelist are able to move funds from Layer 1 to Layer 2 and to withdraw Layer 1 funds from the Shield contract. Further, only whitelisted accounts may act as Proposers or Challengers.

## Enabling Whitelisting

Expand All @@ -9,3 +9,7 @@ To enable whitelisting, the deployer container should have its `WHITELISTING` en
## Operating Whitelisting

All whitelisting functionality is managed by the contract `Whitelist.sol`, the functions therein are self-explanatory.

## Identifying users to the Proposer

The Proposer may require that all users for whom it accepts transactions must be whitelisted. This is in fact the default unless the environment variable ANONYMOUS_USER is set in the Proposer container. Unless this variable is set, the Proposer will expect the user to sign the submitted off-chain transaction wirh their Ethereum signing key. The Proposer will do an ecrrecover on the signature and require that the recovered address is whitelisted before processing the transaction. The user's nf3 class will automatically sign offchain transactions unless the ANNONYMOUS_USER environment variable is set there.

0 comments on commit b8fce80

Please sign in to comment.