[RELEASE] 0.6.0

.github/pull_request_template.md

@@ -2,17 +2,18 @@
 
 ## Definition of Done
 
-1. [ ] Acceptance criteria are met.
-2. [ ] PR is manually tested before the merge by developer(s).
+1. [ ] If required, the desciption of your change is added to the [QA changelog](https://www.notion.so/octantapp/Changelog-for-the-QA-d96fa3b411cf488bb1d8d9a598d88281) 
+2. [ ] Acceptance criteria are met.
+3. [ ] PR is manually tested before the merge by developer(s).
     - [ ] Happy path is manually checked.
-3. [ ] PR is manually tested by QA when their assistance is required (1).
+4. [ ] PR is manually tested by QA when their assistance is required (1).
     - [ ] Octant Areas & Test Cases are checked for impact and updated if required (2).
-4. [ ] Unit tests are added unless there is a reason to omit them.
-5. [ ] Automated tests are added when required.
-6. [ ] The code is merged.
-7. [ ] Tech documentation is added / updated, reviewed and approved (including mandatory approval by a code owner, should such exist for changed files).
+5. [ ] Unit tests are added unless there is a reason to omit them.
+6. [ ] Automated tests are added when required.
+7. [ ] The code is merged.
+8. [ ] Tech documentation is added / updated, reviewed and approved (including mandatory approval by a code owner, should such exist for changed files).
     - [ ] BE: Swagger documentation is updated.
-8. [ ] When required by QA:
+9. [ ] When required by QA:
     - [ ] Deployed to the relevant environment.
     - [ ] Passed system tests.
 

.github/workflows/deploy-pr.yml

@@ -41,6 +41,7 @@ jobs:
       anvil-block-time: 5
       decision-window: 1800
       epoch-duration: 3600
+      ipfs-gateways: 'https://ipfs.octant.wildland.dev/ipfs/'
     secrets: inherit
 
   run:

.github/workflows/e2e-run.yml

@@ -72,6 +72,7 @@ jobs:
       glm-claim-enabled: true
       vault-confirm-withdrawals-enabled: true
       anvil-block-time: 5
+      ipfs-gateways: 'https://ipfs.octant.wildland.dev/ipfs/'
     secrets: inherit
 
   run-e2e-tests:

.github/workflows/tpl-deploy-app.yml

@@ -118,6 +118,10 @@ on:
         required: false
         default: true
         type: boolean
+      ipfs-gateways:
+        required: false
+        default: 'https://turquoise-accused-gayal-88.mypinata.cloud/ipfs/,https://octant.infura-ipfs.io/ipfs/'
+        type: string
 
 env:
   ENV_TYPE: ${{ inputs.env-type }}
@@ -160,6 +164,7 @@ env:
   TESTNET_RPC_URL: "${{ secrets.TESTNET_RPC_URL }}"
   ETHERSCAN_API_KEY: "${{ secrets.ETHERSCAN_API_KEY }}"
   VITE_ALCHEMY_ID: "${{ secrets.VITE_ALCHEMY_ID }}"
+  IPFS_GATEWAYS: "${{ inputs.ipfs-gateways }}"
   MULTIDEPLOYER_ENABLED: ${{ inputs.multideployer-enabled }}
   SUBGRAPH_DEPLOY: ${{ inputs.subgraph-deploy }}
   GRAPH_HEALTCHECKER_ENABLED: ${{ inputs.graph-healtchecker-enabled }}

backend/README.md

@@ -64,7 +64,7 @@ yarn apitest:run # in a second console
 When backend code is changed, just re-run `yarn apitest:run`.
 To run just one test, use standard pytest naming:
 ```
-yarn apitest:run tests/legacy/test_api_snapshot.py::test_pending_snapshot
+yarn apitest:run tests/api-e2e/test_api_snapshot.py::test_pending_snapshot
 ```
 
 To stop the env, run `yarn apitest:down`

backend/app/engine/octant_rewards/leftover/__init__.py

@@ -18,3 +18,6 @@ class Leftover(ABC):
     @abstractmethod
     def calculate_leftover(self, payload: LeftoverPayload) -> int:
         pass
+
+    def extract_unused_matched_rewards(self, *args, **kwargs) -> int:
+        return 0

backend/app/engine/octant_rewards/leftover/with_ppf_and_unused.py

@@ -15,3 +15,14 @@ def calculate_leftover(self, payload: LeftoverPayload) -> int:
             - payload.total_withdrawals
             + unused_matched_rewards
         )
+
+    def extract_unused_matched_rewards(self, leftover, payload) -> int:
+        extra_individual_rewards = int(payload.ppf / 2)
+        return (
+            leftover
+            - payload.staking_proceeds
+            + payload.operational_cost
+            + payload.community_fund
+            + extra_individual_rewards
+            + payload.total_withdrawals
+        )

backend/app/engine/projects/rewards/__init__.py

