New nadabot index

.gitignore

@@ -64,6 +64,7 @@ media/
 
 # Celery beat schedule file
 celerybeat-schedule
+dump.rdb
 
 # Flask stuff:
 instance/
@@ -99,7 +100,7 @@ poetry.lock
 # dotenv
 .env
 .env.*
-
+pyrightconfig.json
 # virtualenv
 .venv/
 venv/
@@ -133,4 +134,4 @@ dmypy.json
 
 # static
 
-/static/
+/static/

README.md

@@ -108,7 +108,7 @@ Possible Error Codes:
 
 #### Pagination
 
-Pagination available using `limit` and `offset` query params on endpoints that specify `paginated`. Default `limit` is 30.
+Pagination available using `limit` and `page` as query param on endpoints that specify `paginated`. Default `limit` is 30.
 
 Endpoints that support pagination will return a success response containing the following:
 
@@ -157,6 +157,7 @@ enum PotApplicationStatus {
 #### ✅ Get registrations for list: `GET /lists/{LIST_ID}/registrations` (paginated)
 
 Can specify status to filter by using `status` query param if desired, e.g. `status=Approved`
+Can also specify project category to filter by using `category` query param if desired, e.g. `category=Education`
 
 #### ✅ Get random registration for list: `GET /lists/{LIST_ID}/random_registration`
 

accounts/api.py

@@ -9,7 +9,7 @@
     OpenApiTypes,
     extend_schema,
 )
-from rest_framework.pagination import LimitOffsetPagination
+from rest_framework.pagination import PageNumberPagination
 from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.views import APIView
@@ -41,9 +41,10 @@
     AccountSerializer,
     PaginatedAccountsResponseSerializer,
 )
+from api.pagination import ResultPagination
 
 
-class DonorsAPI(APIView, LimitOffsetPagination):
+class DonorsAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         parameters=[
@@ -87,7 +88,7 @@ def get(self, request: Request, *args, **kwargs):
         return self.get_paginated_response(serializer.data)
 
 
-class AccountsListAPI(APIView, LimitOffsetPagination):
+class AccountsListAPI(APIView, ResultPagination):
 
     @extend_schema(
         responses={
@@ -152,7 +153,7 @@ def get(self, request: Request, *args, **kwargs):
         return Response(serializer.data)
 
 
-class AccountActivePotsAPI(APIView, LimitOffsetPagination):
+class AccountActivePotsAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         parameters=[
@@ -208,7 +209,7 @@ def get(self, request: Request, *args, **kwargs):
         return self.get_paginated_response(serializer.data)
 
 
-class AccountPotApplicationsAPI(APIView, LimitOffsetPagination):
+class AccountPotApplicationsAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         parameters=[
@@ -262,7 +263,7 @@ def get(self, request: Request, *args, **kwargs):
         return self.get_paginated_response(serializer.data)
 
 
-class AccountDonationsReceivedAPI(APIView, LimitOffsetPagination):
+class AccountDonationsReceivedAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         parameters=[
@@ -302,7 +303,7 @@ def get(self, request: Request, *args, **kwargs):
         return self.get_paginated_response(serializer.data)
 
 
-class AccountDonationsSentAPI(APIView, LimitOffsetPagination):
+class AccountDonationsSentAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         parameters=[
@@ -342,7 +343,7 @@ def get(self, request: Request, *args, **kwargs):
         return self.get_paginated_response(serializer.data)
 
 
-class AccountPayoutsReceivedAPI(APIView, LimitOffsetPagination):
+class AccountPayoutsReceivedAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         parameters=[
@@ -376,7 +377,7 @@ def get(self, request: Request, *args, **kwargs):
                 {"message": f"Account with ID {account_id} not found."}, status=404
             )
 
-        payouts = PotPayout.objects.filter(recipient=account)
+        payouts = PotPayout.objects.filter(recipient=account, paid_at__isnull=False)
         results = self.paginate_queryset(payouts, request, view=self)
         serializer = PotPayoutSerializer(results, many=True)
         return self.get_paginated_response(serializer.data)

accounts/migrations/0003_alter_account_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.6 on 2024-07-12 12:15
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("accounts", "0002_account_near_social_profile_data"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="account",
+            options={"ordering": ["id"]},
+        ),
+    ]

accounts/models.py

@@ -50,6 +50,9 @@ class Account(models.Model):
         help_text=_("NEAR social data contained under 'profile' key."),
     )
 
+    class Meta:
+        ordering = ["id"]
+
     async def fetch_near_social_profile_data_async(self):
         fetch_profile_data = sync_to_async(self.fetch_near_social_profile_data)
         await fetch_profile_data()

api/pagination.py

@@ -0,0 +1,6 @@
+from rest_framework.pagination import PageNumberPagination
+
+class ResultPagination(PageNumberPagination):
+    page_size = 30
+    page_size_query_param = 'limit'
+    max_page_size = 200

base/api.py

@@ -9,7 +9,7 @@
     extend_schema,
 )
 from rest_framework import serializers
-from rest_framework.pagination import LimitOffsetPagination
+from rest_framework.pagination import PageNumberPagination
 from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.views import APIView

base/serializers.py

@@ -1,7 +1,7 @@
 from rest_framework import serializers
 
 
-class TwoDecimalStringField(serializers.DecimalField):
+class ResultPagination(serializers.DecimalField):
     def to_representation(self, value):
         if value is None:
             return value

base/settings.py

@@ -59,6 +59,7 @@
 SENTRY_DSN = os.environ.get("PL_SENTRY_DSN")
 
 POTLOCK_TLA = "potlock.testnet" if ENVIRONMENT == "testnet" else "potlock.near"
+NADABOT_TLA = "nadabot.testnet" if ENVIRONMENT == "testnet" else "nadabot.near"
 
 NEAR_SOCIAL_CONTRACT_ADDRESS = (
     "v1.social08.testnet" if ENVIRONMENT == "testnet" else "social.near"
@@ -102,12 +103,13 @@
     "lists",
     "pots",
     "tokens",
+    "nadabot",
 ]
 
 DEFAULT_PAGE_SIZE = 30
 
 REST_FRAMEWORK = {
-    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
+    "DEFAULT_PAGINATION_CLASS": "api.pagination.ResultPagination",
     "PAGE_SIZE": DEFAULT_PAGE_SIZE,
     "DEFAULT_THROTTLE_CLASSES": [
         # "rest_framework.throttling.UserRateThrottle",
@@ -162,6 +164,11 @@
 CORS_ALLOWED_ORIGINS = [
     "http://localhost:3000",
     "https://alpha.potlock.io",
+    "https://alpha.potlock.org",
+    "https://alpha.potlock.xyz",
+    "https://alpha.potlock.app",  # regex matching might not be advisable.
+    "http://dev.local",
+    "https://dev.local",
 ]
 
 # REDIS / CACHE CONFIGS

donations/api.py

@@ -8,7 +8,7 @@
     OpenApiResponse,
     extend_schema,
 )
-from rest_framework.pagination import LimitOffsetPagination
+from rest_framework.pagination import PageNumberPagination
 from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.views import APIView
@@ -20,7 +20,7 @@
 DONATE_CONTRACT = "donate." + settings.POTLOCK_TLA
 
 
-class DonationContractConfigAPI(APIView, LimitOffsetPagination):
+class DonationContractConfigAPI(APIView, PageNumberPagination):
 
     @extend_schema(
         responses={