A collection of smart contracts for operating a DAO https://demo.dgov.io

Go to file

Ladd Hoffman 1e1686619d Gitea Actions Demo / Explore-Gitea-Actions (push) Failing after 40s Details attempt to fix batch ordering		2024-05-04 19:52:44 -05:00
.gitea/workflows	Frontend stub	2024-02-21 18:01:41 -06:00
backend	attempt to fix batch ordering	2024-05-04 19:52:44 -05:00
ethereum	sepolia deploy	2024-05-03 20:49:37 -05:00
frontend	sepolia deploy	2024-05-03 20:49:37 -05:00
README.md	project architecture documentation	2024-04-28 14:19:23 -05:00

README.md

DGF Prototype

Decentralized Governance Framework

Project Architecture

directory	description
ethereum	Solidity smart contracts and associated deploy scripts
backend	Node.js application with an HTTP API that also functions as a Matrix bot and Ethereum client
frontend	React.js frontend with a WebApp route and a Matrix Widget route

Data Flow Diagram

flowchart TD
    Blockchain <-- ethers --> API
    Blockchain <-- Web3<br>+ MetaMask --> WebApp
    Blockchain <-- Web3<br>+ MetaMask --> Widget
    WebApp <-- HTTPS --> API
    Widget <-- HTTPS --> API
    Widget <-- matrix-widget-api --> Matrix
    API <-- matrix-bot-sdk --> Matrix

Local development setup

Clone this repository to a directory on your machine

git clone https://gitea.dgov.io/DGF/dgf-prototype

Nginx

Install nginx
```
 brew install nginx
```
Install mkcert
```
 brew install mkcert
```
Install root CA
```
 mkcert -install
```
Create a certificate
```
 mkcert dgfprototype.dev
```
Create certificates directory
```
 sudo mkdir /etc/nginx/certs
```
Move the certificate to the certificates directory
```
 sudo mv dgfprototype.*.pem /etc/nginx/certs/
```

Add the following to the http section of /etc/nginx/nginx.conf

 map $http_upgrade $connection_upgrade {
     default upgrade;
     '' close;
 }

Add the following to a new file /etc/nginx/sites-available/dgfprototype_dev

 server {
         listen 443 ssl;

         server_name dgfprototype.dev;
         ssl_certificate     /etc/nginx/certs/dgfprototype.dev.pem;
         ssl_certificate_key /etc/nginx/certs/dgfprototype.dev-key.pem;

         location /api/ {
                 proxy_pass http://127.0.0.1:3003/;
         }

         location / {
                 proxy_pass http://127.0.0.1:3002/;
                 proxy_http_version 1.1;
                 proxy_set_header Upgrade $http_upgrade;
                 proxy_set_header Connection $connection_upgrade;
                 proxy_set_header Host $host;
         }
 }

Create a symbolic link in sites-enabled/

 sudo ln -s /etc/nginx/sites-available/dgfprototype_dev /etc/nginx/sites-enabled

Restart nginx

 sudo systemctl restart nginx

 sudo brew services restart nginx

Edit /etc/hosts to add the domain alias
```
 127.0.0.1  dgfprototype.dev
```

API

In a new terminal window, navigate to dgf-prototype/backend
Install the project
```
 npm install
```
Copy the example configuration file
```
 cp .env.example .env
```
Edit .env and set the following values
```
 PORT=3003
```
Create the data directory
```
 mkdir data
```
Run the daemon
```
 node src/index.js
```

Hardhat

In a new terminal window, navigate to dgf-prototype/ethereum
Install the project
```
 npm install
```
Copy the example configuration file
```
 cp .env.example .env
```
In .env, set a value for SEED_PHRASE or LOCAL_PRIVATE_KEY
Run a hardhat node
```
 npx hardhat node
```
In a separate terminal window, navigate again to dgf-prototype/ethereum
Build and deploy the contracts
```
 npm run deploy-local
```

Metamask

Install the Metamask extension in your browser
In the Metamask extension, click the list of networks in the top left, and click "Add Network"
At the bottom of the list of popular networks, click "Add a network manually"
- Network name: Hardhat local
- RPC URL: http://127.0.0.1:8545/
- Chain ID: 1337
- Currency symbol: ETH

Frontend

In a new terminal window, navigate to dgf-prototype/frontend
Install the project
```
 npm install
```
Install vite
```
 npm i -g vite
```
Run the development server
```
 vite dev
```
Now you should be able to open the site at https://dgfprototype.dev

To run automatic staking

Clone this repository to a directory on your machine

 git clone https://gitea.dgov.io/DGF/dgf-prototype

Change to the ethereum directory
```
 cd ethereum
```
Install the project using npm
```
 npm install
```
Copy the example configuration file
```
 cp .env.example .env
```
Export your Sepolia private key from MetaMask and add it to your .env file
```
 SEPOLIA_PRIVATE_KEY="YOURKEY"
```
Run the automatic staking script
```
 npm run automatic-staking-sepolia
```