Magnify Cash V1 Monorepo

Welcome to Magnify Cash V1! This repository serves as the central hub for various subprojects that collectively constitute the Magnify Cash protocol. If you wish to learn more about the contracts, protocol design, and other related aspects, please navigate to the /contracts directory.

Repo Structure

This monorepo utilizes yarn workspaces to manage dependencies across subprojects seamlessly. To get started, simply run yarn install from the root directory, and it will automatically handle all the dependencies for the subprojects.

Currently, the monorepo comprises the following four subprojects:

1. contracts: This section contains the smart contracts that form the backbone of the Magnify Cash protocol. For in-depth details, please refer to the /contracts directory.

2. subgraph: Here, you can find the code responsible for managing the subgraph of the Magnify Cash protocol. (You may include additional context or purpose of the subgraph here.)

3. faucet: The faucet subproject deals with setting up and managing the faucet service. (Feel free to elaborate further on the functionality of the faucet if needed.)

4. dapp: The dapp subproject encompasses the decentralized application (dApp) for Magnify Cash. (Provide more information on the features and functionalities of the dApp as necessary.)

Local Development Setup

To begin local development, carefully follow the steps outlined below:

Setting up graph-node docker

1. Install Docker v4.10.1 from here.

2. Clone the graph-node repository into a shared parent directory with the current repository. Both repositories should be located in the same parent folder.

3. Build graph-node images locally by following these steps. Note: Before proceeding, you must increase Docker's memory allowance to 8GB from Preferences → Resources. After completion, you can revert it to the default 4GB.

Starting a Local Development Stack

1. Begin by running yarn install to install all the necessary dependencies.

2. Execute yarn contracts start to bring up the local hardhat chain.

3. Start the local graph stack with yarn graph-node. Please wait until the logs indicate Downloading latest blocks from Ethereum, this may take a few minutes....

4. Deploy a fresh version of all contracts and the subgraph by running yarn deploy:local.

The environment is now ready for development. You can launch the faucet service using yarn faucet start and/or start the dApp with yarn dapp-v1 start.

Deploying to Staging

Requirements:

1. Make sure you have a valid PRIVATE_KEY with testnet ETH in your .env.
2. Run graph auth --product hosted-service <SUBGRAPH_ACCESS_TOKEN>.

Steps:

1. Run yarn contracts deploy:<network>.
2. Change the addresses and block numbers in subgraph/subgraph.yaml and dapp-v1/wagmi.config.ts as needed by copying them from the new deployments.json. Also, for subgraph/networks.json, copy the values from "mainnet" into the desired network.
3. Run yarn subgraph deploy:<network>.
4. Make sure yarn dapp build is working locally with the production .envs, and without the local graph node running.
5. Push changes to staging branch for them to be deployed.

Note: After deploying a new version of the subgraph, you must wait for the graph-node to sync the latest blocks before you can run the dapp. This usually takes 10-15 minutes.

If you just want to deploy the subgraph and dapp and not the contracts, you can do the following:

• Make sure the addresses and block numbers are correct in subgraph/subgraph.yaml and dapp-v1/wagmi.config.ts.
• Do step 3 to 5 from above.

Notes:

• When you make changes to the contracts, always run yarn deploy:local to deploy the updated contracts and subgraph.

• If you close the hardhat chain process, ensure to restart the graph-node script as well.

• For the scripts to work correctly, ensure that both this repo and the graph-node repo are present in the same parent directory.

Deploying to Production

Requirements:

1. Ensure you have .env and contracts/.env filled out. This includes the following variables: .env

INFURA_API_KEY
PRIVATE_KEY

contracts/.env

SOLC_VERSION
DAPP_SRC
REPORT_GAS
CMC_KEY
PLATFORM_WALLET
OBLIGATION_URI
KEYS_URI
LOF
CONTRACT_OWNER
MAINNET_URL
ETHERSCAN_API_KEY

Steps

1. Run yarn contracts deploy:<network>.
2. Change the addresses and block numbers in dapp-v1/wagmi.config.ts as needed by copying them from the new deployments.json.
3. Make sure yarn dapp build is working locally.
4. Push changes to staging branch for them to be deployed.

Supporting new chain (WIP)

contracts

• add new network in contracts/hardhat.config.ts
• add new deploy:<network> command in contracts/package.json

frontend

• add deployed contract address in dapp-v1/wagmi.config.ts
• add new chain in dapp-v1/src/wagmi.ts
• update protocol defaults in dapp-v1/src/helpers/protocolDefaults
• update alchemy networks in dapp-v1/src/helpers/utils.ts

subgraph

• add new deploy:<network> command in subgraph/package.json

Running Tests

To run all smart contract tests, execute yarn contracts test.