We currently use a self-made script for contract deployment and saving of deployed addresses to files for the frontend. We now found the feature rich hardhat plugin https://github.com/wighawag/hardhat-deploy which does this, including etherscan contract validation. So we should switch to using it.

Currently based on open PR #49 so must not be merged yet.

• contracts: Emit missing PoolDeployed event
• contracts: Add minimum stake amount and duration parameters

Currently, the first sponsor to stake for any beneficiary implicitly deploys the sponsor pool. This made sense in the context of the hackathon, but is not good practice. So we make pool deployments explicit. Open question whether to have an explicit deployAndStake function that does both. Might get complicated once we change the public interface so that pool interactions are directly with the pool contracts instead of forwarding functions on the main contract.

This needs follow-up changes in the frontend. When loading a profile page, it has to be checked whether there's already a pool deployed. It can then show the option "Deploy" and maybe a second option "Deploy & Stake".

• chore: add .lintstagedrc.json on package-level
• chore: add .yaml extension
• chore: remove eslint-ing from root .lintstagedrc.json
• chore: renamed format to lint:fix in turbo.json (we forgot that @sebastianst)

@sebastianst One more thing, that is not related to this particular fix, but that i recognized during my investigations is that solhint currently throws warnings but the pipeline still does not fail. Do we accept that behavior?

@yieldgate/hardhat:lint: > solhint 'contracts/**/*.sol'
@yieldgate/hardhat:lint: 
@yieldgate/hardhat:lint: 
@yieldgate/hardhat:lint: contracts/YieldGate.sol
@yieldgate/hardhat:lint:    13:5  warning  Explicitly mark visibility of state                                                                state-visibility
@yieldgate/hardhat:lint:    21:5  warning  Explicitly mark visibility in function (Set ignoreConstructors to true if using solidity >=0.7.0)  func-visibility
@yieldgate/hardhat:lint:   105:5  warning  Explicitly mark visibility of state                                                                state-visibility
@yieldgate/hardhat:lint:   106:5  warning  Explicitly mark visibility of state                                                                state-visibility
@yieldgate/hardhat:lint: 
@yieldgate/hardhat:lint: ✖ 4 problems (0 errors, 4 warnings)

I think I replaced all the wallet and chain related components with the Rainbow Kit counterparts. I didn't customize theme and wallet list much because those APIs are flagged as unstable and we still have a while to go to mainnet.

The stake/unstake controls on the CreatorCard component don't update correctly after staking (even though the staking flow seems to work, but I think this is not related to the Rainbow Kit change. I was able to reproduce on develop. Can you have a look at it and confirm? If so, I'd say we can open a new issue to have a look at it.

Let me know what you think or if I missed something. Feel free to merge if everything looks good (although keep in mind it might need rebasing if some other PR is merged first). Thanks!

• contracts: Emit missing PoolDeployed event
• contracts: Fix and configure solhint
• contracts: Add YieldGate testing setup
• contracts: Fix unstake: supporter amount must be non-zero
• contracts: Add stake and unstake test
• ci: Add contract tests to CI

Overall I'm pretty satisfied with the new setup. Installing dependencies works faster and more reliably via pnpm and subsequent dev/build tasks, too – thanks to turborepo. Regarding the configuration files I'm fine with the current state even if I found the previous way a little bit more declarative.

• Switched package manager to pnpm
  • IMPORTANT: I recommend everyone to delete all its node_modules folders, also within the sub-packages, as well as the top-level package-lock.json. Then install pnpm globally via npm i -g pnpm (also see README.md) and install dependencies via pnpm i. Scripts can be run via pnpm [script].
