Skip to content
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.

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

Add pagination for holders collection #662

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions app/model/schema/token_holders.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ class TokenHoldersCollectionHolder(BaseModel):
class RetrieveTokenHoldersListResponse(BaseModel):
"""Retrieve Token Holders List schema (RESPONSE)"""

result_set: ResultSet
status: TokenHolderBatchStatus
holders: List[TokenHoldersCollectionHolder]
model_config = ConfigDict(
Expand Down
32 changes: 25 additions & 7 deletions app/routers/token_holders.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import pytz
from fastapi import APIRouter, Depends, Header, Path, Query
from fastapi.exceptions import HTTPException
from pydantic import NonNegativeInt
from sqlalchemy import and_, asc, desc, func, select

import config
Expand Down Expand Up @@ -460,6 +461,8 @@ async def retrieve_token_holders_collection(
description="UUID v4 required",
),
issuer_address: str = Header(...),
offset: Optional[NonNegativeInt] = Query(None),
limit: Optional[NonNegativeInt] = Query(None),
):
"""Retrieve token holders collection"""

Expand Down Expand Up @@ -507,18 +510,33 @@ async def retrieve_token_holders_collection(
)
raise InvalidParameterError(description)

# Base query
stmt = (
select(TokenHolder)
.where(TokenHolder.holder_list_id == _same_list_id_record.id)
.order_by(asc(TokenHolder.account_address))
)
total = await db.scalar(select(func.count()).select_from(stmt.subquery()))
count = total

# Pagination
if limit is not None:
stmt = stmt.limit(limit)
if offset is not None:
stmt = stmt.offset(offset)

# Get holder list
_token_holders: Sequence[TokenHolder] = (
await db.scalars(
select(TokenHolder)
.where(TokenHolder.holder_list_id == _same_list_id_record.id)
.order_by(asc(TokenHolder.account_address))
)
).all()
_token_holders: Sequence[TokenHolder] = (await db.scalars(stmt)).all()
token_holders = [_token_holder.json() for _token_holder in _token_holders]

return json_response(
{
"result_set": {
"count": count,
"offset": offset,
"limit": limit,
"total": total,
},
"status": _same_list_id_record.batch_status,
"holders": token_holders,
}
Expand Down
Loading
Loading