aboutsummaryrefslogtreecommitdiffstats
path: root/packages/kovan-faucets
diff options
context:
space:
mode:
Diffstat (limited to 'packages/kovan-faucets')
-rw-r--r--packages/kovan-faucets/README.md9
-rw-r--r--packages/kovan-faucets/package.json82
-rw-r--r--packages/kovan-faucets/tsconfig.json25
-rw-r--r--packages/kovan-faucets/tslint.json4
4 files changed, 58 insertions, 62 deletions
diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md
index 111e88302..07bd23575 100644
--- a/packages/kovan-faucets/README.md
+++ b/packages/kovan-faucets/README.md
@@ -1,5 +1,4 @@
-@0xproject/kovan_faucets
-------
+## @0xproject/kovan_faucets
This faucet dispenses 0.1 test ether to one recipient per second and 0.1 test ZRX every 5 seconds. It has a max queue size of 1000.
@@ -16,11 +15,13 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
+
```bash
yarn install
```
@@ -47,11 +48,11 @@ yarn dev
### Endpoints
-```GET /ether/:recipient```
+`GET /ether/:recipient`
Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
-```GET /zrx/:recipient```
+`GET /zrx/:recipient`
Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
diff --git a/packages/kovan-faucets/package.json b/packages/kovan-faucets/package.json
index 85349dd3d..fe7cef5f2 100644
--- a/packages/kovan-faucets/package.json
+++ b/packages/kovan-faucets/package.json
@@ -1,43 +1,43 @@
{
- "private": true,
- "name": "@0xproject/kovan_faucets",
- "version": "1.0.2",
- "description": "A faucet micro-service that dispenses test ERC20 tokens or Ether",
- "main": "server.js",
- "scripts": {
- "build": "node ../../node_modules/gulp/bin/gulp.js build",
- "dev": "node ../../node_modules/gulp/bin/gulp.js run",
- "start": "node ./bin/server.js",
- "lint": "tslint --project . 'src/**/*.ts'",
- "clean": "shx rm -rf bin"
- },
- "author": "Fabio Berger",
- "license": "Apache-2.0",
- "dependencies": {
- "0x.js": "^0.29.0",
- "@0xproject/utils": "^0.1.2",
- "body-parser": "^1.17.1",
- "ethereumjs-tx": "^1.3.3",
- "express": "^4.15.2",
- "lodash": "^4.17.4",
- "rollbar": "^0.6.5",
- "web3": "^0.20.0",
- "web3-provider-engine": "^13.0.1"
- },
- "devDependencies": {
- "@0xproject/tslint-config": "^0.4.0",
- "@types/body-parser": "^1.16.1",
- "@types/express": "^4.0.35",
- "@types/lodash": "^4.14.86",
- "awesome-typescript-loader": "^3.1.3",
- "gulp": "^3.9.1",
- "nodemon": "^1.11.0",
- "shx": "^0.2.2",
- "source-map-loader": "^0.1.6",
- "tslint": "5.8.0",
- "typescript": "~2.6.1",
- "web3-typescript-typings": "^0.7.2",
- "webpack": "^3.1.0",
- "webpack-node-externals": "^1.6.0"
- }
+ "private": true,
+ "name": "@0xproject/kovan_faucets",
+ "version": "1.0.2",
+ "description": "A faucet micro-service that dispenses test ERC20 tokens or Ether",
+ "main": "server.js",
+ "scripts": {
+ "build": "node ../../node_modules/gulp/bin/gulp.js build",
+ "dev": "node ../../node_modules/gulp/bin/gulp.js run",
+ "start": "node ./bin/server.js",
+ "lint": "tslint --project . 'src/**/*.ts'",
+ "clean": "shx rm -rf bin"
+ },
+ "author": "Fabio Berger",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "0x.js": "^0.29.0",
+ "@0xproject/utils": "^0.1.2",
+ "body-parser": "^1.17.1",
+ "ethereumjs-tx": "^1.3.3",
+ "express": "^4.15.2",
+ "lodash": "^4.17.4",
+ "rollbar": "^0.6.5",
+ "web3": "^0.20.0",
+ "web3-provider-engine": "^13.0.1"
+ },
+ "devDependencies": {
+ "@0xproject/tslint-config": "^0.4.0",
+ "@types/body-parser": "^1.16.1",
+ "@types/express": "^4.0.35",
+ "@types/lodash": "^4.14.86",
+ "awesome-typescript-loader": "^3.1.3",
+ "gulp": "^3.9.1",
+ "nodemon": "^1.11.0",
+ "shx": "^0.2.2",
+ "source-map-loader": "^0.1.6",
+ "tslint": "5.8.0",
+ "typescript": "~2.6.1",
+ "web3-typescript-typings": "^0.7.2",
+ "webpack": "^3.1.0",
+ "webpack-node-externals": "^1.6.0"
+ }
}
diff --git a/packages/kovan-faucets/tsconfig.json b/packages/kovan-faucets/tsconfig.json
index 6b14a6f6b..7f0031ec6 100644
--- a/packages/kovan-faucets/tsconfig.json
+++ b/packages/kovan-faucets/tsconfig.json
@@ -1,16 +1,13 @@
{
- "compilerOptions": {
- "module": "commonjs",
- "target": "es5",
- "lib": [ "es2015", "dom" ],
- "outDir": "lib",
- "sourceMap": true,
- "declaration": true,
- "noImplicitAny": true,
- "experimentalDecorators": true,
- },
- "include": [
- "../../node_modules/web3-typescript-typings/index.d.ts",
- "./src/ts/**/*"
- ]
+ "compilerOptions": {
+ "module": "commonjs",
+ "target": "es5",
+ "lib": ["es2015", "dom"],
+ "outDir": "lib",
+ "sourceMap": true,
+ "declaration": true,
+ "noImplicitAny": true,
+ "experimentalDecorators": true
+ },
+ "include": ["../../node_modules/web3-typescript-typings/index.d.ts", "./src/ts/**/*"]
}
diff --git a/packages/kovan-faucets/tslint.json b/packages/kovan-faucets/tslint.json
index a07795151..ffaefe83a 100644
--- a/packages/kovan-faucets/tslint.json
+++ b/packages/kovan-faucets/tslint.json
@@ -1,5 +1,3 @@
{
- "extends": [
- "@0xproject/tslint-config"
- ]
+ "extends": ["@0xproject/tslint-config"]
}