Merge pull request #18 from keep-starknet-strange/refactor-for-contri…

…butors

Refactor and Docker integration

.gitignore

@@ -20,8 +20,9 @@ node_modules/
 # Development
 **/TODO
 
-# TODO
 # Frontend
+build/
+node_modules/
 
 # Backend
 art-peace-backend

Makefile

@@ -1,17 +1,15 @@
-#TODO: setup all, list dependencies, etc
-
-build: backend-build frontend-build contracts-build
+build: build-backend build-frontend build-contracts
 test: contracts-test
 
-backend-build:
+build-backend:
 	@echo "Building backend..."
 	@cd backend && go build
 
-frontend-build:
+build-frontend:
 	@echo "Building frontend..."
 	@cd frontend && npm run build
 
-contracts-build:
+build-contracts:
 	@echo "Building contracts..."
 	@cd onchain && scarb build
 

README.md

@@ -12,35 +12,89 @@
 
 ## Overview
 
-`art/peace` is a collaborative art game where users can place pixels on a large canvas and receive rewards for collaborating. The app will run over X days, and end with a final snapshot of the board. The goal is to give users the feeling of collectively building on a highly responsive art canvas, which they can explore, interact with, and compete on.
+`art/peace` is a collaborative art game where users can place pixels on a large shared canvas and receive rewards for collaborating to build art. The game will run over X days, and end with a final snapshot of the board. The goal is to give users the feeling of collectively building on a highly responsive art canvas, which they can explore, interact with, and compete on.
 
 Some of the features include :
 
-- **Placing Pixels** : This will be the main interaction type, where every X minutes a user will be allowed to place a pixel onto the canvas. ( on-chain interaction )
-- **Color Voting** : In addition to the base colors, there will be a vote to add new colors to the palette every day. ( on-chain interaction )
-- **Quests** : Tasks to get extra pixels to place on-top of the one every X minutes. ( on-chain interaction )
-- **Templates** : Overlayable artworks to help communities collaborate on an art piece. Bounties can be added to a template to incentivize creation. ( off-chain interaction until settling )
+- **Placing Pixels** : This will be the main user interaction, where every X minutes a user will be allowed to place a pixel onto the canvas.
+- **Quests** : Tasks to get extra pixels to place on-top of the one every X minutes.
+- **Voting** : In addition to the base colors, there will be a vote to add new colors to the palette every day.
+- **Templates** : Artwork templates used to help communities collaborate on an art piece. Bounties can be added to a template to incentivize creation.
+- **NFTs** : Mint NFTs from the canvas.
 
-## References
+## Running
 
