What is needed?

We should able to prepare campaigns without to publishing them and just unhidden them when they are released.
To achieve this would be necessary add to the model the boolean field to indicate if the campaign is public or not and be able to handle it from admin view.
The related campaign endpoints won´t show hidden campaigns.

What is needed?

Add admin views for:

• EthereumTx
• LockEvents
• UnlockEvents
• WithdrawnEvents

What is needed?

Add a reindex command to trigger reindexing from any block.

Index events and store them on database. Indexing should be run using a Celery async task:

    event Locked(address indexed holder, uint96 amount);
    event Unlocked(address indexed holder, uint32 indexed index, uint96 amount);
    event Withdrawn(address indexed holder, uint32 indexed index, uint96 amount);

Dependencies

• #2

Source

https://github.com/safe-global/safe-locking/blob/main/contracts/interfaces/ISafeTokenLock.sol

What is needed?

We would like to add new campaign fields to database model, and return them accordingly in the endpoint view.
New campaign fields:
rewardValue - number eg: 600,000
rewardText - string e.g. "Some text description of reward"
iconUrl - string
safeAppUrl - string
partnerUrl - string

iconUrl should return the stored icon link and the admin page must support upload an icon per campaign.
All the previous fields can be nullable

What is needed?

An endpoint to return a list of top holders and the position for one Safe.

GET /api/v1/leaderboard

Response:

[{
			"holder": "<HexString>",
			"position": "<int>",
			"lockedAmount": "<uint96>", // sum(lockEvents) - sum(unlockEvents)
			"unlockedAmount": "<uint96>", // sum(unlockEvents)
			"withdrawnAmount": "<uint96>", // sum(withdrawnEvents)
},...]

GET /api/v1/leaderboard/{holder_address}

Response:

{
			"holder": "<HexString>",
			"position": "<int>",
			"lockedAmount": "<uint96>", // sum(lockEvents) - sum(unlockEvents)
			"unlockedAmount": "<uint96>", // sum(unlockEvents)
			"withdrawnAmount": "<uint96>", // sum(withdrawnEvents)
}

What is needed?

Add an admin view to list and create ActivitiesMetadata.

The current version on staging return 500 error loading the swagger view.

What is needed?

Campaign leaderboard will change more or less in a weekly basis, that means have a cache of 1 minute is not the better solution.
We would like to add cache for 5 days and be able to invalidate this cache when the activitys campaign data is updated.

• withdrawn tests
• add more complex tests
• add wrong index events tests

Events

One table for every event type, all of of them with a ForeignKey to a EthereumTx table. Remember to store the logIndex

    event Locked(address indexed holder, uint96 amount);
    event Unlocked(address indexed holder, uint32 indexed index, uint96 amount);
    event Withdrawn(address indexed holder, uint32 indexed index, uint96 amount);

• No need for EthereumBlock table. It should be enough with only a EthereumTx table with:
  • tx_hash (primary key)
  • block_hash
  • block_number

Dependencies

• #1

Source

https://github.com/safe-global/safe-locking/blob/main/contracts/interfaces/ISafeTokenLock.sol

What is needed?

Create a view in the admin page with a formulary to upload the CSV file with the Activity results.
After the upload the file should be processed and stored in the database.

GET /api/v1/locked/{holder-address} → paginated list of locked events

Response:

[
    {
			"executionDate": "timestamp",
			"transactionHash": "StringHAsh",
			"holder": "ChecksumedAddress",
			"amount": "uint96",
			"logIndex": "int32",
		}...
]
			

Tasks:

• Add view
• Add happy path tests

What is needed?

Leaderboard endpoint is currently showing just locking information, we would like to include the boost calculation field is that endpoint.

The boost calculation is depending on how many tokens were locked/unlocked by holder and when.

More info https://5afe.slack.com/archives/C067TMF5FV1/p1714384815618279?thread_ts=1714376070.423099&cid=C067TMF5FV1

Describe the bug
We need to change the order of the results shown so that the newest events are shown first instead of the oldest ones:

{
    "count": 4,
    "next": "https://safe-locking-sepolia.staging.5afe.dev/api/v1/lock-events/0x0A64A32c010aa70fe79Ac32acAeFF0B3a7EE76b3/?limit=2&offset=2",
    "previous": null,
    "results": [
        {
            "executionDate": "2024-03-21T14:52:12Z",
            "transactionHash": "0xf68a7b792d5b6de473522435093a706606685035d7cc4941d3b58f0f0fa25116",
            "holder": "0x0A64A32c010aa70fe79Ac32acAeFF0B3a7EE76b3",
            "amount": "100000000000",
            "logIndex": "255"
        },
        {
            "executionDate": "2024-04-05T14:38:24Z",
            "transactionHash": "0x9d043871926caf2fe57192bdbc2d5490c0d57fd3f9e1996a72fe77e8e61829db",
            "holder": "0x0A64A32c010aa70fe79Ac32acAeFF0B3a7EE76b3",
            "amount": "200000000000000000000",
            "logIndex": "18"
        }
    ]
}

What is needed?

Get an early version deployed in staging to start the integration tests as soon as possible.

What is needed?

Add an endpoint to return a list of campaigns ordered by descending period start time.

GET /api/v1/campaigns/

GET /api/v1/unlocked/{holder-address} → paginated list of unlocked events

Response:

[
    {
			"executionDate": "timestamp",
			"transactionHash": "StringHAsh",
			"holder": "ChecksumedAddress",
			"amount": "uint96",
			"unlockIndex": "int32",
			"logIndex": "int32",
		}...
]

Tasks:

• Add view
• Add happy path tests

What is needed?

Create a admin user role without superuser permission that can do:

• Create/List/Update campaigns
• Create/List/Update periods
• Create/List/Update file per period.

What is needed?

An endpoint by campaign that returns a list with all the holders ordered by total gotten points for the provided campaign

GET /api/v2/leaderboard/campaign

Describe the bug
A warning message is logged when request about view because the serializer is not defined.

2024-04-03 14:50:35,360 [WARNING] [MainProcess] view's AboutView raised exception during schema generation; use `getattr(self, 'swagger_fake_view', False)` to detect and short-circuit this
Traceback (most recent call last):
  File "/usr/local/lib/python3.11/site-packages/drf_yasg/inspectors/base.py", line 42, in call_view_method
    return view_method()
           ^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/rest_framework/generics.py", line 108, in get_serializer
    serializer_class = self.get_serializer_class()
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/rest_framework/generics.py", line 122, in get_serializer_class
    assert self.serializer_class is not None, (
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 'AboutView' should either include a `serializer_class` attribute, or override the `get_serializer_class()` method.

What is needed?

• Move SQL queries to models.py
• holder shouldn't be a field of the LockingService class #41 (comment)

What is needed?

We would like to improve the performance of Campaign leaderboard database query creating a core materialized view.

Related issues

#100 (comment)

What is needed?

Add a GET endpoint for a campaign and address that return a list of period points.

GET /api/v1/campaign/{resourceID}/periods/{address}

Response

To Be Defined

What is needed?

The current implementation is sorting just by start_date

Implement paginated endpoint to return all-events:

[
                {
			"eventType": "LOCKED",
			"executionDate": "<timestamp>",
			"transactionHash": "<HexString>",
			"holder": "<HexString>",
			"amount": "<uint96>",
			"logIndex": "<int32>",
		},{
			"eventType": "UNLOCKED",
			"executionDate": "<timestamp>",
			"transactionHash": "<HexString>",
			"holder": "<HexString>",
			"amount": "<uint96>",
			"unlockIndex": "<int32>",
			"logIndex": "<int32>",
		},{
			"eventType": "WITHDRAWN",
			"executionDate": "<timestamp>",
			"transactionHash": "<HexString>",
			"holder": "<HexString>",
			"amount": "<uint96>",
			"unlockIndex": "<int32>",
			"logIndex": "<int32>",
		},
]

What is needed?

• Add serializer and view
• Add happy path tests

GET /api/v1/withdrawn/{holder-address} → paginated list of withdrawn events

Response:

[
    {
			"executionDate": "timestamp",
			"transactionHash": "StringHAsh",
			"holder": "ChecksumedAddress",
			"amount": "uint96",
			"unlockIndex": "int32",
			"logIndex": "int32",
		}...
]

Tasks:

• Add View
• Add happy path tests

What is needed?

A model that fits with the CSV activities file.
In this stage we will store all the necessary fields from the activity CSV file in a table.

What is needed?

Reorgs are going to happen and this service should be able to manage them.

Coverage we will disable at the beginning of the project because is private, this is a reminder to add it later.

• Initialize a basic project with Celery
  • Service can be setup using another service as template (like the price-service)
  • Or from scratch: https://github.com/cookiecutter/cookiecutter
• Setup dockerfile
• Setup pre-commit
• Setup CI
• Setup README