Dev

.github/workflows/deploy-dev.yml

@@ -0,0 +1,51 @@
+name: Dev deploy to EC2 on Push
+
+on:
+  push:
+    branches: [dev]
+
+env:
+  AWS_REGION: "us-east-1"
+
+# Permission can be added at job level or workflow level
+permissions:
+  id-token: write # This is required for requesting the JWT
+  contents: read # This is required for actions/checkout
+jobs:
+  DeployToCodeDeploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git clone the repository
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1.7.0
+        with:
+          role-to-assume: arn:aws:iam::471112976510:role/GitHubAction-AssumeRoleWithAction
+          role-session-name: GitHub_to_AWS_via_FederatedOIDC
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Generate appspec.yml for dev
+        run: cp appspec-dev.yml appspec.yml
+
+      - name: Set environment variables
+        id: vars
+        run: |
+          echo "DATETIME=$(date +'%Y-%m-%d_%H-%M-%S')" >> $GITHUB_ENV
+          echo "FILENAME=django-indexer-dev-${DATETIME}.zip" >> $GITHUB_ENV
+          echo "S3_BUCKET=django-indexer-dev" >> $GITHUB_ENV
+
+      - name: Create zip of repository
+        run: zip -r "${{ env.FILENAME }}" .
+
+      - name: Upload repository to S3
+        run: aws s3 cp "${{ env.FILENAME }}" "s3://${{ env.S3_BUCKET }}/"
+
+      - name: Create CodeDeploy Deployment
+        id: deploy
+        run: |
+          aws deploy create-deployment \
+            --application-name django-indexer \
+            --deployment-group-name django-indexer-dev-group \
+            --deployment-config-name CodeDeployDefault.AllAtOnce \
+            --s3-location bucket=${{ env.S3_BUCKET }},bundleType=zip,key=${{ env.FILENAME }}

.github/workflows/deploy-testnet.yml

@@ -0,0 +1,66 @@
+name: Testnet deploy to EC2 on Push
+
+on:
+  push:
+    branches: [testnet]
+
+env:
+  AWS_REGION: "us-east-1"
+
+# Permission can be added at job level or workflow level
+permissions:
+  id-token: write # This is required for requesting the JWT
+  contents: read # This is required for actions/checkout
+jobs:
+  DeployToCodeDeploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git clone the repository
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1.7.0
+        with:
+          role-to-assume: arn:aws:iam::471112976510:role/GitHubAction-AssumeRoleWithAction
+          role-session-name: GitHub_to_AWS_via_FederatedOIDC
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Generate appspec.yml for testnet
+        run: cp appspec-testnet.yml appspec.yml
+
+      - name: Set environment variables
+        id: vars
+        run: |
+          echo "DATETIME=$(date +'%Y-%m-%d_%H-%M-%S')" >> $GITHUB_ENV
+          echo "FILENAME=django-indexer-testnet-${DATETIME}.zip" >> $GITHUB_ENV
+          echo "S3_BUCKET=django-indexer-testnet" >> $GITHUB_ENV
+
+      - name: Create zip of repository
+        run: zip -r "${{ env.FILENAME }}" .
+
+      - name: Upload repository to S3
+        run: aws s3 cp "${{ env.FILENAME }}" "s3://${{ env.S3_BUCKET }}/"
+
+      - name: Create CodeDeploy Deployment
+        id: deploy
+        run: |
+          aws deploy create-deployment \
+            --application-name django-indexer-testnet \
+            --deployment-group-name django-indexer-testnet-group \
+            --deployment-config-name CodeDeployDefault.AllAtOnce \
+            --s3-location bucket=${{ env.S3_BUCKET }},bundleType=zip,key=${{ env.FILENAME }}
+
+      # - name: Create zip of repository
+      #   run: zip -r django-indexer-testnet.zip .
+
+      # - name: Upload repository to S3
+      #   run: aws s3 cp django-indexer-testnet.zip s3://django-indexer-testnet/
+
+      # - name: Create CodeDeploy Deployment
+      #   id: deploy
+      #   run: |
+      #     aws deploy create-deployment \
+      #     --application-name django-indexer-testnet \
+      #     --deployment-group-name django-indexer-testnet-group \
+      #     --deployment-config-name CodeDeployDefault.AllAtOnce \
+      #     --s3-location bucket=django-indexer-testnet,bundleType=zip,key=django-indexer-testnet.zip

