Expose Grant information via API #6633

sebastiantf · 2020-05-12T11:39:02Z

Description

Adds a new endpoint: /api/v0.1/grants/report

URL Query parameters:

eth_address: Ethereum address
from_timestamp: Timestamp to filter contributions received by Grantee. Example: 2019-01-15T01:24:15Z
to_timestamp: Similar to from_timestamp

Example:

Request:

GET /api/v0.1/grants/report/?eth_address=0xCC4b3DE30576E161C8632786560Fa7DD3Fb33f77&from_timestamp=2020-05-01T01:24:15Z&to_timestamp=2020-05-30T01:24:15Z

Response:

{
    "grantee": [
        {
            "grant_name": "Another grant for me",
            "transactions": [
                {
                    "asset": "DAI",
                    "timestamp": "2020-05-06T05:24:42Z",
                    "amount": "47250000000000000000",
                    "clr_round": null,
                    "usd_value": 47.25
                }
            ],
            "clr_payouts": [
                {
                    "amount": 250.0,
                    "asset": "DAI",
                    "usd_value": 250.0,
                    "timestamp": "2020-05-15T06:12:16Z",
                    "round": 4
                },
                {
                    "amount": 400.0,
                    "asset": "DAI",
                    "usd_value": 400.0,
                    "timestamp": "2020-05-15T06:12:23Z",
                    "round": 5
                }
            ]
        }
    ],
    "donor": [
        {
            "grant_name": "Go Fund My Test Grant",
            "asset": "DAI",
            "timestamp": "2020-05-12T01:24:15Z",
            "grant_amount": "4750000000000000000",
            "gitcoin_maintenance_amount": "250000000000000000",
            "grant_usd_value": 4.75,
            "gitcoin_usd_value": 0.25
        }
    ]
}

Refers/Fixes

Fixes #6493

Testing

codecov · 2020-05-12T11:44:44Z

Codecov Report

Merging #6633 into master will decrease coverage by 0.51%.
The diff coverage is 42.25%.

@@            Coverage Diff             @@
##           master    #6633      +/-   ##
==========================================
- Coverage   27.22%   26.70%   -0.52%     
==========================================
  Files         288      294       +6     
  Lines       26865    28094    +1229     
  Branches     3965     4131     +166     
==========================================
+ Hits         7313     7503     +190     
- Misses      19280    20325    +1045     
+ Partials      272      266       -6

Impacted Files	Coverage Δ
app/grants/models.py	`48.99% <16.66%> (-0.27%)`	⬇️
app/grants/router.py	`33.33% <18.42%> (-23.34%)`	⬇️
app/grants/utils.py	`21.05% <23.52%> (+2.00%)`	⬆️
app/grants/serializers.py	`75.90% <68.75%> (-24.10%)`	⬇️
app/dashboard/sync/helpers.py	`27.27% <0.00%> (-39.40%)`	⬇️
app/townsquare/utils.py	`15.78% <0.00%> (-10.88%)`	⬇️
app/economy/models.py	`53.48% <0.00%> (-5.95%)`	⬇️
app/kudos/admin.py	`56.04% <0.00%> (-4.20%)`	⬇️
app/dashboard/utils.py	`41.32% <0.00%> (-2.86%)`	⬇️
app/dashboard/tasks.py	`36.48% <0.00%> (-2.41%)`	⬇️
... and 49 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab1cebf...7871c92. Read the comment docs.

Jack-Works · 2020-05-13T04:41:44Z

There're still some information missing in the API IMO 🤔

thelostone-mc · 2020-05-13T05:56:24Z

@LefterisJP + @owocki soft review needed !

@Jack-Works If you could list out what's missing / even better -> raise a PR against
@sebastiantf branch. It would be pretty dope ^_^

sebastiantf · 2020-05-13T06:07:48Z

@Jack-Works Have you checked out the endpoint at https://gitcoin.co/api/v0.1/grants/. It lists all the data related to all the grants and you could query a specific grant with it's pk.

Please do check that endpoint to see if it helps and feel free to specifically mention any other data that you think you need and the structure of the response as done in the original comment for this issue #6493

Also feel free to join the discussion at the issue page #6493

Jack-Works · 2020-05-13T06:19:07Z

