Skip to content
You are reading Codefi Orchestrate development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Configure a faucet

Orchestrate allows you to configure a pre-funded account to be used as a faucet for your users accounts. For doing so you will need the account to be used as a faucet to be pre-funded and registered on the Key Vault.

Note

Check the Account Management section to know how to create or import an account.

Configure your faucet using the Chain Registry by sending a POST request to /faucets on your Chain Registry API. The following controllers are available for configuration to avoid malicious use of the service:

  • Blacklist: list of malicious accounts that won’t be allowed to use the Faucet service.
  • Cooldown: a period of time to wait before crediting an account for a consecutive time.
  • Max: a maximum balance of an account for it to be credited.

Note

Check the Chain Registry API documentation if you want to know more on faucet configuration.

ConsenSys has acquired Quorum from J.P. Morgan. Please read the FAQ.
Questions or feedback? You can obtain paid professional support by Consensys at orchestrate@consensys.net