-- [r/place technical document](https://www.redditinc.com/blog/how-we-built-rplace)
+### Docker Run ( Recommended )
 
-## Build
+```bash
+docker compose up
+```
+
+To stop the run use `Ctrl-C`.
 
-To build the project, run:
+For a complete reset of the state and rebuild of the containers use :
 
 ```bash
-scarb build
+# WARNING! This will clear the state (volumes) of all the DBs and the Devnet
+docker compose down --volumes
+docker compose build
 ```
 
-## Test
+### Local Run
+
+```bash
+# Must install all the dependencies first
+# Change the user on `configs/database.config.json` for postgres
+make integration-test-local
+```
+
+To stop the run use `Ctrl-C`.
+
+### Component Run
+
+Each component can also be run individually, check the [Components](#Components) section below for more details.
+
+## Build
+
+### Docker Build ( Recommended )
 
-To test the project, run ( uses `snforge` ):
+```bash
+docker compose build
+```
+
+### Local Build
 
 ```bash
-scarb test
+make build
 ```
 
+### Component Build
+
+Use the `make build-X` command for each corresponding component `X`. See the [Components](#Components) section below for more details.
+
+## Components
+
+- **Onchain:** [Starknet contract(s)](./onchain/) for trustless onchain interactions.
+- **Backend:** [Monolithic Go backend](./backend/) for managing requests, interactions, and DBs.
+- **Frontend:** [Reactjs application](./frontend/) for users to interact with.
+- **Indexer:** [Apibara indexer](./indexer/) for monitoring Starknet events and forwarding to the DBs.
+- **Postgres:** DB for storing general data used for analytics, frontend, and backend.
+- **Redis:** In memory DB used to store the compressed `Canvas` data for fast retrieval
+- **tests:** Integration tests for local, docker, ...
+
+![art/peace diagram](./docs/diagrams/art-peace-diagram.png)
+
+## Dependencies
+
+Its recommended to use `docker compose` when building and running, so the only dependencies would be [docker](https://docs.docker.com/desktop/) and [docker compose](https://docs.docker.com/compose/install/linux/)
+
+However, it might be worth running only certain components for development/testing sometimes. Each component has various dependencies, check [dependencies.txt](./dependencies.txt) for more details.
+
+## References
+
+- [Diagrams](./docs/diagrams/)
+- [r/place technical document](https://www.redditinc.com/blog/how-we-built-rplace)
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people. Follow the [contributors guide](https://github.com/keep-starknet-strange/art-peace/blob/main/CONTRIBUTING.md) if you'd like to take part.

backend/Dockerfile

@@ -0,0 +1,35 @@
+FROM golang:1.21.7-alpine
+# TODO: Add psql to the image?
+# TODO: depends on in docker compose?
+
+RUN apk add --no-cache bash curl git jq
+
+SHELL ["/bin/bash", "-c"]
+RUN curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | bash -s -- -v 2.6.3
+RUN curl -L https://raw.githubusercontent.com/foundry-rs/starknet-foundry/master/scripts/install.sh | bash
+# TODO: Source not working properly & requiring manual /root/.local/bin/ paths
+RUN source /root/.profile
+RUN /bin/bash /root/.local/bin/snfoundryup --version 0.20.0
+
+# Copy over the configs
+WORKDIR /configs
+COPY ./configs/ .
+COPY ./configs/docker-database.config.json ./database.config.json
+COPY ./configs/docker-backend.config.json ./backend.config.json
+
+# Copy over the scripts
+WORKDIR /scripts
+COPY ./tests/integration/docker/ .
+
+# Copy over the app
+WORKDIR /app
+COPY ./backend/go.mod ./backend/go.sum ./
+RUN go mod download
+COPY ./backend .
+
+# Build the app & run it
+RUN go build -o main .
+
+EXPOSE 8080
+
+CMD ["./main"]

backend/README.md

@@ -0,0 +1,16 @@
+# art/peace Backend
+
+This directory contains the Go backend for `art/peace`, which provides routes for managing and retrieving `art/peace` info from the Redis and Postgres DBs. Also contains other utilities to do things like get the contract address, use devnet transaction invoke scripts for easy devnet testing, maintain websocket connections for pixel updates, and more.
+
+## Running
+
+```
+go run main.go
+```
+
+## Build
+
+```
+go mod download
+go build
+```

backend/backend/backend.go

@@ -14,20 +14,20 @@ type Backend struct {
   WSConnections []*websocket.Conn
 
   CanvasConfig *config.CanvasConfig
-  Port int
+  BackendConfig *config.BackendConfig
 }
 
 var ArtPeaceBackend *Backend
 
-func NewBackend(databases *Databases, canvasConfig *config.CanvasConfig, port int) *Backend {
+func NewBackend(databases *Databases, canvasConfig *config.CanvasConfig, backendConfig *config.BackendConfig) *Backend {
   return &Backend{
     Databases: databases,
     CanvasConfig: canvasConfig,
-    Port: port,
+    BackendConfig: backendConfig,
   }
 }
 
 func (b *Backend) Start() {
-  fmt.Println("Listening on port", b.Port)
-  http.ListenAndServe(fmt.Sprintf(":%d", b.Port), nil)
+  fmt.Println("Listening on port", b.BackendConfig.Port)
+  http.ListenAndServe(fmt.Sprintf(":%d", b.BackendConfig.Port), nil)
 }

backend/backend/databases.go

@@ -2,6 +2,7 @@ package backend
 
 import (
 	"context"
+	"os"
 	"strconv"
 
 	"github.com/jackc/pgx/v5"
@@ -29,7 +30,7 @@ func NewDatabases(databaseConfig *config.DatabaseConfig) *Databases {
   })
 
   // Connect to Postgres
-  postgresConnString := "postgresql://" + databaseConfig.Postgres.User + "@" + databaseConfig.Postgres.Host + ":" + strconv.Itoa(databaseConfig.Postgres.Port) + "/" + databaseConfig.Postgres.Database
+  postgresConnString := "postgresql://" + databaseConfig.Postgres.User + ":" + os.Getenv("POSTGRES_PASSWORD") + "@" + databaseConfig.Postgres.Host + ":" + strconv.Itoa(databaseConfig.Postgres.Port) + "/" + databaseConfig.Postgres.Database
   pgConn, err := pgx.Connect(context.Background(), postgresConnString)
   if err != nil {
     panic(err)

backend/config/backend.go

@@ -0,0 +1,45 @@
+package config
+
+import (
+	"encoding/json"
+	"os"
+)
+
+type BackendScriptsConfig struct {
+  PlacePixelDevnet string `json:"place_pixel_devnet"`
+  AddTemplateHashDevnet string `json:"add_template_hash_devnet"`
+}
+
+type BackendConfig struct {
+  Host string `json:"host"`
+  Port int `json:"port"`
+  Scripts BackendScriptsConfig `json:"scripts"`
+}
+
+var DefaultBackendConfig = BackendConfig{
+  Host: "localhost",
+  Port: 8080,
+  Scripts: BackendScriptsConfig{
+    PlacePixelDevnet: "../scripts/place_pixel.sh",
+    AddTemplateHashDevnet: "../scripts/add_template_hash.sh",
+  },
+}
+
+var DefaultBackendConfigPath = "../configs/backend.config.json"
+
+func LoadBackendConfig(backendConfigPath string) (*BackendConfig, error) {
+  file, err := os.Open(backendConfigPath)
+  if err != nil {
+    return nil, err
+  }
+  defer file.Close()
+
+  decoder := json.NewDecoder(file)
+  config := BackendConfig{}
+  err = decoder.Decode(&config)
+  if err != nil {
+    return nil, err
+  }
+
+  return &config, nil
+}

backend/config/database.go

@@ -30,8 +30,7 @@ var DefaultDatabaseConfig = DatabaseConfig{
   Postgres: PostgresConfig{
     Host: "localhost",
     Port: 5432,
-    // TODO: Add non-hardcoded default user
-    User: "brandonroberts",
+    User: "art-peace-user",
     Database: "art-peace-db",
   },
 }

backend/main.go

@@ -11,7 +11,7 @@ import (
 func main() {
 	canvasConfigFilename := flag.String("canvas-config", config.DefaultCanvasConfigPath, "Canvas config file")
 	databaseConfigFilename := flag.String("database-config", config.DefaultDatabaseConfigPath, "Database config file")
-  port := flag.Int("port", 8080, "Port to listen on")
+  backendConfigFilename := flag.String("backend-config", config.DefaultBackendConfigPath, "Backend config file")
 	flag.Parse()
 
 	canvasConfig, err := config.LoadCanvasConfig(*canvasConfigFilename)
@@ -24,11 +24,16 @@ func main() {
 		panic(err)
 	}
 
+  backendConfig, err := config.LoadBackendConfig(*backendConfigFilename)
+  if err != nil {
+    panic(err)
+  }
+
   databases := backend.NewDatabases(databaseConfig)
 	defer databases.Close()
 
   routes.InitRoutes()
 
-  backend.ArtPeaceBackend = backend.NewBackend(databases, canvasConfig, *port)
+  backend.ArtPeaceBackend = backend.NewBackend(databases, canvasConfig, backendConfig)
   backend.ArtPeaceBackend.Start()
 }

backend/routes/contract.go

@@ -0,0 +1,29 @@
+package routes
+
+import (
+	"io/ioutil"
+	"net/http"
+	"os"
+)
+
+func InitContractRoutes() {
+  http.HandleFunc("/getContractAddress", getContractAddress)
+  http.HandleFunc("/setContractAddress", setContractAddress)
+}
+
+func getContractAddress(w http.ResponseWriter, r *http.Request) {
+  contractAddress := os.Getenv("ART_PEACE_CONTRACT_ADDRESS")
+  w.Write([]byte(contractAddress))
+}
+
+func setContractAddress(w http.ResponseWriter, r *http.Request) {
+  // TODO: Add authentication
+  data, err := ioutil.ReadAll(r.Body)
+  if err != nil {
+    w.WriteHeader(http.StatusBadRequest)
+    w.Write([]byte("Invalid request"))
+    return
+  }
+  os.Setenv("ART_PEACE_CONTRACT_ADDRESS", string(data))
+  w.Write([]byte("Contract address set successfully"))
+}

backend/routes/indexer.go

@@ -76,6 +76,7 @@ func consumeIndexerMsg(w http.ResponseWriter, r *http.Request) {
   address := reqBody["data"].(map[string]interface{})["batch"].([]interface{})[0].(map[string]interface{})["events"].([]interface{})[0].(map[string]interface{})["event"].(map[string]interface{})["keys"].([]interface{})[1]
   address = address.(string)[2:]
   posHex := reqBody["data"].(map[string]interface{})["batch"].([]interface{})[0].(map[string]interface{})["events"].([]interface{})[0].(map[string]interface{})["event"].(map[string]interface{})["keys"].([]interface{})[2]
+  dayIdxHex := reqBody["data"].(map[string]interface{})["batch"].([]interface{})[0].(map[string]interface{})["events"].([]interface{})[0].(map[string]interface{})["event"].(map[string]interface{})["keys"].([]interface{})[3]
   colorHex := reqBody["data"].(map[string]interface{})["batch"].([]interface{})[0].(map[string]interface{})["events"].([]interface{})[0].(map[string]interface{})["event"].(map[string]interface{})["data"].([]interface{})[0]
 
   // Convert hex to int
@@ -85,6 +86,12 @@ func consumeIndexerMsg(w http.ResponseWriter, r *http.Request) {
     w.WriteHeader(http.StatusInternalServerError)
     return
   }
+  dayIdx, err := strconv.ParseInt(dayIdxHex.(string), 0, 64)
+  if err != nil {
+    fmt.Println("Error converting day index hex to int: ", err)
+    w.WriteHeader(http.StatusInternalServerError)
+    return
+  }
   color, err := strconv.ParseInt(colorHex.(string), 0, 64)
   if err != nil {
     fmt.Println("Error converting color hex to int: ", err)
@@ -105,7 +112,12 @@ func consumeIndexerMsg(w http.ResponseWriter, r *http.Request) {
   }
 
   // Set pixel in postgres
-  _, err = backend.ArtPeaceBackend.Databases.Postgres.Exec(context.Background(), "INSERT INTO Pixels (address, position, color) VALUES ($1, $2, $3)", address, position, color)
+  _, err = backend.ArtPeaceBackend.Databases.Postgres.Exec(context.Background(), "INSERT INTO Pixels (address, position, day, color) VALUES ($1, $2, $3, $4)", address, position, dayIdx, color)
+  if err != nil {
+    fmt.Println("Error inserting pixel into postgres: ", err)
+    w.WriteHeader(http.StatusInternalServerError)
+    return
+  }
 
   // Send message to all connected clients
   var message = map[string]interface{}{