Oh @sebastiantf yes it cover most of our cases (#6493 (comment) )

octavioamu · 2020-05-13T14:31:01Z

left a comment #6650 (comment)

sebastiantf · 2020-05-13T14:45:09Z

@octavioamu How do you mean to extend grants.json?

owocki · 2020-05-13T21:45:36Z

https://gitcoin.co/grants/grants.json

…

On Wed, May 13, 2020 at 8:45 AM Sebastian T F ***@***.***> wrote: @octavioamu <https://github.com/octavioamu> How do you mean to extend grants.json? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6633 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAD5PCMPIIQ7AIY7QAMTRILRRKXANANCNFSM4M6X4O5A> .

-- @owocki <http://www.twitter.com/owocki>

_________________________________________ gitcoin is live and has generated over $4.6mm for Open Source Software - see our results <https://gitcoin.co/results>

sebastiantf · 2020-05-14T15:43:33Z

https://gitcoin.co/grants/grants.json

I am aware of that endpoint. But it only contains the admin address for each grant, right? Wouldn't a better REST API endpoint be better?

Jack-Works · 2020-05-19T14:16:40Z

https://gitcoin.co/api/v0.1/grants/report/?eth_address=0xCC4b3DE30576E161C8632786560Fa7DD3Fb33f77&from_timestamp=2020-05-01T01:24:15Z&to_timestamp=2020-05-30T01:24:15Z

It's 404 🤔

sebastiantf · 2020-05-19T14:24:25Z

@Jack-Works This hasn't been merged yet. So it's not live yet.

Tedko · 2020-06-01T06:01:22Z

@Jack-Works This hasn't been merged yet. So it's not live yet.

Any idea or roadmap of merging this? We’re trying to integrate this into Maskbook to maximize the UX and make more people to donate easily

owocki · 2020-06-01T12:43:31Z

hey @gitcoinco/engineers i've got a request from an external collaborator to get this in to be live before round 6. to get ahead of that could we get it in review? given that its greenfield functionality, im hopeful that its not too much chance of regression.

We’re trying to finish the integrate and publish it to chrome store soon. Sometimes chrome store etc will spend several days to review. Try to catch up to the next grant on Jun/15 so we can bring more people on board to donate to grants

From Suji on telegram.. ^^

danlipert

Really nice and clean!

PixelantDesign

defer to engineering on this one!

sebastiantf · 2020-06-05T15:22:29Z

Thanks for the merge!

Jack-Works · 2020-06-08T09:10:54Z

does this API live now 👀
https://gitcoin.co/api/v0.1/grants/report/?eth_address=0xCC4b3DE30576E161C8632786560Fa7DD3Fb33f77&from_timestamp=2020-05-01T01:24:15Z&to_timestamp=2020-05-30T01:24:15Z

still 404

owocki · 2020-06-08T15:07:00Z

try now, the API is live

Jack-Works · 2020-06-08T15:14:58Z

Thanks

Jack-Works · 2020-06-09T08:55:40Z

I tried to query the result for LikeCoin and can't construct a usable URL.

https://gitcoin.co/api/v0.1/grants/report/?eth_address=0xC0eBeFadCbF1d2A85fBfDDC226a95860F5152b5f&from_timestamp=2020-05-01T01:24:15Z&to_timestamp=2020-06-09T01:24:15Z

Returns nothing

https://gitcoin.co/api/v0.1/grants/report/?eth_address=0xC0eBeFadCbF1d2A85fBfDDC226a95860F5152b5f&from_timestamp=2019-05-01T01:24:15Z&to_timestamp=2020-06-09T01:24:15Z

Error 502

owocki · 2020-06-09T14:39:44Z

@sebastiantf did you performance test your PR? looks like the second issue is timing out.

sebastiantf · 2020-06-11T08:02:21Z

@owocki @Jack-Works It seems the current output from the /grants/report/ endpoint contains duplicate entries, which is supposedly causing a performance issue at the endpoint, ultimately leading to a 502

https://gitcoin.co/api/v0.1/grants/report/?eth_address=0x89d1FeC16BA1c8aEbC7866263eb4Ca2D8bD8EeC4

The above request returns fine without a 502, but duplicate entries can be found.

I have a PR up at #6830 that should fix this.

Tedko · 2020-06-11T12:39:01Z

👍👍

…

On Thu, Jun 11, 2020 at 16:02 Sebastian T F ***@***.***> wrote: @owocki <https://github.com/owocki> @Jack-Works <https://github.com/Jack-Works> It seems the current output from the /grants/report/ endpoint contains duplicate entries, which is supposedly causing a performance issue at the endpoint, ultimately leading to a 502 https://gitcoin.co/api/v0.1/grants/report/?eth_address=0x89d1FeC16BA1c8aEbC7866263eb4Ca2D8bD8EeC4 The above request returns fine without a 502, but duplicate entries can be found. I have a PR up at #6830 <#6830> that should fix this. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#6633 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABTAVTP6UFPJSMJ52J5WASDRWCFRZANCNFSM4M6X4O5A> .

yisiliu · 2020-06-22T04:41:39Z

https://gitcoin.co/api/v0.1/grants/report/?eth_address=0x89d1FeC16BA1c8aEbC7866263eb4Ca2D8bD8EeC4

The above request returns fine without a 502, but duplicate entries can be found.

I have a PR up at #6830 that should fix this.

It's still returning 502. Can you take a look why?

sebastiantf · 2020-06-22T06:09:13Z

@yisiliu #6830 isn't merged yet

yisiliu · 2020-06-22T06:14:31Z

https://gitcoin.co/api/v0.1/grants/report/?eth_address=0x89d1FeC16BA1c8aEbC7866263eb4Ca2D8bD8EeC4
The above request returns fine without a 502, but duplicate entries can be found.

It didn't return fine without a 502, which #6830 won't help at all.

yisiliu · 2020-06-28T01:35:34Z

Got it. Thanks!

grants/report endpoint

b446e98

sebastiantf requested review from danlipert, octavioamu and thelostone-mc as code owners May 12, 2020 11:39

gitcoinbot mentioned this pull request May 12, 2020

Expose Grant information via API endpoints for Rotki and other api consumers #6493

Closed

thelostone-mc requested a review from owocki May 13, 2020 05:52

sebastiantf mentioned this pull request May 13, 2020

Documentation for /grants api endpoint #6650

Merged

display clr_payouts too

4b99d2f

danlipert approved these changes Jun 4, 2020

View reviewed changes

octavioamu approved these changes Jun 4, 2020

View reviewed changes

fix clr round dates

7871c92

sebastiantf requested review from frankchen07 and PixelantDesign as code owners June 4, 2020 19:16

PixelantDesign reviewed Jun 4, 2020

View reviewed changes

thelostone-mc merged commit 65edebb into gitcoinco:master Jun 5, 2020

sebastiantf mentioned this pull request Jun 11, 2020

Fix: duplicate entries in /grants/report API #6830

Merged

yisiliu mentioned this pull request Jun 22, 2020

[Bug] Renaming the donate button when API not ready DimensionDev/Maskbook#1268

Closed

guanbinrui mentioned this pull request Jun 28, 2020

[Demand] Update grant information via API DimensionDev/Maskbook#1278

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose Grant information via API #6633

Expose Grant information via API #6633

sebastiantf commented May 12, 2020 •

edited

Loading

codecov bot commented May 12, 2020 •

edited

Loading

Jack-Works commented May 13, 2020

thelostone-mc commented May 13, 2020 •

edited

Loading

sebastiantf commented May 13, 2020

Jack-Works commented May 13, 2020

octavioamu commented May 13, 2020

sebastiantf commented May 13, 2020

owocki commented May 13, 2020 via email

sebastiantf commented May 14, 2020

Jack-Works commented May 19, 2020

sebastiantf commented May 19, 2020

Tedko commented Jun 1, 2020

owocki commented Jun 1, 2020

danlipert left a comment

PixelantDesign left a comment

sebastiantf commented Jun 5, 2020

Jack-Works commented Jun 8, 2020 •

edited

Loading

owocki commented Jun 8, 2020

Jack-Works commented Jun 8, 2020

Jack-Works commented Jun 9, 2020

owocki commented Jun 9, 2020

sebastiantf commented Jun 11, 2020

Tedko commented Jun 11, 2020 via email

yisiliu commented Jun 22, 2020

sebastiantf commented Jun 22, 2020

yisiliu commented Jun 22, 2020

yisiliu commented Jun 28, 2020

Expose Grant information via API #6633

Expose Grant information via API #6633

Conversation

sebastiantf commented May 12, 2020 • edited Loading

Description

Example:

Request:

Response:

Refers/Fixes

Testing

codecov bot commented May 12, 2020 • edited Loading

Codecov Report

Jack-Works commented May 13, 2020

thelostone-mc commented May 13, 2020 • edited Loading

sebastiantf commented May 13, 2020

Jack-Works commented May 13, 2020

octavioamu commented May 13, 2020

sebastiantf commented May 13, 2020

owocki commented May 13, 2020 via email

sebastiantf commented May 14, 2020

Jack-Works commented May 19, 2020

sebastiantf commented May 19, 2020

Tedko commented Jun 1, 2020

owocki commented Jun 1, 2020

danlipert left a comment

Choose a reason for hiding this comment

PixelantDesign left a comment

Choose a reason for hiding this comment

sebastiantf commented Jun 5, 2020

Jack-Works commented Jun 8, 2020 • edited Loading

owocki commented Jun 8, 2020

Jack-Works commented Jun 8, 2020

Jack-Works commented Jun 9, 2020

owocki commented Jun 9, 2020

sebastiantf commented Jun 11, 2020

Tedko commented Jun 11, 2020 via email

yisiliu commented Jun 22, 2020

sebastiantf commented Jun 22, 2020

yisiliu commented Jun 22, 2020

yisiliu commented Jun 28, 2020

sebastiantf commented May 12, 2020 •

edited

Loading

codecov bot commented May 12, 2020 •

edited

Loading

thelostone-mc commented May 13, 2020 •

edited

Loading

Jack-Works commented Jun 8, 2020 •

edited

Loading