Feature: a single faucet

.github/workflows/docker.yml

@@ -21,26 +21,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Checking out the repo
-      - uses: actions/checkout@v3
-      # Setting up Go
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
         with:
-          go-version: "^1.20.x" # The Go version to download (if necessary) and use.
-      - run: go version
-
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_TOKEN }}
       # https://github.com/docker/setup-qemu-action
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
       # https://github.com/docker/setup-buildx-action
       - name: Set up Docker Buildx
         id: buildx
         uses: docker/setup-buildx-action@v2
-      - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
       # Generate correct tabs and labels
       - name: Docker metadata
         id: metadata
@@ -61,8 +60,7 @@ jobs:
           # https://github.com/docker/build-push-action/issues/820#issuecomment-1455687416
           provenance: false
           context: .
-          # It takes a long time to build the arm image right now, so we only build it on tags which is what we use for releases, or on merges to the default branch.
-          platforms: ${{ (contains(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/astria') && 'linux/amd64,linux/arm64' || 'linux/amd64' }}
+          platforms: 'linux/amd64,linux/arm64'
           push: true
           tags: ${{ steps.metadata.outputs.tags }}
           labels: ${{ steps.metadata.outputs.labels }}

.github/workflows/build.yml → .github/workflows/lint-test-format.yml

@@ -1,4 +1,4 @@
-name: Build
+name: Lint, Test, Format
 
 on:
   push:
@@ -7,21 +7,21 @@ on:
     branches: [astria]
 
 jobs:
-  build:
+  server-test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
-          go-version: 1.16
+          go-version: 1.21
 
       - name: Set up Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: "14"
+          node-version: "18"
 
       - name: Generate
         run: go generate -x
@@ -32,29 +32,29 @@ jobs:
       - name: Test
         run: go test -v ./...
 
-  golangci:
+  server-lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
         with:
-          go-version: 1.16
+          go-version: 1.21
 
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
           version: latest
 
-  prettier:
+  web-format:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v2
         with:
-          node-version: "14"
+          node-version: "18"
 
-      - run: yarn install
+      - run: npm install
         working-directory: web
 
-      - run: yarn prettier --check 'src/**/*.{css,html,js,svelte}'
+      - run: npm run prettier --check 'src/**/*.{css,html,js,svelte}'
         working-directory: web

.gitignore

@@ -21,3 +21,7 @@ password.txt
 
 # binary
 eth-faucet
+
+# envs
+.env
+.env.local

Dockerfile

@@ -1,14 +1,14 @@
-FROM node:lts-alpine as frontend
+FROM node:18-alpine as frontend
 
 WORKDIR /frontend-build
 
-COPY web/package.json web/yarn.lock ./
-RUN yarn install
+COPY web/package.json web/package-lock.json ./
+RUN npm install
 
 COPY web ./
-RUN yarn build
+RUN npm run build
 
-FROM golang:1.17-alpine as backend
+FROM golang:1.21-alpine as backend
 
 RUN apk add --no-cache gcc musl-dev linux-headers
 

README.md

@@ -19,70 +19,43 @@ The faucet is a web application with the goal of distributing small amounts of E
 
 ### Prerequisites
 
-* Go (1.16 or later)
-* Node.js
-* Yarn
+* Go (v1.21)
+* [golangci-lint](https://golangci-lint.run/usage/install/)
+* Node.js (v18)
+* NPM
+* [just](https://github.com/casey/just#installation)
+* [mprocs](https://github.com/pvolok/mprocs#installation)
+* [watchexec](https://github.com/watchexec/watchexec#install)
 
 ### Installation
 
 1. Clone the repository and navigate to the app’s directory
 ```bash
-git clone https://github.com/chainflag/eth-faucet.git
+git clone https://github.com/astriaorg/eth-faucet.git
 cd eth-faucet
 ```
 
-2. Bundle Frontend web with Vite
+2. Install front end app deps
 ```bash
-go generate
-```
-
-3. Build Go project 
-```bash
-go build -o eth-faucet
+just web-install-deps
 ```
 
 ## Usage
 
-**Use private key to fund users**
-
+Run front end dev server and Go binary together with `mprocs`
 ```bash
-./eth-faucet -httpport 8080 -wallet.provider http://localhost:8545 -wallet.privkey privkey
-```
-
-**Use keystore to fund users**
-
-```bash
-./eth-faucet -httpport 8080 -wallet.provider http://localhost:8545 -wallet.keyjson keystore -wallet.keypass password.txt
+just run-watch
 ```
 
 ### Configuration
 
-You can configure the funder by using environment variables instead of command-line flags as follows:
-```bash
-export WEB3_PROVIDER=https://some.rpc.endpoint
-export PRIVATE_KEY=0x...
-```
-
-or
-
-```bash
-export WEB3_PROVIDER=https://some.rpc.endpoint
-export KEYSTORE=path/to/keystore
-echo "your keystore password" > `pwd`/password.txt
-```
-
-Then run the faucet application without the wallet command-line flags:
-```bash
-./eth-faucet -httpport 8080
-```
-
 **Optional Flags**
 
 The following are the available command-line flags(excluding above wallet flags):
 
 | Flag            | Description                                      | Default Value  |
 |-----------------|--------------------------------------------------|----------------|
-| -httpport       | Listener port to serve HTTP connection           | 8080           |
+| -httpport       | Listener port to serve HTTP connection           | 8089           |
 | -proxycount     | Count of reverse proxies in front of the server  | 0              |
 | -queuecap       | Maximum transactions waiting to be sent          | 100            |
 | -faucet.amount  | Number of Ethers to transfer per user request    | 1              |
@@ -92,19 +65,10 @@ The following are the available command-line flags(excluding above wallet flags)
 ### Docker deployment
 
 ```bash
-docker run -d -p 8080:8080 -e WEB3_PROVIDER=https://some.rpc.endpoint -e PRIVATE_KEY=0x... chainflag/eth-faucet:1.1.0
-```
-
-or
-
-```bash
-docker run -d -p 8080:8080 -e WEB3_PROVIDER=https://some.rpc.endpoint -e KEYSTORE=path/to/keystore -v `pwd`/keystore:/app/keystore -v `pwd`/password.txt:/app/password.txt chainflag/eth-faucet:1.1.0
-```
-
-#### Build the Docker image
-
-```bash
-docker buildx build -t ghcr.io/astriaorg/astria-faucet:0.0.1-local .
+# might need to build image first
+just docker-build
+# run via Docker image
+just docker-run
 ```
 
 ## License