From 44e91bba238b2841723cb703edddfe12225174ed Mon Sep 17 00:00:00 2001
From: zzzckck <152148891+zzzckck@users.noreply.github.com>
Date: Thu, 12 Sep 2024 15:10:37 +0800
Subject: [PATCH] faucet: support customized token (#2687)

---
 cmd/faucet/customized/README.md | 10 ++++++++++
 cmd/faucet/faucet.go            |  2 +-
 2 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 cmd/faucet/customized/README.md

diff --git a/cmd/faucet/customized/README.md b/cmd/faucet/customized/README.md
new file mode 100644
index 0000000000..e6f167c9b8
--- /dev/null
+++ b/cmd/faucet/customized/README.md
@@ -0,0 +1,10 @@
+# 1.Background
+This is to support some projects with customized tokens that they want to integrate into the BSC faucet tool.
+
+## 1.1. How to Integrate Your Token
+- Step 1: Fund the faucet address by sending a specific amount of your BEP-20 token to the faucet address (0xaa25aa7a19f9c426e07dee59b12f944f4d9f1dd3) on the BSC testnet.
+- Step 2: Update this README.md file and create a Pull Request on [bsc github](https://github.com/bnb-chain/bsc) with relevant information.
+
+We will review the request, and once it is approved, the faucet tool will start to support the customized token and list it on https://www.bnbchain.org/en/testnet-faucet.
+
+# 2.Token List
\ No newline at end of file
diff --git a/cmd/faucet/faucet.go b/cmd/faucet/faucet.go
index e83a32835a..918b60a586 100644
--- a/cmd/faucet/faucet.go
+++ b/cmd/faucet/faucet.go
@@ -500,7 +500,7 @@ func (f *faucet) apiHandler(w http.ResponseWriter, r *http.Request) {
 			continue
 		}
 
-		// check #2: check IP and ID(address) to ensure the user didn't request funds too recently,
+		// check #2: check IP and ID(address) to ensure the user didn't request funds too frequently
 		f.lock.Lock()
 
 		if ipTimeout := f.timeouts[ips[len(ips)-2]]; time.Now().Before(ipTimeout) {