mosaicdao / faucet Goto Github PK

Faucet depends on libraries like Web3.
Faucet is currently licensed under MIT, which is most likely incompatible to Web3.

Check the licenses of the dependencies and select a valid license for Faucet.
Faucet should have the least restricted valid license possible.

Faucet type can be made an enum kind and switch case can be simplified by binding instantiation with the type of the enum instead of a string.

Below are some logs which might be the cause. (Implementer might need to dig deeper into the logs)

error: could not fill address {"service":"faucet","chain":"1406","error":"EnoughFundException: Beneficiary already has enough balance.","timestamp":"2019-07-24T07:38:04.668Z"}

(node:1134) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'split' of undefined at Server.<anonymous> (/home/centos/faucet/src/Server.ts:165:53) at Generator.next (<anonymous>) at fulfilled (/home/centos/faucet/src/Server.ts:4:58) at processTicksAndRejections (internal/process/task_queues.js:86:5) (node:1134) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)

using npm i @types/web3 we ran into some issues to import the web3

motication for this ticket: when funding multiple addresses in the tests, it is desirable for all funding transaction to get sent together, so that they can get mined together; reducing the overall wait time for the test to start.

This is a follow-up ticket to #12.

#12 already created all necessary keys, funded them, and started the faucet to run with the new chains
(@gulshanvasnani please confirm).

Tasks in this issue:

• Run the faucet in a way where it automatically restarts whenever the process crashes.
• Document privately for OST how to use the faucet (especially address and port).

Story

As a faucet
I want to respond to fill requests quicker
Because I don't want to block the connection for longer than necessary

Scenario

Given that a faucet is running
When it receives a request from a client
Then it returns the txHash as soon as possible
And closes the connection without waiting for a receipt from web3

Info

We can send the transaction with web3 and return the transaction hash to the client upon the transaction hash event from web3. We don't need to wait for the entire PromiEvent of the transaction to resolve.

Must be done in the implementations of the interface method Faucet::fill(). Maybe abstract it into something shared that is injected? Or maybe the EthNode?

User Story

As a faucet operator
I want to limit the amount of funds an account can request
Because I want to be more fair in funds distribution

Scenarios

Scenario 1 (in line with the current behavior)
Given that an account is not funded above the limit
When a fill request for that account is made
Then the account is funded the configured amount

Scenario 2
Given that an account is funded above the limit
When a fill request for that account is made
Then the account is not funded
And the server returns an understandable error to the client

Info

• We understand that this system is not safe from abuse. An attacker could create any number of accounts and fund them.
• Another approach to funding limitation would be a rate limit. However, a rate limit requires a much more sophisticated implementation. It is currently not worth the effort, but may be added at a later stage.
• The maximum funding should be set in the configuration of the faucet.
• The faucet should check the balance (on-chain with the node) before funding an account.

Update the eslint configuration to use 2 spaces for indentation.

After #18 was fixed and the linter was set up correctly, it revealed issues that cannot be auto-fixed.

• Fix all issues (with --fix and manually).
• Add linting to travis to enforce correct linting in the future.

As a developer
I want to see the status of a ticket inside the ticket
Because it wastes time going through all related PRs and possibly tickets.

Given that you worked on a ticket and assigned it to a PR
When the PR does not fully solve the ticket (no Fixes #111)
Then you should add a comment to the ticket about what's done and what is still open.

/cc @benjaminbollen

⚠️ You can ask @benjaminbollen if you require SSH access.

New Test Nets

1407 and 1406 are new testnet chains. We want to enable the faucet with base tokens for them so that we can use them.
That means they need to be funded with base tokens on the side chains.

• You need to create new keys for the new chains (see the README or ask @schemar).
• You need to ask Bala to fund the new accounts.
• You need to know which ports on the mosaic-chains machine forward to which chain node (ask @benjaminbollen or @schemar if you don't know how to find this out).

ℹ️ To get inspiration you can look at the existing configs for other chains.
ℹ️ If you forget the password we decided on for the accounts, please call @benjaminbollen or @schemar on zoom.

Ropsten

Make sure ropsten is still sufficiently funded as well.

Remove

Remove 200 and 1414 from the config and don't start them with the faucet.

• Add chain details for which faucet is hosted
• Add tokens supported by faucet

Currently to run faucets for multiple chains, multiple passwords are kept in a password file. The password file has no knowledge of chain account password belongs to.
This becomes problematic for devops for maintaining password files.

Proposal is to support environment variables in below format.

export ACCOUNT_PASSWORD_{chainid}={account_password}

Currently, faucet sends transactions without checking the balance for both coin and ERC20. This results in always failing transaction on low or zero balance.

The faucet should first check the balance and return a message to the client for a low balance.