change user facing names

Author: binocarlos

Dockerfile.api

@@ -0,0 +1,12 @@
+FROM golang:1.20-alpine
+WORKDIR /app
+RUN apk add --no-cache bash
+COPY go.mod go.sum ./
+RUN go mod download
+COPY cmd ./cmd
+COPY pkg ./pkg
+COPY main.go .
+WORKDIR /app
+RUN go build -o /gdcn
+EXPOSE 80
+ENTRYPOINT [ "/gdcn" ]

README.md

@@ -115,7 +115,7 @@ wget https://github.com/bacalhau-project/bacalhau/releases/download/v1.0.3/bacal
 tar xfv bacalhau_v1.0.3_linux_amd64.tar.gz
 mv bacalhau /usr/local/bin
 # Set the IPFS data path by exporting the `BACALHAU_SERVE_IPFS_PATH` variable to your desired location
-export BACALHAU_SERVE_IPFS_PATH=/tmp/lilypad/data/ipfs
+export BACALHAU_SERVE_IPFS_PATH=/tmp/gdcn/data/ipfs
 ```
 
 #### clone faucet repo
@@ -175,6 +175,12 @@ Run the following commands in separate terminal windows:
 ./stack solver
 ```
 
+**NOTE** if you want to run the SAAS layer then we need to run the solver on the docker bridge as follows:
+
+```bash
+./stack solver --server-url http://172.17.0.1:8080
+```
+
 #### mediator
 
 Wait for the solver to start when `🟡 SOL solver registered` is logged, and then, in another terminal window, run:
@@ -213,6 +219,25 @@ Otherwise, if you don't have a GPU:
 ./stack resource-provider
 ```
 
+### run saas
+
+The generic-dcn repo also comes with a saas layer that can be used as a web2 layer to the underlying web3 stack.
+
+The api will run using a `WEB3_PRIVATE_KEY` and essentially act as a job creator on behalf of registered users.
+
+This means you can open up your decentralized compute network to a wider audience who might not have access to metamask or other web3 tools.
+
+Once the core network is up and running as described above, you can run the saas layer as follows:
+
+**NOTE** it's important that you started the solver using the `./stack solver --server-url http://172.17.0.1:8080` command as described above.
+
+```bash
+docker-compose build
+docker-compose up -d
+```
+
+Now you should be able to access the saas layer using http://localhost
+
 ### run faucet
 
 To run the faucet container so you can test with other user accounts:
@@ -447,6 +472,18 @@ You can now start and stop the various services using `systemd` and see logs usi
 
 Make sure you start the solver first.
 
+### running the saas layer
+
+To run the saas layer in production it's important to use another machine than the solver so the saas api can speak to the solver using it's public http(s) endpoint.
+
+To run the various services there are a few options:
+
+ * use the `docker-compose.yaml` file but change some values
+ * run the various services using another tool like k8s (they are all docker based services)
+ * run the various services using systemd
+
+We have left this choice to the reader as it depends on the environment you are deploying to.
+
 ## troubleshooting
 
 ### receive buffer size error

cmd/gdcn/jobcreator.go

