Post-POC tech debt cleanup

[mds1]

Below is a list of tech debt-related things I've noticed. When applicable, I've included the PR number where the item was introduced for traceability, in case any of these are intentional for a reason I've missed, and because in some of the linked PRs I left comments on the specific line being referring to

Items with no issue

• [x] #349
• [x] ~2. PR 248: useGrantRegistryList composition function mostly duplicated in two files. Seems there are slight differences so maybe leave this?~
• [ ] 3. PR 249: added another hardcoded reference to a specific grant round, so we just need to keep track of these somewhere. The other reference is in data.ts here, and there may be others? (cc @gdixon)
• [ ] 4. Type-related issues (some of these may have since been resolved, so verify that and check them off if so):
  • [x] PR 249: GrantCard.vue: getTotalRaised input type should be BigNumberish, not any, and the input should be handled/casted as appropriate. FIX
  • [ ] related to above, change all types from Number to BigNumberish
  • [ ] General Grant ID inconsistency throughout app: sometimes grant IDs are numbers (e.g. GrantRegistryGrantDetail.vue), sometimes strings (e.g. GrantRegistryNewGrant.vue), and sometimes any (e.g. throughout GrantCard.vue). Grant ID inputs should always be of type BigNumberish and then cast to a number with BigNumber.from(x).toNumber(), and when a grant ID is used somewhere it should always be number
  • [x] #569
• [ ] 5. Docs questions
  • [x] #352
  • [x] #353
  • [ ] I don't see any docs or issues related to the docusaurus config. Who owns the credentials, how you preview changes, push them to live site, is @scco handling design of the docs, whats the next steps, etc.? In general I'm just unclear on the big picture here
• [ ] 6. PR 251: Remove allowUnlimitedContractSize: true
• [x] 7. PR 251: Remove hardcoded gas limit of { gasLimit: 1000000 } that was introduced
• [x] 8. PR 252: In getGrantRound, why do we poll every 30 seconds instead of every block which would be every ~13 seconds. (cc @gdixon)
• [x] #354
• [ ] 10. A more generalized phrasing of the above bullet point: We should review data.ts and its poll() method for consistency—we should ensure one call of poll() always results in store's data all being from the same block, and cannot result in the state being populated with data from different blocks
• [x] 11. Ensure all components are using the Composition API and not the Options API
• [ ] 12. Home.vue duplicates code from both GrantRegistryList.vue and GrantRoundsList.vue, so could be more DRY. Additionally, the styles in home vs. the other two components differ a bit. It seems we can either (1) pull the logic out into reusable composition functions which are reused between components and manually fix styles, or (2) create intermediate components that the above pages would all use which contains both the logic and styles. TBD on which is better, pending looking at this closer
• [x] #351
• [x] 14. We cache a lot of data in local storage, and I think we'll hit the 5MB limit fairly quickly. The IndexedDB API isn't the simplest, so we might want to consider a wrapper library such as localForage, which also has the benefit of falling back to localStorage if IndexedDB is not available in the browser
• [ ] 15. All beforeEach hooks in tests should be refactored to use Waffle fixtures. The lack of fixtures makes gas snapshots and other things dependent on test order, which isn't ideal. More info here
• [ ] 16. Read and initialize all app environment variables in constants.ts, e.g. in this file we (1) read the env var, (2) ensure it's valid, and (3) throw if it's not, then (4) export the properly typed env var
• [ ] 17. There's a lot of places we have buttons that link to pre-generated tweets. We could probably pull these out into a component to reduce duplicated code
• [ ] 18. GrantReviewList.vue is (almost) a duplicate of GrantList.vue - figure out a way to modularize and keep it DRY
• [x] 19. Create a BaseImage.vue component to display images (implemented as LogoPtrImage this could be renamed? cc. @mds1). Context here
• [ ] 20. ipfs.ts should not need to be aware of Protocol ID 0 https://github.com/dcgtc/dgrants/pull/554

Items with related issues / discussions

• [ ] Fix errors related to onboard.js Gnosis module. More info in #26
• [ ] Improve wallet connection UX / network switching UX. More info in #14
• [ ] Review Vite polyfills and remove as many as possible. Known sources requiring polyfills are certain onboard.js wallet modules, dcurve, and the ipfs-http-client package. Related to #127
• [ ] Remove hardcoded swap paths in cart.ts and replace with a pathfinding algorithm. More info in #140
• [ ] On cart page, support any donationToken in the "Equivalent to" field. More info in #215
• [ ] Improve Jazzicon component to be responsive and easier to style. More info in https://github.com/dcgtc/dgrants/issues/214
• [ ] Determine the canonical dGrants chain OR determine the best way to support both Uniswap V2 and V3 style swaps. PR 281 introduced support for both styles by modifying quoteExactInput and copy/pasting/editing to create GrantRoundManagerUniV2.sol, but may not be ideal. Related to https://github.com/dcgtc/dgrants/discussions/263

[metafraction]

@mds1 Nice organization here. How should we try tackling this? I'm sure these tasks will be broken amongst team members in some way.

[mds1]

I think we should hold off on figuring out how to tackle this until after the POC is complete. None of these are required for the POC, so we're better off focusing on POC-blockers and just adding new things to this issue as they come up. Once we're totally done with the POC, let's circle back to this issue to prioritize, split into individual issues, and assign

[metafraction]

added numbers for ease of reference

[metafraction]

Current plan to handle this:

• If the items are small enough to resolve, collect as many in one branch (I have one going called tech-debt-1)
• In the PR, reference back to this issue and the item number
• If the item feels somewhat larger, create a separate issue for it and label with tech debt
• When resolved locally, leave a comment here that it was resolved and check mark it completed when merged

[metafraction]

item 6 and 7 are resolved locally and a separate issue is up for 11: #346

[metafraction]

4(a) resolved in tech-debt-1

[phutchins]

On 5(c) - The site is built and deployed through Fleek. I submitted an issue for the current build problem in fleek and included the error log. Arentweall from discord built and designed what we have so far but I believe he has stepped away.

[metafraction]

436 introduces tech-debt, GrantReviewList.vue is (almost) a duplicate of GrantList.vue

[metafraction]

the following issues address item 20

• 557

• 558