@@ -1,6 +1,7 @@
 from abc import ABC, abstractmethod
+from collections import namedtuple
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import List, Optional, Dict
 
 from dataclass_wizard import JSONWizard
 
@@ -41,6 +42,11 @@ class ProjectRewardsResult:
     threshold: Optional[int] = None
 
 
+AllocationsBelowThreshold = namedtuple(
+    "AllocationsBelowThreshold", ["below_threshold", "total"]
+)
+
+
 @dataclass
 class ProjectRewards(ABC):
     projects_allocations: ProjectAllocations = field(init=False)
@@ -54,3 +60,12 @@ def calculate_project_rewards(
 
     def calculate_threshold(self, total_allocated: int, projects: List[str]) -> None:
         return None
+
+    def get_total_allocations_below_threshold(
+        self, allocations: Dict[str, List[AllocationItem]]
+    ) -> AllocationsBelowThreshold:
+        allocations_sum = sum(
+            sum(int(item.amount) for item in project_allocations)
+            for project_allocations in allocations.values()
+        )
+        return AllocationsBelowThreshold(0, allocations_sum)

backend/app/engine/projects/rewards/allocations/__init__.py

@@ -33,18 +33,24 @@ def _calc_allocations(
     ) -> Union[int, Decimal]:
         ...
 
-    def group_allocations_by_projects(
+    def segregate_allocations(
         self, payload: ProjectAllocationsPayload
-    ) -> (Dict[str, List], List[ProjectSumAllocationsDTO], Union[int, Decimal]):
-        result_allocations = []
+    ) -> Dict[str, List]:
         grouped_allocations = {
             key: list(group)
             for key, group in groupby(
                 sorted(payload.allocations, key=lambda a: a.project_address),
                 key=lambda a: a.project_address,
             )
         }
+        return grouped_allocations
+
+    def group_allocations_by_projects(
+        self, payload: ProjectAllocationsPayload
+    ) -> (Dict[str, List], List[ProjectSumAllocationsDTO], Union[int, Decimal]):
+        grouped_allocations = self.segregate_allocations(payload)
 
+        result_allocations = []
         total_plain_qf = 0
         for project_address, project_allocations in grouped_allocations.items():
             project_allocations = self._calc_allocations(project_allocations)

backend/app/engine/projects/rewards/preliminary.py

@@ -1,28 +1,30 @@
 from dataclasses import field, dataclass
 from decimal import Decimal
-from typing import List
+from typing import List, Dict
 
 from app.engine.projects.rewards import (
     ProjectRewardsPayload,
     ProjectRewardsResult,
     ProjectRewards,
     ProjectRewardDTO,
+    AllocationsBelowThreshold,
 )
 from app.engine.projects.rewards.allocations import (
     ProjectAllocations,
     ProjectAllocationsPayload,
+    AllocationItem,
 )
 from app.engine.projects.rewards.allocations.preliminary import (
     PreliminaryProjectAllocations,
 )
+from app.engine.projects.rewards.leverage.preliminary import PreliminaryLeverage
 from app.engine.projects.rewards.threshold import (
     ProjectThreshold,
     ProjectThresholdPayload,
 )
 from app.engine.projects.rewards.threshold.preliminary import (
     PreliminaryProjectThreshold,
 )
-from app.engine.projects.rewards.leverage.preliminary import PreliminaryLeverage
 
 
 @dataclass
@@ -42,6 +44,13 @@ def calculate_threshold(self, total_allocated: int, projects: List[str]) -> int:
             )
         )
 
+    def get_total_allocations_below_threshold(
+        self, allocations: Dict[str, List[AllocationItem]]
+    ) -> AllocationsBelowThreshold:
+        return self.projects_threshold.get_total_allocations_below_threshold(
+            allocations
+        )
+
     def calculate_project_rewards(
         self, payload: ProjectRewardsPayload
     ) -> ProjectRewardsResult:

backend/app/engine/projects/rewards/threshold/__init__.py

@@ -1,5 +1,9 @@
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
+from typing import List, Dict
+
+from app.engine.projects.rewards import AllocationsBelowThreshold
+from app.engine.projects.rewards import AllocationItem
 
 
 @dataclass
@@ -13,3 +17,9 @@ class ProjectThreshold(ABC):
     @abstractmethod
     def calculate_threshold(self, payload: ProjectThresholdPayload) -> int:
         pass
+
+    @abstractmethod
+    def get_total_allocations_below_threshold(
+        self, allocations: Dict[str, List[AllocationItem]]
+    ) -> AllocationsBelowThreshold:
+        pass

backend/app/engine/projects/rewards/threshold/preliminary.py

@@ -1,9 +1,12 @@
 from dataclasses import dataclass
+from typing import List, Dict
 
+from app.engine.projects.rewards import AllocationsBelowThreshold
 from app.engine.projects.rewards.threshold import (
     ProjectThreshold,
     ProjectThresholdPayload,
 )