• Moved prettierrc-configuration to root and let others extend it
• Moved lint-staged-configuration to top as well as re-configured husky pre-commit script to continue working (it normally assumes the configurations are within the packages but i found a workaround)
• Created a base eslintrc-configuration within the root where the others extend from (it contains the least common shared configuration of both packages)
• Set up turborepo and configured pipelines for build, dev, and format in turbo.json (we can do more later).
  • NOTE: For you everything should work the same when starting the global dev/build/format script (e.g. via pnpm dev. Just turborepo is now used under the hood.
• Fixed some minor issue in packages/frontend/lib/creatorReadHooks.ts that should have been dune while updating wagmi but it just came to light (I'm not 100% sure why, I think npm installed some dependencies/versions it should have not. And now pnpm did it correctly. But now it works as it should)

~~Disclaimer: Probably everything breaks when I first try to deploy it to Vercel :D~~

Update: Deploy is fixed now and works with the new setup. ❤️

In summary, this PR:

• Adds husky pre-commit hook calling lint-staged
• Configures lint-staged. It's installed in the repo root, but currently only runs for changes in the frontend package.
• Cleans up ESLint config and updates versions for eslint and @typescript-eslint. I turned most of the rules into warnings because I'd like to have a discussion and reach an agreement on them, in a different PR.
• Commits reformatted files after running prettier --write.

Let me know if you have any questions or if I missed something. Some of the things I'm leaving for future PRs:

• Agreeing on the custom ESLint rules and turning them off or into errors. No point in having a big noisy wall of warnings
• Update dependencies (Chakra + React 18 is finally available, for example)
• Extend linting and formatting to the hardhat package
• Improve the testing situation, we currently have no tests.

Summary of changes:

• Improved BlockiesAvatar by replacing useState and useEffect with useMemo. I also removed Box and extended ImageProps to make it more reusable/maintainable.
• Removed the flex order and justifyContent keys in ConnectWallet to fix the swapping of elements in the navbar.
• Improved ConnectWalletButton to accept all possible button props and forward them to the underlying button. I also set a default of 200px for its width (was 220px) because that was causing some responsiveness issues on narrow screens.
• Made the avatar size responsive in CreatorCardDetails
• Made some changes in CreatorCardNumbers to allow wrapping and keep things looking somewhat okay when that happens.
• Changed CreatorList from the homepage from a flex-based to a grid-based layout that adapts better to different widths. The "iPad range" is not ideal, with a lot of empty space, but that's what we get with the Chakra's default breakpoints without getting too much into the weeds.
• Changed Layout so that the footer remains at the bottom when a view's content doesn't fill a whole viewport height.
• Changed the layout of logos on the homepage for better responsiveness.
• Changed the layout of [walletId] for better responsiveness.

The diffs include a lot of formatting changes automatically made by Prettier. I think we should probably make sure our Prettier configs are working in the same direction. From the before and afters I think mine is working fine, but let me know if you think otherwise. We would probably benefit from making a big reformatting commit once that is established, so that actual code changes are easier to glean in future PRs.

The layout is still not worthy of a webby award, specially at some viewport widths, but it's an improvement from what we had and the most painful issues (overflows on narrow screens) should be fixed.

Let me know if you find any remaining glaring issues and feel free to raise any points with the implementation.

IMPORTANT:

1. Make sure to check your frontend .env.local again from .env.local.example (a few things have changed)
2. Make sure to re-install dependencies with npm like described in previous PR (https://github.com/yieldgate/yieldgate/pull/8)

Changes:

• frontend: environment variable NEXT_PUBLIC_DEFAULT_CHAIN added (for read-calls w/o wallet/signer connected)
• frontend: environment variable NEXT_PUBLIC_SUPPORTED_CHAINS is now actually used in wagmiClient.ts
• frontend: added ChainSwitchMenu
• frontend: refactored ens-domain fetching into new useEnsDomain hook
• frontend: made index + creator-page adaptive to different chains
• frontend: refactored creators-list within index into CreatorsList and CreatorsListItem
• frontend: made CreatorsList filterable and "paginatable"
• frontend: refactored CreatorCard into CreatorCardDetails, CreatorCardActions, and CreatorCardNumbers
• frontend: refactored creator-related read-transactions into new creatorReadHooks
• frontend: new hook useYieldgateContract always returns the current supported chain, and according contract addresses for read/write calls

probably forgot some things 🤷‍♂️

• The frontend currently has the Polygon Mumbai chain hardcoded, including the native token unit MATIC.
• The hardhat deploy script also has Mumbai hardcoded, including the chain id, Aave contract addresses (WETHGateway, Pool and native aToken).

It should be easy to make other testnets available.

• The frontend could query the chain id from the web3 provider and then read the relevant information from a static list. @wottpal feel free to expand on this.
• Similarly, for the hardhat deploy script, we can define a list of static data and then pass the chain(s) to deploy to via cmdline flags. I'd do that.

• contracts: Add AaveMock for testnets
• contracts: Add OffsetHelperMock for testnets
• contracts: Add ERC20AutoMinter and SFETestUSD for testnets
• contracts: Add missing license headers
• contracts: Add package lodash.isplainobject
• contracts: Extend end2end test to work with Mocks on local node
• contracts: Cleanup deploy scripts in package.json
• contracts: Redeploy contract YieldGate
• contracts: Deploy all contracts to Mumbai

Contracts deployed to Mumbai at (edit: updated):

• AaveMock (0x3103E87eEDC29fBA8620f21f2Ac40F116e9403fE)
• OffsetHelperMock (0xb3E8E4050d83095E21E7B64Fa00EA1a8aB221ddf)
• SFETestUSD (0x7ab4fCFCd4F108cdC43D591C0546aC7cfC36fd6B)
• TokenPoolWithApproval (0xC5150aE1962c80522B7cb98a9Edcd43C6B063F93)
• ToucanOffsetter (0x6B11165C455BbEa3FF1BcC2f3821701fb31b60Bb)
• YieldGate (0xd4C90eD0954a85629Bf272616fA55c0Af7B5D55C)

All contracts got verified on Mumbai polygonscan.

It would be nice to use the shared solidity revert strings from packages/contracts/shared/revertReasons.ts in Solidity source files instead of having duplicate definitions.

One solution could be to use the solpp preprocessor together with the hardhat plugin. However, solpp seems unmaintained so I'd like to avoid this dependency at this point.

In https://github.com/yieldgate/yieldgate/pull/52 commit https://github.com/yieldgate/yieldgate/pull/52/commits/89c1eae93787d9f78d5f2f6fd61c7814d6a8dd50 adds coverall reporting, but it seems to be broken right now. Codecov works. But Coveralls apparently has better branch coverage reporting for Solidity, so it might be worth giving Coveralls a try at some point in the future.

Since 0.8.4 Solidity supports custom errors. We might consider using them. First need to check how well it is supported in our tooling etc though. E.g. error catching is not yet supported (https://github.com/ethereum/solidity/issues/11278).

• Current Solidity docs on it