Skip to content

feat(api-http): support filter to ignore tokens #1297

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
sebastijankuzner merged 2 commits into from
May 12, 2026
Merged

feat(api-http): support filter to ignore tokens #1297

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
2072ce5
add ?blacklist parameter to exclude tokens
oXtxNt9U May 12, 2026
b553e99
update tests
oXtxNt9U May 12, 2026
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
35 changes: 35 additions & 0 deletions packages/api-http/integration/routes/wallets.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,4 +526,39 @@ describe<{
assert.equal(data.data, result);
}
});

it("/wallets/tokens?blacklist=", async () => {
await apiContext.tokenRepository.save(tokens);
await apiContext.tokenHolderRepository.save(tokenHolders);
await apiContext.tokenWhitelistRepository.save(tokenWhitelist);

const testCases = [
{
// All
path: "/wallets/tokens?addresses=0x8233F6Df6449D7655f4643D2E752DC8D2283fAd5,0x432b093d9542B905C87587607491C369408475b4,0x3949B5aEb77059945e96c513F8F712450Ca89Eb7",
result: walletTokenHoldersResponse,
},
{
// Blacklist first token
path: `/wallets/tokens?blacklist=${tokens[0].address}&addresses=0x8233F6Df6449D7655f4643D2E752DC8D2283fAd5,0x432b093d9542B905C87587607491C369408475b4,0x3949B5aEb77059945e96c513F8F712450Ca89Eb7`,
result: [walletTokenHoldersResponse[1], walletTokenHoldersResponse[2]],
},
{
// Blacklist all
path: `/wallets/tokens?blacklist=${tokens.map((t) => t.address).join(",")}&addresses=0x8233F6Df6449D7655f4643D2E752DC8D2283fAd5,0x432b093d9542B905C87587607491C369408475b4,0x3949B5aEb77059945e96c513F8F712450Ca89Eb7`,
result: [],
},
{
// Blacklist takes precendence if whitelist overlaps
path: `/wallets/tokens?blacklist=${tokens.map((t) => t.address).join(",")}&whitelist=${tokens.map((t) => t.address).join(",")}&addresses=0x8233F6Df6449D7655f4643D2E752DC8D2283fAd5,0x432b093d9542B905C87587607491C369408475b4,0x3949B5aEb77059945e96c513F8F712450Ca89Eb7`,
result: [],
},
];

for (const { path, result } of testCases) {
const { statusCode, data } = await request(path, { ...options });
assert.equal(statusCode, 200);
assert.equal(data.data, result);
}
});
});
44 changes: 30 additions & 14 deletions packages/api-http/source/controllers/tokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,23 +259,39 @@ export class TokensController extends Controller {
return;
}

if (request.query.whitelist) {
const customWhitelist = (Array.isArray(request.query.whitelist)
? request.query.whitelist
: request.query.whitelist.split(",")) as unknown as string[];
if (customWhitelist.length > 0) {
queryBuilder.leftJoin(Models.TokenWhitelist, "tw", "tw.address = tok.address").andWhere(
new TypeOrm.Brackets((qb) => {
qb.where("tw.address IS NOT NULL").orWhere("tok.address IN (:...customWhitelist)", {
customWhitelist,
});
}),
);
return;
const toStringArray = (value: unknown): string[] => {
if (!value) {
return [];
}

return (Array.isArray(value) ? value : String(value).split(","))
.map((v) => String(v).trim())
.filter(Boolean);
};

const customWhitelist = toStringArray(request.query.whitelist);
const customBlacklist = toStringArray(request.query.blacklist);

if (customWhitelist.length === 0 && customBlacklist.length === 0) {
queryBuilder.innerJoin(Models.TokenWhitelist, "tw", "tw.address = tok.address");
return;
}

queryBuilder.innerJoin(Models.TokenWhitelist, "tw", "tw.address = tok.address");
if (customWhitelist.length > 0) {
queryBuilder.leftJoin(Models.TokenWhitelist, "tw", "tw.address = tok.address").andWhere(
new TypeOrm.Brackets((qb) => {
qb.where("tw.address IS NOT NULL").orWhere("tok.address IN (:...customWhitelist)", {
customWhitelist,
});
}),
);
}

if (customBlacklist.length > 0) {
queryBuilder.andWhere("tok.address NOT IN (:...customBlacklist)", {
customBlacklist,
});
}
}

public static andWhereNameSearch(
Expand Down
2 changes: 2 additions & 0 deletions packages/api-http/source/routes/tokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export const register = (server: Contracts.Api.ApiServer): void => {
validate: {
query: Joi.object({
addresses: Schemas.orEqualCriteria(walletAddressSchema),
blacklist: Schemas.orEqualCriteria(walletAddressSchema),
from: Schemas.orEqualCriteria(walletAddressSchema),
ignoreWhitelist: Joi.bool().default(false),
to: Schemas.orEqualCriteria(walletAddressSchema),
Expand All @@ -69,6 +70,7 @@ export const register = (server: Contracts.Api.ApiServer): void => {
validate: {
query: Joi.object({
addresses: Schemas.orEqualCriteria(walletAddressSchema),
blacklist: Schemas.orEqualCriteria(walletAddressSchema),
from: Schemas.orEqualCriteria(walletAddressSchema),
to: Schemas.orEqualCriteria(walletAddressSchema),
transactionHash: Schemas.orEqualCriteria(transactionHashSchema),
Expand Down
3 changes: 3 additions & 0 deletions packages/api-http/source/routes/wallets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export const register = (server: Contracts.Api.ApiServer): void => {
validate: {
query: Joi.object({
addresses: Schemas.orEqualCriteria(walletAddressSchema).required(),
blacklist: Schemas.orEqualCriteria(walletAddressSchema),
ignoreWhitelist: Joi.bool().default(false),
whitelist: Schemas.orEqualCriteria(walletAddressSchema),
}).concat(Schemas.pagination),
Expand Down Expand Up @@ -208,6 +209,7 @@ export const register = (server: Contracts.Api.ApiServer): void => {
validate: {
query: Joi.object({
addresses: Schemas.orEqualCriteria(walletAddressSchema),
blacklist: Schemas.orEqualCriteria(walletAddressSchema),
ignoreWhitelist: Joi.bool().default(false),
minBalance: Schemas.orNumericCriteria(tokenBalanceSchema),
name: Schemas.orEqualCriteria(tokenNameSchema),
Expand All @@ -232,6 +234,7 @@ export const register = (server: Contracts.Api.ApiServer): void => {
id: walletParameterSchema,
}),
query: Joi.object({
blacklist: Schemas.orEqualCriteria(walletAddressSchema),
ignoreWhitelist: Joi.bool().default(false),
minBalance: Schemas.orNumericCriteria(tokenBalanceSchema),
name: Schemas.orEqualCriteria(tokenNameSchema),
Expand Down
Loading