Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oxheadalpha/tezos-faucet
Frontend for tezos-faucet project
https://github.com/oxheadalpha/tezos-faucet
blockchain dailynet faucet faucet-crypto ghostnet mondaynet tezos
Last synced: 4 days ago
JSON representation
Frontend for tezos-faucet project
- Host: GitHub
- URL: https://github.com/oxheadalpha/tezos-faucet
- Owner: oxheadalpha
- License: mit
- Created: 2022-07-15T15:14:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-09T20:51:02.000Z (11 months ago)
- Last Synced: 2024-09-15T22:08:42.633Z (about 2 months ago)
- Topics: blockchain, dailynet, faucet, faucet-crypto, ghostnet, mondaynet, tezos
- Language: TypeScript
- Homepage:
- Size: 1.02 MB
- Stars: 3
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Tezos Faucet Frontend
## Presentation
A one-click faucet for Tezos, now enhanced with a PoW (Proof of Work) challenge to ensure secure and fair Tez distribution.
### Made with
- Typescript
- Vite
- React
- Bootstrap
- Taquito
- Beacon Wallet
## Overview
The faucet's backend code can be located at [tezos-faucet-backend](https://github.com/oxheadalpha/tezos-faucet-backend). The backend handles the faucet's private key, CAPTCHA secret, PoW challenge creation and solution verification, and the amounts of Tez sent.
### Proof of Work (PoW) Challenge
To mitigate potential abuse and ensure a fair distribution of Tez, users are now required to solve computational challenges before receiving their Tez. This PoW mechanism discourages bots and other malicious actors from exploiting the faucet.
### Application Flow
1. **Initiating the Process**: Upon a Tez request, the frontend communicates with the `/challenge` endpoint of the backend, providing essential details such as the user's address and the amount of Tez requested.
2. **Receiving and Solving the Challenge**: The backend then sends a challenge. The difficulty and amount of challenges to be solved depends on factors such as if a CAPTCHA token was submitted and how much Tez was requested. The browser will create a webworker which will begin the process of finding a solution.
3. **Submitting and Verifying the Solution**: After solving, the frontend sends the solution to the `/verify` endpoint. The backend then checks its validity. Assuming it is valid, if more challenges are pending, the user proceeds to solve them. Once all challenges are cleared, Tez is sent to the user's account.
## Programmatic Faucet Usage
For programmatic usage of the faucet, we provide an npm package `@oxheadalpha/get-tez`. The code can be found [here](https://github.com/oxheadalpha/tezos-faucet/tree/main/getTez). Please refer to it for more details on how to use it. This script can be run from a JavaScript program or directly from a shell. It interacts with the backend to request Tez, solve the required challenges, and verify the solutions.
Please note that the programmatic faucet code does not use CAPTCHA and so more challenges can be given when using it.
## Setup
To setup the faucet for a new network:
1. Update Beacon Wallet lib to make sure it will handle the new network
2. Deploy a new instance of backend
3. Configure faucet to use backend
4. Deploy faucet
### 1. Update Beacon Wallet configuration for new network
Currently supported networks include:
- Mainnet
- Ghostnet
- Mondaynet
- Dailynet
- Nairobinet
- Oxfordnet
To add a new network, first check that `@airgap/beacon-sdk` handles it ([check their config on the latest release](https://github.com/airgap-it/beacon-sdk/blob/v4.0.6/packages/beacon-types/src/types/beacon/NetworkType.ts)), then update:
```
npm i @airgap/beacon-sdk
```
### 2. Deploy backend
See https://github.com/oxheadalpha/tezos-faucet-backend
### 3. Update configuration file: `config.json`
**Application configuration:**
- `name`: application name, displayed in header
- `googleCaptchaSiteKey`: Google ReCAPTCHA public site key
- `backendUrl`: Base URL of faucet backend to connect to.
- `githubRepo`: URL of Github repository (displayed in header with Github icon).
- `disableChallenges`: If PoW challenges need to be solved before receiving Tez. The backend must also disable challenges. Defaults to `false`.
- `minTez`: The minimum amount of Tez that can be requested.
- `maxTez`: The maximum amount of Tez that can be requested.
**Network configuration:**
- `name`: network name. Must match one of [@airgap/beacon-sdk NetworkType](https://github.com/airgap-it/beacon-sdk/blob/v4.0.6/packages/beacon-types/src/types/beacon/NetworkType.ts) value (case insensitive). Also used to be displayed.
- `rpcUrl`: Tezos network RPC endpoint to be used by faucet
- `faucetAddress`: public Tezos address of faucet
- `viewer`: URL of a block explorer that displays operation detail like `http://viewer-url.com/{tx_hash}` (eg. https://ghost.tzstats.com)
### 4. Deploy
Deploy with Docker using Dockerfile.
Build Docker image:
```
docker build . -t tezos-faucet
```
Run Docker image:
```
docker run -p 8080:8080 tezos-faucet
```