local dev env (#1)

* add Dockerfile and scripts to deploy contract and populate local chain

* extract getBlocksToWait function

* add .dockerignore

* add dev network

* run anvil with host 0.0.0.0

* add docker docs in README

* build

* override node-hid version

* use DEV_CHAIN_HOST for dev chain

* add deterministic address for the project registry proxy contract

* update dev chain id to 313371 to avoid conflicts with other local chains configurations

* update test project metadata CID

* populate projects just after deploying the registry contract

* move populate file to populate/projects

* add DEV_CHAIN_ID var

* log time for populate actions

* remove doc generation to speed up local dev deployment

* add mnemonic for dev chain to use multiple deterministic test wallets

* create more projects and add a new project for the second account

* add emoji to better show time elapsed for tasks

* move Dockerfile to root folder

* update dev deterministic contract addresses

* use local pinata to populate local env

* fix pinata request body

* reorganize devenv  fixtures

* add network chain id to project names

* fix contracts addresses

* update Dockerfile

* set return type to pinata functions

.dockerignore

@@ -0,0 +1,7 @@
+node_modules
+.git
+.github
+.husky
+.openzeppelin*
+.upgradable
+.vscode

Dockerfile

@@ -0,0 +1,25 @@
+FROM node:20-slim
+
+RUN apt-get update && \
+    apt-get install -y python3 curl git build-essential psmisc && \
+    apt-get clean
+
+COPY . /app
+WORKDIR /app
+
+ENV DEV_CHAIN_ID=313371
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
+# Check when foundry supports dumping events
+# https://github.com/foundry-rs/foundry/issues/5906
+RUN curl -L https://foundry.paradigm.xyz | bash
+RUN ~/.foundry/bin/foundryup
+
+RUN pnpm install
+RUN pnpm hardhat compile
+
+EXPOSE 8545/tcp
+
+ENTRYPOINT ./docker/start-chain.sh

Makefile

@@ -0,0 +1,24 @@
+.PHONY: docker-build docker-run docker-kill docker-stop docker-logs docker-deploy-contracts docker-all
+
+IMAGE_NAME=allo
+CONTAINER_NAME=allo
+
+docker-all: docker-kill docker-build docker-run docker-deploy-contracts
+
+docker-build:
+		docker build . -t $(IMAGE_NAME) --no-cache --progress=plain
+
+docker-run:
+		docker run --name $(CONTAINER_NAME) --rm -d -p 127.0.0.1:8545:8545/tcp $(IMAGE_NAME)
+
+docker-kill:
+		-docker kill $(CONTAINER_NAME)
+
+docker-stop:
+		docker stop $(CONTAINER_NAME)
+
+docker-logs:
+		docker logs -f $(CONTAINER_NAME)
+
+docker-deploy-contracts:
+		docker exec allo bash ./docker/deploy-contracts.sh

README.md

@@ -105,6 +105,19 @@ To know the addresses are deployed on which network. refer [CHAINS.md](docs/CHAI
 
 To contribute to this project, fork the project and follow the instructions at [DEV.md](docs/DEV.md)
 
+You can run a local chain and deploy contracts using our docker configuration and tasks:
+
+```
+# Build the docker image with the project deps + anvil
+make docker-build
+
+# run a containerized chain with anvil
+make docker-run
+
+# deploy the contracts to the containerized chain
+make docker-deploy-contracts
+```
+
 ## Contract Documentation
 
 The contract documentation has been generated using [primitive-dodoc](https://github.com/primitivefinance/primitive-dodoc) and can be found over at [docs/contracts](docs/contracts/)

docker/deploy-contracts.sh

@@ -0,0 +1,35 @@
+export SKIP_CONFIRMATIONS=true
+
+TIMEFORMAT='(🟢 %3R seconds)';
+
+time pnpm run deploy-project-registry dev && \
+time pnpm hardhat run scripts/dev/populate/projects.ts --network dev && \
+\
+time pnpm run deploy-program-factory dev && \
+time pnpm run deploy-program-implementation dev && \
+time pnpm run link-program-implementation dev && \
+\
+time pnpm run deploy-qf-factory dev && \
+time pnpm run deploy-qf-implementation dev && \
+time pnpm run link-qf-implementation dev && \
+\
+time pnpm run deploy-merkle-factory dev && \
+time pnpm run deploy-merkle-implementation dev && \
+time pnpm run link-merkle-implementation dev && \
+\
+time pnpm run deploy-direct-factory dev && \
+time pnpm run deploy-direct-implementation dev && \
+time pnpm run link-direct-implementation dev && \
+\
+time pnpm run deploy-allo-settings dev && \
+time pnpm run set-protocol-fee dev && \
+\
+time pnpm run deploy-round-factory dev && \
+time pnpm run deploy-round-implementation dev && \
+time pnpm run link-round-implementation dev && \
+time pnpm run link-allo-settings dev
+
+# pnpm run create-program dev
+# pnpm run create-qf-contract dev
+# pnpm run create-merkle-contract dev
+# pnpm run create-round dev

docker/start-chain.sh

@@ -0,0 +1 @@
+~/.foundry/bin/anvil --host 0.0.0.0 --chain-id $DEV_CHAIN_ID

hardhat.config.ts

@@ -4,7 +4,6 @@ import "@nomiclabs/hardhat-etherscan";
 import "@nomiclabs/hardhat-solhint";
 import "@nomiclabs/hardhat-waffle";
 import "@openzeppelin/hardhat-upgrades";
-import "@primitivefi/hardhat-dodoc";
 import "@typechain/hardhat";
 import "hardhat-abi-exporter";
 import "hardhat-contract-sizer";
@@ -15,9 +14,19 @@ import "solidity-coverage";
 
 dotenv.config();
 
+function getEnvVarNumber(name: string, defaultValue: number): number {
+  const value = process.env[name];
+  if (value !== undefined) {
+    return parseInt(value);
+  }
+
+  return defaultValue;
+}
+
 const chainIds = {
   // local
   localhost: 31337,
+  dev: getEnvVarNumber("DEV_CHAIN_ID", 313371),
   // testnet
   goerli: 5,
   "optimism-goerli": 420,
@@ -48,7 +57,7 @@ task("accounts", "Prints the list of accounts", async (taskArgs, hre) => {
 });
 
 let deployPrivateKey = process.env.DEPLOYER_PRIVATE_KEY as string;
-if (!deployPrivateKey) {
+if (deployPrivateKey === undefined) {
   // default first account deterministically created by local nodes like `npx hardhat node` or `anvil`
   deployPrivateKey =
     "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80";
@@ -65,13 +74,14 @@ const alchemyKey = process.env.ALCHEMY_API_KEY as string;
  */
 function createTestnetConfig(
   network: keyof typeof chainIds,
-  url?: string
+  url?: string,
+  mnemonic?: string
 ): NetworkUserConfig {
-  if (!url) {
+  if (url === undefined) {
     url = `https://${network}.infura.io/v3/${infuraIdKey}`;
   }
   return {
-    accounts: [deployPrivateKey],
+    accounts: mnemonic ? { mnemonic } : [deployPrivateKey],
     chainId: chainIds[network],
     allowUnlimitedContractSize: true,
     url,
@@ -196,6 +206,13 @@ const config: HardhatUserConfig = {
     },
 
     localhost: createTestnetConfig("localhost", "http://localhost:8545"),
+    // dev is still a local chain but it's based on our dev environment
+    // with hardcoded deterministic addresses for deployed contracts
+    dev: createTestnetConfig(
+      "dev",
+      `http://${process.env.DEV_CHAIN_HOST ?? "127.0.0.1"}:8545`,
+      "test test test test test test test test test test test junk"
+    ),
     hardhat: {
       forking: {
         url: `${process.env.FORK_RPC_URL}`,
@@ -295,4 +312,4 @@ const config: HardhatUserConfig = {
   dodoc: dodoc,
 };
 
-export default config;
+export default config;

package.json

@@ -23,8 +23,8 @@
     "deploy-allo-settings": "pnpm hardhat run scripts/settings/deployAlloSettings.ts --network",
     "set-protocol-fee": "pnpm hardhat run scripts/settings/setProtocolFeeDetails.ts --network",
     "// project-registry-deploy-scripts": "echo '//-- Project Registry deploy Script --//'",
-    "deploy-project-registry": "yarn hardhat run scripts/projectRegistry/deployProjectRegistry.ts --network",
-    "upgrade-project-registry": "yarn hardhat run scripts/projectRegistry/upgradeProjectRegistry.ts --network",
+    "deploy-project-registry": "hardhat run scripts/projectRegistry/deployProjectRegistry.ts --network",
+    "upgrade-project-registry": "hardhat run scripts/projectRegistry/upgradeProjectRegistry.ts --network",
     "// progam-deploy-scripts": "echo '//-- Program deploy Script --//'",
     "deploy-program-factory": "pnpm hardhat run scripts/program/deployProgramFactory.ts --network",
     "deploy-program-implementation": "pnpm hardhat run scripts/program/deployProgramImplementation.ts --network",
@@ -61,6 +61,11 @@
     "link-direct-implementation": "pnpm hardhat run scripts/payoutStrategy/direct/linkDirectPayoutStrategyImplementation.ts --network",
     "create-direct-contract": "pnpm hardhat run scripts/payoutStrategy/direct/createDirectPayoutStrategy.ts --network"
   },
+  "pnpm": {
+    "overrides": {
+      "node-hid": "^2"
+    }
+  },
   "devDependencies": {
     "@ethersproject/constants": "^5.7.0",
     "@gnosis.pm/safe-contracts": "^1.3.0",