+from app.engine.projects.rewards import AllocationItem
 
 
 @dataclass
@@ -19,3 +22,24 @@ def calculate_threshold(self, payload: ProjectThresholdPayload) -> int:
             if payload.projects_count
             else 0
         )
+
+    def get_total_allocations_below_threshold(
+        self, allocations: Dict[str, List[AllocationItem]]
+    ) -> AllocationsBelowThreshold:
+        summed_allocations = {
+            project: sum(map(lambda value: int(value.amount), values))
+            for project, values in allocations.items()
+        }
+        total_allocations = sum(summed_allocations.values())
+        no_projects = len(allocations.keys())
+
+        threshold = self.calculate_threshold(
+            ProjectThresholdPayload(total_allocations, no_projects)
+        )
+
+        allocations_below_threshold = 0
+        for allocations_sum_for_project in summed_allocations.values():
+            if allocations_sum_for_project < threshold:
+                allocations_below_threshold += allocations_sum_for_project
+
+        return AllocationsBelowThreshold(allocations_below_threshold, total_allocations)

backend/app/exceptions.py

@@ -346,3 +346,19 @@ class InvalidDelegationForLockingAddress(OctantException):
 
     def __init__(self):
         super().__init__(self.description, self.code)
+
+
+class InvalidAddressFormat(OctantException):
+    code = 400
+    description = "Invalid address format"
+
+    def __init__(self):
+        super().__init__(self.description, self.code)
+
+
+class InvalidProjectDetailsInput(OctantException):
+    code = 400
+    description = "Invalid input for projects details"
+
+    def __init__(self):
+        super().__init__(self.description, self.code)

backend/app/infrastructure/__init__.py

@@ -11,6 +11,8 @@
 from app.infrastructure.exception_handler import ExceptionHandler
 from flask import current_app as app
 
+from app.exceptions import InvalidAddressFormat
+
 default_decorators = {
     "delete": ExceptionHandler.print_stacktrace_on_exception(True, True),
     "get": ExceptionHandler.print_stacktrace_on_exception(False, True),
@@ -30,8 +32,12 @@ def _add_address_canonization(handler):
             def _decorated(*args, **kwargs):
                 field_value = kwargs.get(field_name)
                 if force or field_value is not None:
-                    updated_field = to_checksum_address(field_value)
-                    kwargs.update([(field_name, updated_field)])
+                    try:
+                        updated_field = to_checksum_address(field_value)
+                    except ValueError:
+                        raise InvalidAddressFormat()
+                    else:
+                        kwargs.update([(field_name, updated_field)])
 
                 return handler(*args, **kwargs)
 

backend/app/infrastructure/apscheduler.py

@@ -1,5 +1,6 @@
 from flask import current_app as app
 
+from app import exceptions
 from app.legacy.core import glm
 from app.legacy.core import vault
 from app.extensions import scheduler
@@ -16,7 +17,10 @@ def vault_confirm_withdrawals():
     with scheduler.app.app_context():
         if app.config["VAULT_CONFIRM_WITHDRAWALS_ENABLED"]:
             app.logger.debug("Confirming withdrawals in Vault contract...")
-            vault.confirm_withdrawals()
+            try:
+                vault.confirm_withdrawals()
+            except exceptions.MissingSnapshot:
+                app.logger.warning("No snapshot found")
 
 
 @scheduler.task(

backend/app/infrastructure/database/models.py

@@ -204,3 +204,19 @@ class UniquenessQuotient(BaseModel):
     @property
     def validated_score(self):
         return Decimal(self.score)
+
+
+class ProjectsDetails(BaseModel):
+    """
+    This model represents the details of a project that is consistent with data on the IPFS node.
+    Records here are created only by migrations.
+    """
+
+    __tablename__ = "project_details"
+
+    id = Column(db.Integer, primary_key=True)
+    address = Column(db.String(42), nullable=False)
+    name = Column(db.String, nullable=False)
+    epoch = Column(db.Integer, nullable=False)
+
+    __table_args__ = (UniqueConstraint("address", "epoch", name="uq_address_epoch"),)

backend/app/infrastructure/database/projects_details.py

@@ -0,0 +1,7 @@
+from typing import List
+
+from app.infrastructure.database.models import ProjectsDetails
+
+
+def get_projects_details_for_epoch(epoch: int) -> List[ProjectsDetails]:
+    return ProjectsDetails.query.filter_by(epoch=epoch).all()

backend/app/infrastructure/external_api/common.py

@@ -1,12 +1,13 @@
 import time
+from http import HTTPStatus
 from typing import Callable, Dict
 
 from app.exceptions import ExternalApiException
 
 
 def retry_request(
     req_func: Callable,
-    status_code: int,
+    status_code: HTTPStatus,
     no_retries: int = 3,
     sleep_time: int = 1,
     **kwargs,