Skip to content

skip rate limit coupons #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rajranjan0608 merged 2 commits into from
May 16, 2025
Merged

skip rate limit coupons #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17785a6
skip rate-limiters based on coupon
rajranjan0608 May 16, 2025
9b5669f
remove unused chains
rajranjan0608 May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CouponService/couponService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ import { DynamoDBDocumentClient, UpdateCommand, ScanCommand } from "@aws-sdk/lib
import { Mutex, MutexInterface } from 'async-mutex'
import { CouponValidity } from "../types"

type Coupon = {
export type Coupon = {
id: string,
faucetConfigId: string,
maxLimitAmount: number,
consumedAmount: number,
expiry: number,
amountPerCoupon: number,
reset: boolean,
skipIpRateLimit?: boolean,
skipWalletRateLimit?: boolean,
}

type CouponConfig = {
Expand Down Expand Up @@ -169,4 +171,8 @@ export class CouponService {
release()
}
}

getCoupon(id: string): Coupon | undefined {
return this.coupons.get(id)
}
}
166 changes: 2 additions & 164 deletions config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"ID": "GLOBAL",
"RATELIMIT": {
"REVERSE_PROXIES": 2,
"MAX_LIMIT": 40,
"MAX_LIMIT": 200,
"WINDOW_SIZE": 1,
"PATH": "/",
"SKIP_FAILED_REQUESTS": false
Expand All @@ -28,7 +28,7 @@
"IMAGE": "https://glacier-api.avax.network/proxy/chain-assets/main/chains/43113/chain-logo.png",
"MAX_PRIORITY_FEE": "10000000000",
"MAX_FEE": "100000000000",
"DRIP_AMOUNT": 2,
"DRIP_AMOUNT": 0.01,
"DECIMALS": 18,
"RECALIBRATE": 30,
"COUPON_REQUIRED": true,
Expand All @@ -38,22 +38,6 @@
"WINDOW_SIZE": 1440
}
},
{
"ID": "WAGMI",
"NAME": "WAGMI Testnet",
"TOKEN": "WGM",
"RPC": "https://subnets.avax.network/wagmi/wagmi-chain-testnet/rpc",
"CHAINID": 11111,
"EXPLORER": "https://subnets.avax.network/wagmi/wagmi-chain-testnet/explorer",
"IMAGE": "https://glacier-api.avax.network/proxy/chain-assets/main/chains/11111/chain-logo.png",
"MAX_PRIORITY_FEE": "2000000000",
"MAX_FEE": "100000000000",
"DRIP_AMOUNT": 2,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "DFK",
"NAME": "DeFi Kingdoms Testnet",
Expand All @@ -70,22 +54,6 @@
"WINDOW_SIZE": 1440
}
},
{
"ID": "NMAC",
"NAME": "Rise of the Warbots Testnet",
"TOKEN": "NMAC",
"RPC": "https://testnet1.rotw.games",
"CHAINID": 7777,
"EXPLORER": "https://testnet.avascan.info/blockchain/nmac",
"IMAGE": "https://rotw.games/assets/icons/icon_nmac_fill.png",
"MAX_PRIORITY_FEE": "2000000000",
"MAX_FEE": "130000000000",
"DRIP_AMOUNT": 2,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "NUM",
"NAME": "Numbers Testnet",
Expand Down Expand Up @@ -151,57 +119,6 @@
"WINDOW_SIZE": 1440
}
},
{
"ID": "MASA",
"NAME": "Masa Testnet",
"TOKEN": "MASA",
"RPC": "https://subnets.avax.network/masatestne/testnet/rpc",
"CHAINID": 103454,
"EXPLORER": "https://subnets-test.avax.network/masatestnet",
"IMAGE": "https://safe.masa.finance/images/networks/masa.png",
"MAX_PRIORITY_FEE": "300000000000",
"MAX_FEE": "10000000000000",
"DRIP_AMOUNT": 2,
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "LT0",
"NAME": "LT0 Testnet",
"TOKEN": "LT",
"RPC": "https://subnets.avax.network/lt0/testnet/rpc",
"CHAINID": 31330,
"EXPLORER": "https://subnets-test.avax.network/lt0",
"IMAGE": "https://glacier-api.avax.network/proxy/chain-assets/main/chains/43113/chain-logo.png",
"MAX_PRIORITY_FEE": "3000000000",
"MAX_FEE": "100000000000",
"DRIP_AMOUNT": 4,
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 2,
"WINDOW_SIZE": 1440
}
},
{
"ID": "FERDYNET",
"NAME": "FerdyFlip Testnet",
"TOKEN": "FAVAX",
"RPC": "https://testnet-rpc.ferdyflip.xyz/rpc",
"CHAINID": 668577,
"EXPLORER": "https://devnet.routescan.io",
"IMAGE": "https://www.ferdyflip.xyz/images/heads.png",
"MAX_PRIORITY_FEE": "10000000000",
"MAX_FEE": "100000000000",
"DRIP_AMOUNT": 20,
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 2,
"WINDOW_SIZE": 1440
}
},
{
"ID": "MXSGAMES",
"NAME": "MXS Games Testnet",
Expand Down Expand Up @@ -269,56 +186,6 @@
"WINDOW_SIZE": 1440
}
},
{
"ID": "INTERSECT",
"NAME": "Intersect Testnet",
"TOKEN": "PEARL",
"RPC": "https://subnets.avax.network/pearl/testnet/rpc",
"CHAINID": 1612,
"EXPLORER": "https://subnets-test.avax.network/intersect",
"IMAGE": "https://raw.githubusercontent.com/UzairHannure/Subnet-Brand-Assets/main/ddd.webp",
"MAX_PRIORITY_FEE": "2000000000",
"MAX_FEE": "50000000000",
"DRIP_AMOUNT": 5,
"RATELIMIT": {
"MAX_LIMIT": 3,
"WINDOW_SIZE": 1440
}
},
{
"ID": "PTNEWLO",
"NAME": "PTNEWLO Testnet",
"TOKEN": "PTNL",
"RPC": "https://subnets.avax.network/ptnewlo/testnet/rpc",
"CHAINID": 57487,
"EXPLORER": "https://subnets-test.avax.network/ptnewlo",
"IMAGE": "https://images.ctfassets.net/gcj8jwzm6086/4wnyhip4JrhrRueC21kmUP/bfaa12a82cb2894f8316fba2827c9d58/AvaCloud_subnet_PTNEWLO.png",
"MAX_PRIORITY_FEE": "100000000000",
"MAX_FEE": "100000000000",
"DRIP_AMOUNT": 5,
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "CDEVNET",
"NAME": "Devnet (C-Chain)",
"TOKEN": "AVAX",
"RPC": "https://etna.avax-dev.network/ext/bc/C/rpc",
"CHAINID": 43117,
"EXPLORER": "https://feat-etna-devnet.subnets.pages.dev/devnet-c-chain",
"IMAGE": "https://glacier-api.avax.network/proxy/chain-assets/main/chains/43113/chain-logo.png",
"MAX_PRIORITY_FEE": "10000000000",
"MAX_FEE": "100000000000",
"DRIP_AMOUNT": 5,
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "ONIGIRI",
"NAME": "ONIGIRI Testnet",
Expand Down Expand Up @@ -475,35 +342,6 @@
"WINDOW_SIZE": 1440
}
},
{
"ID": "WAVAXWAGMI",
"HOSTID": "WAGMI",
"NAME": "Wrapped AVAX",
"TOKEN": "WAVAX",
"IMAGE": "https://glacier-api.avax.network/proxy/chain-assets/main/chains/43113/chain-logo.png",
"CONTRACTADDRESS": "0x21cf0eB2E3Ab483a67C900b27dA8F34185991982",
"DRIP_AMOUNT": 2000000000,
"GASLIMIT": "150000",
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "WWGM",
"HOSTID": "WAGMI",
"NAME": "Wrapped WAGMI",
"TOKEN": "WWGM",
"CONTRACTADDRESS": "0x3Ee7094DADda15810F191DD6AcF7E4FFa37571e4",
"DRIP_AMOUNT": 2,
"GASLIMIT": "150000",
"DECIMALS": 18,
"RATELIMIT": {
"MAX_LIMIT": 1,
"WINDOW_SIZE": 1440
}
},
{
"ID": "EUROEC",
"HOSTID": "C",
Expand Down
22 changes: 21 additions & 1 deletion middlewares/rateLimiter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
import rateLimit, { RateLimitRequestHandler } from 'express-rate-limit'
import { searchIP } from 'range_check'
import { RateLimiterConfig } from '../types'
import { CouponService } from '../CouponService/couponService'

export class RateLimiter {
PATH: string
type: 'ip' | 'wallet' | 'global'

constructor(app: any, configs: RateLimiterConfig[], keyGenerator?: any) {
constructor(
app: any,
configs: RateLimiterConfig[],
type: 'ip' | 'wallet' | 'global',
couponService: CouponService,
keyGenerator?: any,
) {
this.PATH = configs[0].RATELIMIT.PATH || '/api/sendToken'
this.type = type

let rateLimiters: any = new Map()
configs.forEach((config: any) => {
Expand All @@ -26,6 +35,17 @@ export class RateLimiter {
}

app.use(this.PATH, (req: any, res: any, next: any) => {
// skip rate limit based on coupon - coupon limit verification is done in the request handler
const couponId = req.body?.couponId
if (couponId) {
const coupon = couponService.getCoupon(couponId)
if (this.type === 'ip' && coupon && coupon.skipIpRateLimit) {
return next()
} else if (this.type === 'wallet' && coupon && coupon.skipWalletRateLimit) {
return next()
}
}

if(this.PATH == '/api/sendToken' && req.body.chain) {
return rateLimiters.get(req.body.erc20 ? req.body.erc20 : req.body.chain)(req, res, next)
} else {
Expand Down
21 changes: 15 additions & 6 deletions server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,28 +45,28 @@ if (NATIVE_CLIENT) {
app.use(express.static(path.join(__dirname, "client")))
}

new RateLimiter(app, [GLOBAL_RL])
const couponService = new CouponService(couponConfig)
const mainnetCheckService = new MainnetCheckService(MAINNET_BALANCE_CHECK_RPC)

new RateLimiter(app, [GLOBAL_RL], 'global', couponService)

new RateLimiter(app, [
...evmchains,
...erc20tokens
])
], 'ip', couponService)

// address rate limiter
new RateLimiter(app, [
...evmchains,
...erc20tokens
], (req: any, res: any) => {
], 'wallet', couponService, (req: any, res: any) => {
const addr = req.body?.address

if(typeof addr == "string" && addr) {
return addr.toUpperCase()
}
})

const couponService = new CouponService(couponConfig)
const mainnetCheckService = new MainnetCheckService(MAINNET_BALANCE_CHECK_RPC)

const captcha: VerifyCaptcha = new VerifyCaptcha(app, process.env.CAPTCHA_SECRET!, process.env.V2_CAPTCHA_SECRET!)

let evms = new Map<string, EVMInstanceAndConfig>()
Expand Down Expand Up @@ -165,6 +165,13 @@ router.post('/sendToken', captcha.middleware, async (req: any, res: any) => {
return
}

let skippedIpRateLimit, skippedWalletRateLimit;
if (coupon) {
const couponItem = couponService.getCoupon(coupon)
skippedIpRateLimit = couponItem?.skipIpRateLimit
skippedWalletRateLimit = couponItem?.skipWalletRateLimit
}

// logging requests (if enabled)
DEBUG && console.log(JSON.stringify({
date: new Date(),
Expand All @@ -176,6 +183,8 @@ router.post('/sendToken', captcha.middleware, async (req: any, res: any) => {
checkPassedType: pipelineValidity.checkPassedType,
dripAmount: pipelineValidity.dripAmount,
mainnetBalance: pipelineValidity.mainnetBalance,
skippedIpRateLimit,
skippedWalletRateLimit,
ip: req.headers["cf-connecting-ip"] || req.ip
}))

Expand Down