docs(faucet): add readme (#1534)

.changeset/twelve-monkeys-juggle.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/faucet": patch
+---
+
+Added README

packages/faucet/README.md

@@ -0,0 +1,30 @@
+# faucet
+
+A minimal Typescript faucet to drip native tokens on Ethereum chains
+
+## Usage
+
+Install and run with:
+
+```sh
+npm install @latticexyz/faucet@next
+npm faucet-server
+```
+
+or execute the package bin directly:
+
+```sh
+npx @latticexyz/faucet@next
+```
+
+## Configuration
+
+The faucet can configured with the following environment variables:
+
+| Variable             | Description                                           | Default   |
+| -------------------- | ----------------------------------------------------- | --------- |
+| `HOST`               | Host that the indexer server listens on               | `0.0.0.0` |
+| `PORT`               | Port that the indexer server listens on               | `3001`    |
+| `RPC_HTTP_URL`       | HTTP URL for Ethereum RPC                             |           |
+| `FAUCET_PRIVATE_KEY` | Private key of wallet to distribute faucet funds from |           |
+| `DRIP_AMOUNT_ETHER`  | Drip amount in ether                                  |

packages/faucet/bin/faucet-server.ts

@@ -3,12 +3,10 @@ import "dotenv/config";
 import { z } from "zod";
 import fastify from "fastify";
 import { fastifyTRPCPlugin } from "@trpc/server/adapters/fastify";
-import { ClientConfig, http, parseEther, isHex, createClient } from "viem";
+import { http, parseEther, isHex, createClient } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 import { AppRouter, createAppRouter } from "../src/createAppRouter";
-import { getChainId } from "viem/actions";
 
-// TODO: refine zod type to be either CHAIN_ID or RPC_HTTP_URL/RPC_WS_URL
 const env = z
   .object({
     HOST: z.string().default("0.0.0.0"),