[API] ICR API Integration #2051

psparacino · 2023-12-20T17:57:04Z

Description

API Integration for ICR credits

POSTMAN TESTS CHECK FAILURE: The postman tests are currently failing as this PR is currently using a test subgraph that is updated for ICR but doesn't index the main Carbonmark contract and thus doesn't have activity for the project included in the test. After the ICR updates have been merged to the main subgraph, deployed etc the tests should pass

Notes for reviewers:

ICR tracks quantities only in regular integers (i.e. 40) vs wei. This is why amount is handled per registry throughout. Ideally in the next iteration we can move this quantity handling to the subgraph (which currently only handles amounts in wei).
Individual projects (/projects/[id]) from ICR are stitched into the cms carbonProject type here
for /projects list, the ICR projects are combined with cms projects here.
These projects will likely be included in the cms in the near future and not handled here.
The ICR API limit is 50 for all projects
ICRs countries and vintages are fetched here to be combined with the options for the search filters.
The ICR API supports querying projects by and/or serialization (a unique ICR key, which contains the necessary info for the CM format of registry-registryNum-vintage), contractAddress and projectID (a unique ICR identifier). Serialization is always used when possible, but there is some debt taken on by supporting lookup by contractAddress when the serialization is not available, or projectID (especially in [KLIMADAO/Klimadao] Polygon-digital-carbon for retirement data #2048 ) when neither of those are available. Moving projects to the cms will get around the majority of these workarounds.
These subgraph are deployed to a personal account. The updated subgraphs should deployed under the organizational account before merge.

Related Ticket

Closes ICR epic
This PR is dependent on #2047 and #2048 and should be merged after those.

Notes For QA

Specific pages, components or journeys that might be affected:

Most all user journeys and pages are impacted by this PR.
/retirements/** will be incorporated once PR [KLIMADAO/Klimadao] Polygon-digital-carbon for retirement data #2048 is merged into staging

Relevant preview URLs:

Other notes:

As is this obviously a very large PR, if any reviewer would prefer to pair review or has any questions please reach out!

vercel · 2023-12-20T17:57:16Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
carbonmark	✅ Ready (Inspect)	Visit Preview		Jan 22, 2024 3:51am
carbonmark-api	✅ Ready (Inspect)	Visit Preview		Jan 22, 2024 3:51am
demo-integration	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2024 3:51am
klimadao-app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2024 3:51am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
carbon	⬜️ Ignored (Inspect)	Visit Preview		Jan 22, 2024 3:51am

biwano

Great work.
Be careful, this is going to massively conflict with #2049

carbonmark-api/src/models/Project.model.ts

carbonmark-api/src/utils/ICR/ICR_API_endpoints.ts

carbonmark-api/src/utils/ICR/icr.types.ts

carbonmark-api/src/utils/getCategoryFromMethodoloy.ts

carbonmark-api/src/routes/purchases/[id]/get.ts

carbonmark-api/src/routes/users/[walletOrHandle]/get.ts

carbonmark-api/src/utils/ICR/icr.utils.ts

carbonmark-api/src/utils/helpers/cms.utils.ts

biwano

I approved. If you can address my last 2 comments before merging.

biwano · 2024-01-20T19:45:36Z

carbonmark-api/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@klimadao/carbonmark-api",
-  "version": "5.2.1",
+  "version": "5.3.1",


Should be 5.3.0

biwano · 2024-01-20T19:48:36Z

carbonmark-api/test/test.constants.ts

  username: "someusername",
  profileImgUrl: null,
 };

 export const EXPECTED_USER_RESPONSE = {
  ...omit(MOCK_USER_PROFILE, ["address", "updatedAt", "createdAt"]),
-  updatedAt: 1699715108,
+  updatedAt: 1702675,


Something is wrong here. I think MOCK_USER_PROFILE updated at should be something like 1702675170000

psparacino requested review from Atmosfearful, 0xemc, 0xMakka, biwano and sprrwhwk as code owners December 20, 2023 17:57

psparacino had a problem deploying to Preview – carbonmark-api December 20, 2023 17:57 — with GitHub Actions Failure

psparacino force-pushed the API_feature/icr-api-integration branch from d0c8167 to 54d887b Compare December 20, 2023 18:46

psparacino had a problem deploying to Preview – carbonmark-api December 20, 2023 18:46 — with GitHub Actions Failure

vercel bot deployed to Preview – demo-integration December 20, 2023 18:46 View deployment

vercel bot deployed to Preview – klimadao-app December 20, 2023 18:49 View deployment

vercel bot deployed to Preview – carbonmark December 20, 2023 18:51 View deployment

psparacino force-pushed the API_feature/icr-api-integration branch from 54d887b to e735677 Compare December 20, 2023 19:48

psparacino had a problem deploying to Preview – carbonmark-api December 20, 2023 19:48 — with GitHub Actions Failure

vercel bot deployed to Preview – demo-integration December 20, 2023 19:48 View deployment

vercel bot deployed to Preview – klimadao-app December 20, 2023 19:50 View deployment

vercel bot deployed to Preview – carbonmark December 20, 2023 19:52 View deployment

This was referenced Dec 20, 2023

[APP] ICR FE Integration #2052

Merged

DRAFT: Feature/icr-api-integration #1843

Closed

biwano requested changes Jan 5, 2024

View reviewed changes

psparacino force-pushed the API_feature/icr-api-integration branch from e735677 to 80a5d51 Compare January 8, 2024 15:54

psparacino had a problem deploying to Preview – carbonmark-api January 8, 2024 15:54 — with GitHub Actions Failure

vercel bot deployed to Preview – demo-integration January 8, 2024 15:55 View deployment

vercel bot deployed to Preview – klimadao-app January 8, 2024 15:57 View deployment

vercel bot deployed to Preview – carbonmark January 8, 2024 15:58 View deployment

psparacino force-pushed the API_feature/icr-api-integration branch from 80a5d51 to 9e5651d Compare January 8, 2024 16:19

psparacino had a problem deploying to Preview – carbonmark-api January 8, 2024 16:19 — with GitHub Actions Failure

vercel bot deployed to Preview – demo-integration January 8, 2024 16:20 View deployment

vercel bot deployed to Preview – klimadao-app January 8, 2024 16:21 View deployment

vercel bot deployed to Preview – carbonmark January 8, 2024 16:25 View deployment

vercel bot deployed to Preview – demo-integration January 19, 2024 13:04 View deployment

vercel bot deployed to Preview – klimadao-app January 19, 2024 13:04 View deployment

vercel bot deployed to Preview – carbonmark January 19, 2024 13:09 View deployment

psparacino closed this Jan 19, 2024

psparacino force-pushed the API_feature/icr-api-integration branch from 381ee83 to 31e8527 Compare January 19, 2024 14:26

vercel bot deployed to Preview – demo-integration January 19, 2024 14:27 View deployment

psparacino reopened this Jan 19, 2024

psparacino deployed to Preview – carbonmark-api January 19, 2024 14:43 — with GitHub Actions Active

vercel bot deployed to Preview – demo-integration January 19, 2024 14:44 View deployment

vercel bot deployed to Preview – klimadao-app January 19, 2024 14:46 View deployment

vercel bot deployed to Preview – carbonmark January 19, 2024 14:48 View deployment

psparacino force-pushed the API_feature/icr-api-integration branch from 3aa1705 to 614d464 Compare January 19, 2024 16:36

psparacino deployed to Preview – carbonmark-api January 19, 2024 16:36 — with GitHub Actions Active

vercel bot deployed to Preview – demo-integration January 19, 2024 16:37 View deployment

vercel bot deployed to Preview – klimadao-app January 19, 2024 16:41 View deployment

vercel bot deployed to Preview – carbonmark January 19, 2024 16:41 View deployment

biwano approved these changes Jan 20, 2024

View reviewed changes

psparacino force-pushed the API_feature/icr-api-integration branch from 614d464 to c99b6e6 Compare January 22, 2024 03:43

psparacino deployed to Preview – carbonmark-api January 22, 2024 03:43 — with GitHub Actions Active

vercel bot deployed to Preview – demo-integration January 22, 2024 03:44 View deployment

api: adjust tests and increment version to 5.3.0

78e9764

psparacino force-pushed the API_feature/icr-api-integration branch from c99b6e6 to 78e9764 Compare January 22, 2024 03:45

psparacino deployed to Preview – carbonmark-api January 22, 2024 03:45 — with GitHub Actions Active

vercel bot deployed to Preview – demo-integration January 22, 2024 03:45 View deployment

vercel bot deployed to Preview – klimadao-app January 22, 2024 03:48 View deployment

vercel bot deployed to Preview – carbonmark January 22, 2024 03:51 View deployment

jabby09 approved these changes Jan 22, 2024

View reviewed changes

psparacino merged commit ec9cadc into staging Jan 22, 2024
10 checks passed

psparacino deleted the API_feature/icr-api-integration branch January 22, 2024 14:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[API] ICR API Integration #2051

[API] ICR API Integration #2051

psparacino commented Dec 20, 2023 •

edited by 0xemc

Loading

vercel bot commented Dec 20, 2023 •

edited

Loading

biwano left a comment

biwano left a comment

biwano Jan 20, 2024

biwano Jan 20, 2024

[API] ICR API Integration #2051

[API] ICR API Integration #2051

Conversation

psparacino commented Dec 20, 2023 • edited by 0xemc Loading

Description

Related Ticket

Notes For QA

vercel bot commented Dec 20, 2023 • edited Loading

biwano left a comment

Choose a reason for hiding this comment

biwano left a comment

Choose a reason for hiding this comment

biwano Jan 20, 2024

Choose a reason for hiding this comment

biwano Jan 20, 2024

Choose a reason for hiding this comment

psparacino commented Dec 20, 2023 •

edited by 0xemc

Loading

vercel bot commented Dec 20, 2023 •

edited

Loading