Skip to content

add optionally applied address whitelist #2

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

Open
RKlompUU wants to merge 5 commits into
base: main
Choose a base branch
from
Open

add optionally applied address whitelist #2

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f60dbe6
add optionally applied address whitelist
Dec 20, 2022
270bc99
bugfix
Dec 20, 2022
fac231d
update address whitelist table name
Dec 20, 2022
40972a4
expose whether whitelisted address has already claimed or not
Dec 20, 2022
82ddefd
add max claims number to whitelist
Dec 21, 2022
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
41 changes: 41 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ export class TokenGate {
urlFromReq: (req: Request) => string;
tzAddrFromReq: (req: Request) => string | undefined;

applyAddressWhitelist: boolean;
maxWhitelistedClaims: number;

constructor({ dbPool }: { dbPool: DbPool }) {
this.db = dbPool;

Expand All @@ -59,6 +62,9 @@ export class TokenGate {

this.urlFromReq = (req) => req.baseUrl;
this.tzAddrFromReq = (req: any) => req.auth?.userAddress;

this.applyAddressWhitelist = false;
this.maxWhitelistedClaims = 0;
}

loadSpecFromFile(filepath: string, overwrite: boolean = true): this {
Expand Down Expand Up @@ -172,6 +178,12 @@ export class TokenGate {
return this;
}

enableAddressWhitelist(maxClaims: number = 1): this {
this.applyAddressWhitelist = true;
this.maxWhitelistedClaims = maxClaims;
return this;
}

getSpec(): TokenGateSpec {
return Object.keys(this.rules).reduce((res, endpoint) => {
res[endpoint] = {
Expand All @@ -194,6 +206,7 @@ export class TokenGate {
use(req: Request, resp: Response, next: NextFunction): void {
const url = this.urlFromReq(req);
const tzAddr = this.tzAddrFromReq(req);

this.hasAccess(url, tzAddr)
.then((access) => {
if (!access) {
Expand All @@ -208,6 +221,28 @@ export class TokenGate {
});
}

async isAddressInWhitelist(
userAddress?: string
): Promise<"allowed" | "claimed" | "forbidden"> {
if (typeof userAddress === "undefined") {
return "forbidden";
}
const qryResp = await this.db.query(
`
SELECT claimed
FROM whitelisted_wallet_addresses
WHERE address = $1
`,
[userAddress]
);
if (qryResp.rowCount === 0) {
return "forbidden";
}
return Number(qryResp.rows[0].claimed) >= this.maxWhitelistedClaims
? "claimed"
: "allowed";
}

async hasAccess(
endpoint: Endpoint,
tzAddr: string | undefined
Expand All @@ -221,6 +256,12 @@ export class TokenGate {
if (typeof tzAddr === "undefined") {
return false;
}
if (
this.applyAddressWhitelist &&
(await this.isAddressInWhitelist(tzAddr)) !== "allowed"
) {
return false;
}
return await this.#ownsOneOf(tzAddr, rule.allowedTokens);
}

Expand Down