Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Common Allo interface for V1 and V2 #2796

Merged
merged 18 commits into from
Jan 12, 2024
Merged

Common Allo interface for V1 and V2 #2796

merged 18 commits into from
Jan 12, 2024

Conversation

boudra
Copy link
Contributor

@boudra boudra commented Jan 9, 2024

Fixes: #2780

Description

This PR sets up some interfaces to make migration to Allo V2 easier, while maintaining compatibility for Allo V1, decoupling the contract interactions from the UI and preparing the incremental migration to Viem.

  • Refactor data layer single query method into separate methods
  • Add initial Allo interface that will have V1 and V2 implementations
  • Add initial AlloV1 implementation using Viem
  • Add useAllo hook and AlloProvider context to call Allo from the UI
  • Add TransactionSender interface that can be implemented in any web3 library, facilitating migration to Viem
  • Add WaitUntilIndexerSynced interface to facilitate migration from Subgraph to the Grants Stack Indexer
  • Add IpfsUploader interface to facilitate testing

Checklist

This PR:

  • Includes only changes relevant to the original ticket. Significant refactoring needs to be separated.
  • Doesn't disable eslint rules.
  • Doesn't work around the type checker (including but not limited to: type casts, non-null assertions, @ts-ignore, unjustified optional values).
  • Doesn't contain commented out code.
  • If adding/updating a feature, it adds/updates its test script on Notion.

Copy link

vercel bot commented Jan 9, 2024

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

Name Status Preview Comments Updated (UTC)
builder ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 3:56pm
builder-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 3:56pm
explorer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 3:56pm
explorer-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 3:56pm
manager ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 3:56pm
manager-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 3:56pm

@melissa-neira
Copy link
Member

I defer my review to the eng team 😎

Copy link

gitstream-cm bot commented Jan 11, 2024

🥷 Code experts: carlbarrdahl, vacekj

carlbarrdahl, vacekj have most 👩‍💻 activity in the files.
vacekj, carlbarrdahl have most 🧠 knowledge in the files.

See details

packages/common/package.json

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT 5 additions & 1 deletions
SEP
AUG

Knowledge based on git-blame:
vacekj: 80%

packages/data-layer/src/data-layer.test.ts

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT
SEP
AUG

Knowledge based on git-blame:

packages/data-layer/src/data-layer.ts

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT
SEP
AUG

Knowledge based on git-blame:

packages/data-layer/src/data-layer.types.ts

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT
SEP
AUG

Knowledge based on git-blame:

packages/grant-explorer/src/context/RoundContext.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT
SEP
AUG

Knowledge based on git-blame:
vacekj: 1%

packages/grant-explorer/src/context/__tests__/RoundContext.test.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT
SEP
AUG 4 additions & 6 deletions

Knowledge based on git-blame:
vacekj: 5%

packages/grant-explorer/src/features/api/rounds.ts

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV 164 additions & 186 deletions
OCT 266 additions & 128 deletions 21 additions & 40 deletions
SEP
AUG

Knowledge based on git-blame:
carlbarrdahl: 47%
vacekj: 1%

packages/grant-explorer/src/features/discovery/__tests__/LandingPage.test.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV 36 additions & 8 deletions
OCT 54 additions & 50 deletions
SEP 3 additions & 21 deletions
AUG 11 additions & 10 deletions

Knowledge based on git-blame:
carlbarrdahl: 20%
vacekj: 2%

packages/grant-explorer/src/features/discovery/hooks/__tests__/useFilterRounds.test.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV 169 additions & 0 deletions 1 additions & 1 deletions
OCT
SEP
AUG

Knowledge based on git-blame:
carlbarrdahl: 69%
vacekj: 1%

packages/grant-explorer/src/features/discovery/hooks/useApplications.ts

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV 106 additions & 41 deletions
OCT
SEP
AUG

Knowledge based on git-blame:
carlbarrdahl: 57%

packages/grant-explorer/src/features/round/ViewCartPage/SummaryContainer.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN 11 additions & 4 deletions
DEC 144 additions & 87 deletions
NOV 4 additions & 2 deletions
OCT 91 additions & 15 deletions
SEP 13 additions & 7 deletions
AUG 11 additions & 16 deletions

Knowledge based on git-blame:
vacekj: 41%

packages/grant-explorer/src/features/round/ViewProjectDetails.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV
OCT
SEP
AUG

Knowledge based on git-blame:
vacekj: 22%

packages/grant-explorer/src/test-utils.tsx

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC
NOV 18 additions & 13 deletions 2 additions & 5 deletions
OCT 26 additions & 18 deletions
SEP
AUG 1 additions & 1 deletions

Knowledge based on git-blame:
carlbarrdahl: 14%
vacekj: 2%

pnpm-lock.yaml

Activity based on git-commit:

carlbarrdahl vacekj
JAN
DEC 1755 additions & 1755 deletions
NOV 47 additions & 45 deletions 678 additions & 828 deletions
OCT 216 additions & 68 deletions
SEP 5514 additions & 9303 deletions
AUG 7291 additions & 5024 deletions

Knowledge based on git-blame:
vacekj: 64%

To learn more about /:\ gitStream - Visit our Docs

Copy link

gitstream-cm bot commented Jan 11, 2024

This PR is 77.24125023395096% new code.

@boudra boudra merged commit f97400c into main Jan 12, 2024
19 checks passed
@boudra boudra deleted the common-allo branch January 12, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Start base Allo V2 wrapper in the common package
3 participants