@@ -13,8 +13,8 @@ func newJobCreatorCmd() *cobra.Command {
 
 	solverCmd := &cobra.Command{
 		Use:     "jobcreator",
-		Short:   "Start the lilypad job creator service.",
-		Long:    "Start the lilypad job creator service.",
+		Short:   "Start the gdcn job creator service.",
+		Long:    "Start the gdcn job creator service.",
 		Example: "",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			options, err := optionsfactory.ProcessOnChainJobCreatorOptions(options, args)

cmd/gdcn/mediator.go

@@ -15,8 +15,8 @@ func newMediatorCmd() *cobra.Command {
 
 	mediatorCmd := &cobra.Command{
 		Use:     "mediator",
-		Short:   "Start the lilypad mediator service.",
-		Long:    "Start the lilypad mediator service.",
+		Short:   "Start the gdcn mediator service.",
+		Long:    "Start the gdcn mediator service.",
 		Example: "",
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			options, err := optionsfactory.ProcessMediatorOptions(options)

cmd/gdcn/resource-provider.go

@@ -14,8 +14,8 @@ func newResourceProviderCmd() *cobra.Command {
 
 	resourceProviderCmd := &cobra.Command{
 		Use:     "resource-provider",
-		Short:   "Start the lilypad resource-provider service.",
-		Long:    "Start the lilypad resource-provider service.",
+		Short:   "Start the gdcn resource-provider service.",
+		Long:    "Start the gdcn resource-provider service.",
 		Example: "",
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			options, err := optionsfactory.ProcessResourceProviderOptions(options)

cmd/gdcn/root.go

@@ -16,15 +16,15 @@ func init() { //nolint:gochecknoinits
 func NewRootCmd() *cobra.Command {
 	RootCmd := &cobra.Command{
 		Use:   getCommandLineExecutable(),
-		Short: "Lilypad",
-		Long:  `Lilypad`,
+		Short: "Generic Decentralized Compute Network",
+		Long:  `Generic Decentralized Compute Network`,
 	}
 	RootCmd.AddCommand(newSolverCmd())
 	RootCmd.AddCommand(newResourceProviderCmd())
 	RootCmd.AddCommand(newRunCmd())
 	RootCmd.AddCommand(newMediatorCmd())
 	RootCmd.AddCommand(newJobCreatorCmd())
-	RootCmd.AddCommand(newVersionCmd())
+	RootCmd.AddCommand(newSaasApiCmd())
 	return RootCmd
 }
 

cmd/gdcn/run.go

@@ -22,8 +22,8 @@ func newRunCmd() *cobra.Command {
 	options := optionsfactory.NewJobCreatorOptions()
 	runCmd := &cobra.Command{
 		Use:     "run",
-		Short:   "Run a job on the Lilypad network.",
-		Long:    "Run a job on the Lilypad network.",
+		Short:   "Run a job on the Generic Decentralized Compute network.",
+		Long:    "Run a job on the Generic Decentralized Compute network.",
 		Example: "run cowsay:v0.0.1 -i Message=moo",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			options, err := optionsfactory.ProcessJobCreatorOptions(options, args)
@@ -42,18 +42,9 @@ func newRunCmd() *cobra.Command {
 func runJob(cmd *cobra.Command, options jobcreator.JobCreatorOptions) error {
 	c := color.New(color.FgCyan).Add(color.Bold)
 	c.Print(`
-⠀⠀⠀⠀⠀⠀⣀⣤⣤⢠⣤⣀⠀⠀⠀⠀⠀
-⠀⠀⠀⠀⢴⣿⣿⣿⣿⢸⣿⡟⠀⠀⠀⠀⠀    ██╗     ██╗██╗  ██╗   ██╗██████╗  █████╗ ██████╗ 
-⠀⠀⣰⣿⣦⡙⢿⣿⣿⢸⡿⠀⠀⠀⠀⢀⠀    ██║     ██║██║  ╚██╗ ██╔╝██╔══██╗██╔══██╗██╔══██╗
-⠀⢰⣿⣿⣿⣿⣦⡙⣿⢸⠁⢀⣠⣴⣾⣿⡆    ██║     ██║██║   ╚████╔╝ ██████╔╝███████║██║  ██║
-⠀⣛⣛⣛⣛⣛⣛⣛⠈⠀⣚⣛⣛⣛⣛⣛⣛    ██║     ██║██║    ╚██╔╝  ██╔═══╝ ██╔══██║██║  ██║
-⠀⢹⣿⣿⣿⣿⠟⣡⣿⢸⣮⡻⣿⣿⣿⣿⡏    ███████╗██║███████╗██║   ██║     ██║  ██║██████╔╝
-⠀⠀⢻⣿⡟⣩⣾⣿⣿⢸⣿⣿⣌⠻⣿⡟⠀    ╚══════╝╚═╝╚══════╝╚═╝   ╚═╝     ╚═╝  ╚═╝╚═════╝ v2
-⠀⠀⠀⠉⢾⣿⣿⣿⣿⢸⣿⣿⣿⡷⠈⠀⠀                                                  
-⠀⠀⠀⠀⠀⠈⠙⠛⠛⠘⠛⠋⠁⠀ ⠀⠀⠀   Decentralized Compute Network  https://lilypad.tech
-
+Generic Decentralized Compute Network https://github.com/bacalhau-project/generic-dcn
 `)
-	spinner, err := createSpinner("Lilypad submitting job", "🌟")
+	spinner, err := createSpinner("Generic Decentralized Compute Network submitting job", "🌟")
 	if err != nil {
 		fmt.Printf("failed to make spinner from config struct: %v\n", err)
 		os.Exit(1)
@@ -133,7 +124,7 @@ func runJob(cmd *cobra.Command, options jobcreator.JobCreatorOptions) error {
 		return err
 	}
 	spinner.Stop()
-	fmt.Printf("\n🍂 Lilypad job completed, try 👇\n    open %s\n    cat %s/stdout\n    cat %s/stderr\n    https://ipfs.io/ipfs/%s\n",
+	fmt.Printf("\n🍂 Generic Decentralized Compute Network job completed, try 👇\n    open %s\n    cat %s/stdout\n    cat %s/stderr\n    https://ipfs.io/ipfs/%s\n",
 		solver.GetDownloadsFilePath(result.JobOffer.DealID),
 		solver.GetDownloadsFilePath(result.JobOffer.DealID),
 		solver.GetDownloadsFilePath(result.JobOffer.DealID),

cmd/gdcn/saas-api.go

@@ -58,11 +58,11 @@ func NewAllOptions() *AllOptions {
 	}
 }
 
-func newServeCmd() *cobra.Command {
+func newSaasApiCmd() *cobra.Command {
 	allOptions := NewAllOptions()
 
 	serveCmd := &cobra.Command{
-		Use:     "serve",
+		Use:     "saas-api",
 		Short:   "Start the lilysaas api server.",
 		Long:    "Start the lilysaas api server.",
 		Example: "TBD",

cmd/gdcn/solver.go

@@ -14,8 +14,8 @@ func newSolverCmd() *cobra.Command {
 
 	solverCmd := &cobra.Command{
 		Use:     "solver",
-		Short:   "Start the lilypad solver service.",
-		Long:    "Start the lilypad solver service.",
+		Short:   "Start the Generic Decentralized Compute Network solver service.",
+		Long:    "Start the Generic Decentralized Compute Network solver service.",
 		Example: "",
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			options, err := optionsfactory.ProcessSolverOptions(options)

cmd/gdcn/version.go

@@ -61,7 +61,6 @@ services:
       context: .
       dockerfile: Dockerfile.api
     restart: always
-    env_file: .env
     environment:
       - LOG_LEVEL=debug
       - APP_URL=${SERVER_URL:-http://localhost}
@@ -79,11 +78,12 @@ services:
       - WEB3_CONTROLLER_ADDRESS=${WEB3_CONTROLLER_ADDRESS-0x59b670e9fA9D0A427751Af201D676719a970857b}
       # this is an insecure development key - do not use in production!
       - KEYCLOAK_TOKEN=${KEYCLOAK_TOKEN-5ca0fc03-d625-456e-bca7-8e732309165f}
-    entrypoint: ${API_ENTRYPOINT:-tail -f /dev/null}
+    entrypoint: ${API_ENTRYPOINT:-go run . saas-api}
     volumes:
       - ./go.mod:/app/go.mod
       - ./go.sum:/app/go.sum
-      - ./api:/app/api
+      - ./cmd:/app/cmd
+      - ./pkg:/app/pkg
   gradio:
     ports:
       - 7860:7860

docker-compose.yaml

@@ -5,7 +5,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta
       name="description"
-      content="Lilypad AI Studio"
+      content="Generic Decentralized Compute Network AI Studio"
     />
     <link rel="icon" href="/img/logo.png">
     <link
@@ -18,7 +18,7 @@
       href="https://fonts.googleapis.com/icon?family=Material+Icons"
     />
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/file-icon-vivid.min.css" />
-    <title>Lilypad AI Studio</title>
+    <title>Generic Decentralized Compute Network AI Studio</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

docs/images/saas.png

@@ -2,7 +2,7 @@ import React, { ReactElement } from 'react'
 import Box from '@mui/material/Box'
 import Typography from '@mui/material/Typography'
 
-const DEFAULT_THEME_NAME = 'lilypad'
+const DEFAULT_THEME_NAME = 'gdcn'
 
 export interface ITheme {
   company: string,
@@ -16,9 +16,9 @@ export interface ITheme {
 }
 
 export const THEMES: Record<string, ITheme> = {
-  lilypad: {
-    company: 'Lilypad',
-    url: 'https://lilypad.tech/',
+  gdcn: {
+    company: 'Generic Decentralized Compute Network',
+    url: 'https://github.com/bacalhau-project/generic-dcn',
     primary: '#14c7c3',
     secondary: '#fec284',
     activeSections: [],
@@ -31,7 +31,7 @@ export const THEMES: Record<string, ITheme> = {
         <Box
           component="img"
           src="/img/logo.png"
-          alt="Lilypad" 
+          alt="Generic Decentralized Compute Network" 
           sx={{
             height: 30,
             ml: 1,
@@ -41,15 +41,16 @@ export const THEMES: Record<string, ITheme> = {
           ml: 2,
           mr: 1,
         }}>
-          Lilypad AI Studio
+          Generic Decentralized Compute Network AI Studio
         </Typography>
       </Box>
     ),
   },
 }
 
+// if you want to use different themes for different domains then put them here:
 export const THEME_DOMAINS: Record<string, string> = {
-  'lilypad.tech': 'lilypad',
+  
 }
 
 

frontend/index.html

@@ -1,5 +1,5 @@
 {
-  "name": "lilypad",
+  "name": "gdcn",
   "version": "0.0.1",
   "license": "Apache-2.0",
   "scripts": {},

frontend/src/themes.tsx

@@ -11,5 +11,5 @@ func main() {
 }
 
 func init() {
-	fmt.Printf("Lilypad: %s\n", gdcn.VERSION)
+	fmt.Printf("GDCN\n")
 }