README.md

@@ -3,10 +3,10 @@
   - [Steps to run:](#steps-to-run)
     - [Env vars example](#env-vars-example)
   - [API Basics](#api-basics)
-      - [Base URL](#base-url)
-      - [Authorization](#authorization)
-      - [Error Responses](#error-responses)
-      - [Pagination](#pagination)
+    - [Base URL](#base-url)
+    - [Authorization](#authorization)
+    - [Error Responses](#error-responses)
+    - [Pagination](#pagination)
   - [API Endpoints](#api-endpoints)
     - [`Account` endpoints](#account-endpoints)
       - [✅ Get all accounts: `GET /accounts` (paginated)](#-get-all-accounts-get-accounts-paginated)
@@ -52,6 +52,7 @@
   - If for some reason this doesn't kill any active celery tasks, run `ps auxww | grep 'celery' | grep -v grep` and kill resulting PIDs
 
 Extra commands that might come in useful:
+
 - Purge celery queue (`celery -A base purge`)
 
 ### Env vars example
@@ -77,13 +78,14 @@ export PL_SENTRY_DSN=
 
 #### Base URL
 
-`/api/v1/`
+**dev (mainnet):** `https://dev.potlock.io/api/v1/`
+**testnet:** `https://test-dev.potlock.io/api/v1/`
 
 #### Authorization
 
 This is a public, read-only API and as such does not currently implement authentication or authorization.
 
-Rate limits of (FILL THIS IN) are enforced to ensure service for all users.
+Rate limits of 100 requests/min are enforced to ensure service for all users.
 
 #### Error Responses
 

accounts/admin.py

@@ -1,25 +1,52 @@
 from django.contrib import admin
+
 from .models import Account
 
+
 @admin.register(Account)
 class AccountAdmin(admin.ModelAdmin):
-    list_display = ('id', 'total_donations_in_usd', 'total_donations_out_usd', 'total_matching_pool_allocations_usd', 'donors_count')
-    search_fields = ('id',)  # Allow searching by account address
-    list_filter = ('total_donations_in_usd', 'total_donations_out_usd')  # Filter by donation amounts
-    ordering = ('-total_donations_in_usd',)  # Default ordering
+    list_display = (
+        "id",
+        "total_donations_in_usd",
+        "total_donations_out_usd",
+        "total_matching_pool_allocations_usd",
+        "donors_count",
+    )
+    search_fields = ("id",)  # Allow searching by account address
+    list_filter = (
+        "total_donations_in_usd",
+        "total_donations_out_usd",
+    )  # Filter by donation amounts
+    ordering = ("-total_donations_in_usd",)  # Default ordering
 
     # Optionally, format decimal fields for better readability in the admin
     def total_donations_in_usd_display(self, obj):
         return "${:,.2f}".format(obj.total_donations_in_usd)
-    total_donations_in_usd_display.admin_order_field = 'total_donations_in_usd'
-    total_donations_in_usd_display.short_description = 'Total Donations Received (USD)'
+
+    total_donations_in_usd_display.admin_order_field = "total_donations_in_usd"
+    total_donations_in_usd_display.short_description = "Total Donations Received (USD)"
 
     def total_donations_out_usd_display(self, obj):
         return "${:,.2f}".format(obj.total_donations_out_usd)
-    total_donations_out_usd_display.admin_order_field = 'total_donations_out_usd'
-    total_donations_out_usd_display.short_description = 'Total Donations Sent (USD)'
+
+    total_donations_out_usd_display.admin_order_field = "total_donations_out_usd"
+    total_donations_out_usd_display.short_description = "Total Donations Sent (USD)"
 
     def total_matching_pool_allocations_usd_display(self, obj):
         return "${:,.2f}".format(obj.total_matching_pool_allocations_usd)
-    total_matching_pool_allocations_usd_display.admin_order_field = 'total_matching_pool_allocations_usd'
-    total_matching_pool_allocations_usd_display.short_description = 'Total Matching Pool Allocations (USD)'
+
+    total_matching_pool_allocations_usd_display.admin_order_field = (
+        "total_matching_pool_allocations_usd"
+    )
+    total_matching_pool_allocations_usd_display.short_description = (
+        "Total Matching Pool Allocations (USD)"
+    )
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_change_permission(self, request, obj=None):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False

activities/admin.py

@@ -1,30 +1,52 @@
 from django.contrib import admin
 from django.utils.html import format_html
-from .models import Activity, Account
+
+from .models import Account, Activity
+
 
 @admin.register(Activity)
 class ActivityAdmin(admin.ModelAdmin):
-    list_display = ('id', 'signer_address', 'receiver_address', 'timestamp', 'type', 'transaction_link', 'action_result')
-    list_filter = ('timestamp', 'type', 'signer', 'receiver')
-    search_fields = ('signer__id', 'receiver__id', 'tx_hash')
-    date_hierarchy = 'timestamp'
-    ordering = ('-timestamp',)
+    list_display = (
+        "id",
+        "signer_address",
+        "receiver_address",
+        "timestamp",
+        "type",
+        "transaction_link",
+        "action_result",
+    )
+    list_filter = ("timestamp", "type", "signer", "receiver")
+    search_fields = ("signer__id", "receiver__id", "tx_hash")
+    date_hierarchy = "timestamp"
+    ordering = ("-timestamp",)
 
     def signer_address(self, obj):
         return obj.signer.id
-    signer_address.admin_order_field = 'signer'
-    signer_address.short_description = 'Signer Address'
+
+    signer_address.admin_order_field = "signer"
+    signer_address.short_description = "Signer Address"
 
     def receiver_address(self, obj):
         return obj.receiver.id
-    receiver_address.admin_order_field = 'receiver'
-    receiver_address.short_description = 'Receiver Address'
+
+    receiver_address.admin_order_field = "receiver"
+    receiver_address.short_description = "Receiver Address"
 
     def transaction_link(self, obj):
         url = f"https://nearblocks.io?query={obj.tx_hash}"
         return format_html('<a href="{}" target="_blank">{}</a>', url, obj.tx_hash)
-    transaction_link.short_description = 'Transaction Hash'  # Sets the column header
+
+    transaction_link.short_description = "Transaction Hash"  # Sets the column header
 
     # def action_result_summary(self, obj):
     #     return "Has Result" if obj.action_result else "No Result"
     # action_result_summary.short_description = 'Action Result'
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_change_permission(self, request, obj=None):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False

activities/migrations/0002_alter_activity_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.4 on 2024-05-03 10:29
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("activities", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="activity",
+            options={"verbose_name_plural": "Activities"},
+        ),
+    ]

activities/migrations/0003_alter_activity_unique_together.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.4 on 2024-05-06 13:39
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("activities", "0002_alter_activity_options"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="activity",
+            unique_together={("action_result", "type")},
+        ),
+    ]

activities/models.py

@@ -66,3 +66,5 @@ class Activity(models.Model):
 
     class Meta:
         verbose_name_plural = "Activities"
+
+        unique_together = (("action_result", "type"),)

appspec-dev.yml

@@ -0,0 +1,19 @@
+version: 0.0
+os: linux
+files:
+  - source: /
+    destination: /home/ec2-user/django-indexer-dev
+hooks:
+  # BeforeInstall:
+  #   - location: scripts/clean_destination_dev.sh
+  #     timeout: 300
+  #     runas: ec2-user
+  AfterInstall:
+    - location: scripts/after_install_dev.sh
+      timeout: 300
+      runas: ec2-user
+#   ApplicationStart:
+#     - location: scripts/application_start.sh
+#       timeout: 300
+#       runas: root
+# # ValidateService:

appspec-testnet.yml

@@ -0,0 +1,20 @@
+version: 0.0
+os: linux
+files:
+  - source: /
+    destination: /home/ec2-user/django-indexer-testnet
+hooks:
+  # # Install:
+  # BeforeInstall:
+  #   - location: scripts/clean_destination_testnet.sh
+  #     timeout: 300
+  #     runas: ec2-user
+  AfterInstall:
+    - location: scripts/after_install_testnet.sh
+      timeout: 300
+      runas: ec2-user
+#   ApplicationStart:
+#     - location: scripts/application_start.sh
+#       timeout: 300
+#       runas: root
+# # ValidateService:

appspec.yml

@@ -0,0 +1,16 @@
+version: 0.0
+os: linux
+files:
+  - source: /
+    destination: /home/ec2-user/django-indexer
+hooks:
+  # # Install:
+  AfterInstall:
+    - location: scripts/after_install.sh
+      timeout: 300
+      runas: ec2-user
+#   ApplicationStart:
+#     - location: scripts/application_start.sh
+#       timeout: 300
+#       runas: root
+# # ValidateService: