chore: rewrite report endpoint #8883
Conversation
| @@ -96,28 +96,6 @@ class Meta: | |||
|
|
|||
| fields = ('amount', 'asset', 'usd_value', 'timestamp', 'round') | |||
There was a problem hiding this comment.
Consider: Now that we're including all chains, would it make sense to include the chain that the asset is associated with in the output?
There was a problem hiding this comment.
This is for pubic consumption!
Do you see value adding it on? I figured we'd provide it if folks need it.
The data provided was what folks initially wanted so I haven't excluded / included anything new
app/grants/router.py
Outdated
| """Generate Grants report for an ethereum address""" | ||
| @ratelimit(key='ip', rate='5/s') | ||
| def contributions_rec_report(self, request): | ||
| """Genrate Grantee Report for an Grant""" |
There was a problem hiding this comment.
Consider: Would it be worth including details of the expected request format here?
There was a problem hiding this comment.
I can throw it in a readme file (basically the PR description) !
Would you rather we add it here. It might get a lil bloated though?
There was a problem hiding this comment.
We can assume (or can we?) that users who will be accessing our end-points will likely check the code, I think that it would be useful to include these details inline, and later we can look to create documentation from the code itself? If theres a better place we can leave these details though, we can explore that, but I still feel inline would be a safe approach?
app/grants/router.py
Outdated
| @action(detail=False) | ||
| @ratelimit(key='ip', rate='5/s') | ||
| def contributions_sent_report(self, request): | ||
| """Generate report for grant contributions made by an address""" |
There was a problem hiding this comment.
Consider: Same again here (detail what a request should look like)?
Description
This PR retries the report_real which takes a lot of resources and times out on heavy grants
Instead, Gitcoin will now offer 2 endpoints for public consumption
Note:
Get all grant contributions made by an address
Endpoint:
api/v0.1/grants/contributions_sent_report/?address=0x997D35b300bA1775fdB175dF045252e57D6EA5B0&format=jsonParameters:
address:Stringformat:jsonpage:numberfrom_timestamp:YYYY-MM-DDto_timestamp:YYYY-MM-DDsample response:
{ "metadata": { "from": "2021-04-11T06:22:23.082709", "to": "2021-05-11T06:22:23.082709", "count": 2, "current_page": "1", "num_pages": 1, "has_next": false }, "data": [ { "grant_name": "Gitcoin Grants Round 8 + Dev Fund", "asset": "ETH", "timestamp": "2020-08-14T22:13:01.132221Z", "grant_amount": "1000000000000000", "gitcoin_maintenance_amount": "0", "grant_usd_value": 0.43796, "gitcoin_usd_value": 0.0 }, { "grant_name": "Gitcoin Grants Round 8 + Dev Fund", "asset": "ETH", "timestamp": "2020-08-14T22:13:01.392117Z", "grant_amount": "0", "gitcoin_maintenance_amount": "0", "grant_usd_value": 0.0, "gitcoin_usd_value": 0.0 } ] }Get all grant contributions received by an grant
Endpoint:
api/v0.1/grants/contributions_rec_report/?id=23&format=jsonParameters:
id:number(grant id)format:jsonpage:numberfrom_timestamp:YYYY-MM-DDto_timestamp:YYYY-MM-DDsample response:
{ "transactions": [ { "asset": "DAI", "timestamp": "2021-04-05T18:09:13.664911Z", "amount": "2958149082487300", "clr_round": null, "usd_value": 0.0029581490824873 } ], "clr_payouts": [ { "amount": 530, "asset": "DAI", "usd_value": 530, "timestamp": "2019-06-04T16:06:59.354432Z", "round": 2 } ], "metadata": { "grant_name": "The Gitcoin Open Source Support Fund", "from_timestamp": "2021-04-11T06:17:15.472045", "to_timestamp": "2021-05-11T06:17:15.472045", "count": 1, "current_page": "1", "num_pages": 1, "has_next": false } }Fixes: #8868