Configure a faucet

You can configure a faucet to micro-credit accounts when they are created, and before transactions are signed. The faucet uses a pre-funded account that must be registered and stored in a key vault (for example, HashiCorp Vault).

Configure the faucet using the Chain Registry by sending a POST request to /faucets on the Chain Registry API.

{
  "amount": "10000000000000000",
  "chainRule": "438dfb9f-303-4f7a-9900-cc755d98463a",
  "cooldown": "30s",
  "creditorAccount": "0xf17f52151EbEF6C7334FAD080c5704D77216b732",
  "maxBalance": "1000000000000000000",
  "name": "chainFaucet"
}

{
  "uuid": "47afcb8c-e8bf-4275-a21d-ae29968e10d8",
  "name": "chainFaucet",
  "tenantID": "_",
  "createdAt": "2020-07-29T03:59:52.783253Z",
  "updatedAt": "2020-07-29T03:59:52.783253Z",
  "chainRule": "438dfb9f-303-4f7a-9900-cc755d98463a",
  "creditorAccountAddress": "0xf17f52151EbEF6C7334FAD080c5704D77216b732",
  "maxBalance": "1000000000000000000",
  "amount": "10000000000000000",
  "cooldown": "30s"
}

The following options are required when registering the faucet:

• amount - The amount to transfer to an account during creation, or requiring funds to cover the gas price of a transaction.
• chainRule - The uuid of the registered chain.
• cooldown - Time to wait (in seconds) before funding an account for a consecutive time.
• creditorAccount - The source account used to credit accounts requiring funds.
• maxBalance - The maximum balance allowed for accounts that require funding. Accounts with a balance equal to or greater than maxBalance will not be credited.
• name - The faucet name.