Sphinx-Tribes Backend

Sphinx-Tribes is a decentralized message broker for public groups within the Sphinx ecosystem. This README covers the setup and configuration of the Sphinx-Tribes backend.

Table of Contents

• Prerequisites
• Setup
  • Cloning the Repository
  • Building the Docker Image
  • Environment Configuration
  • Database Setup
  • Running the Backend
• Optional Features
  • Redis for Caching
  • Relay Integration
  • Meme Image Upload
  • SuperAdmin Dashboard Access
  • Stakwork YouTube Integration
• Testing and Mocking
  • Unit Testing
  • Mocking Interfaces
• Backend API Data Validations
• API Documentation
• Contributing
• License

Prerequisites

• Docker
• Go language environment
• PostgreSQL database
• Redis instance (optional)
• Relay server access (optional)

Setup

Cloning the Repository

Clone the Sphinx-Tribes repository:

git clone https://github.com/Vayras/sphinx-tribes.git

Building the Docker Image

Navigate to the cloned directory and build the Docker image:

docker build --no-cache -t sphinx-tribes .
docker tag sphinx-tribes sphinxlightning/sphinx-tribes:x
docker push sphinxlightning/sphinx-tribes:x

Environment Configuration

Create a .env file in the project root with the required environment variables.

Database Setup

Set up a PostgreSQL database and execute the provided SQL scripts to create necessary tables.

Running the Backend

Build and run the Golang backend:

go build .
./sphinx-tribes

Optional Features

Redis for Caching

Configure Redis by adding the REDIS_URL or other relevant variables to your .env file.

    RDS_HOSTNAME =
    RDS_PORT =
    RDS_DB_NAME =
    RDS_USERNAME =
    RDS_PASSWORD =

Relay Integration

For invoice creation and keysend payment, add RELAY_URL and RELAY_AUTH_KEY.

Meme Image Upload

Requires a running Relay. Enable it with MEME_URL.

SuperAdmin Dashboard Access

Add public keys to SUPER_ADMINS in your .env file.

Stakwork YouTube Integration

Add STAKWORK_KEY for YouTube video downloads.

Testing and Mocking

Unit Testing

Run unit tests with coverage:

• Have Docker installed on your machine
• Run Docker
• Spin up a Postgres DB container before the test with this command docker compose -f docker/testdb-docker-compose.yml -p test_db up -d
• Change the rdHost rdsHost := "172.17.0.1" variable value in db/test_config.go to your 127.0.0.1

    // you may need to install cover with this command first
    go get golang.org/x/tools/cmd/cover
    // run test
    RELAY_AUTH_KEY=TEST go test ./... -tags mock -race -v -coverprofile=coverage.out && ./cover-check.sh coverage.out <min coverage amount>
    // To get code coverage in html format do the following after running the code above
    go tool cover -html="coverage.out"

• Drop the Postgres DB container after the test with this command docker compose -f docker/testdb-docker-compose.yml -p test_db down
• Change the rdHost variable value in db/test_config.go to the default value for github workflow rdsHost := "172.17.0.1"

Mocking Interfaces

Use mockery for interface mocking.

Installing mockery

There are multiple options to install mockery. Use any one of the following to download.

Download the mockery binary

Use the release page link mockery releases to download the artifact for your respective device.

Using go install

If you have go already installed on your device you can use the go install command to download mockery.

go install github.com/vektra/mockery/[email protected]

Using homebrew

If you are on mac you can use homebrew to download mockery

brew install mockery
brew upgrade mockery

When adding a new function to the interface which is already mocked follow the below steps

1. Update the corresponding interface with the function signature, for example if you are adding new function to the database structure make sure the interface file db/interface.go is updated with the function signature.
2. run the command mockery to update the mocks.

To create mocks for a new interface make follow the steps below

1. Add the new entry in the .mockery.yml file like this

with-expecter: true
dir: "mocks"
packages:
    github.com/stakwork/sphinx-tribes/db:
        interfaces:
            Database:
    github.com/stakwork/sphinx-tribes/*your-package-name*:
        interfaces:
            *your-interface-1*:
            *your-interface-2*:

2. run the command mockery to update the mocks.

Backend API Data Validations

We are currently using gopkg.in/go-playground/validator.v9 for validation, to validate a struct add the validate property to it

type Workspace struct {
  Name        string     `gorm:"unique;not null" json:"name" validate:"required"`
  Website     string     `json:"website" validate:"omitempty,uri"`
  Github      string     `json:"github" validate:"omitempty,uri"`
  Description string     `json:"description" validate:"omitempty,lte=200"`
}

Then handle the validation errors in the request handler

err = db.Validate.Struct(org)
if err != nil {
  w.WriteHeader(http.StatusBadRequest)
  msg := fmt.Sprintf("Error: did not pass validation test : %s", err)
  json.NewEncoder(w).Encode(msg)
  return
}

API Documentation

We use swaggo for generating Swagger documentation from Go annotations.

Installing Swaggo CLI

To install the swaggo CLI tool, run the following command:

# Using go install
go install github.com/swaggo/swag/cmd/swag@latest

After installation, verify that the CLI is working correctly:

swag -v

Generating API Documentation

Initialize and update the Swagger docs with:

swag init -g main.go

This will parse your Go code comments and generate documentation in the docs directory.

To format your Swagger annotations for better readability and consistency:

swag fmt

Writing Documentation for Handlers

Swaggo uses special annotations in your code comments to generate documentation. Here's how to document a handler:

// CreateUser 
//
// @Summary Create a new user
// @Description Create a new user with the provided information
// @Tags users
// @Accept json
// @Produce json
// @Param user body UserRequest true "User details"
// @Success 200 {object} UserResponse
// @Failure 400 {object} ErrorResponse
// @Failure 500 {object} ErrorResponse
// @Router /users [post]
func (h *Handler) CreateUser(w http.ResponseWriter, r *http.Request) {
    // Handler implementation
}

Common annotations:

• @Summary: Short summary of what the endpoint does
• @Description: Longer description of the endpoint
• @Tags: Group the endpoint under a tag
• @Accept: Accepted MIME types (e.g., json, xml)
• @Produce: Response MIME types
• @Param: Parameters (format: name, type, data type, required, description)
• @Success: Success response with HTTP code and response model
• @Failure: Error response with HTTP code and response model
• @Router: URL path and HTTP method

For struct documentation:

// UserRequest represents the request body for creating or updating a user
// swagger:model
type UserRequest struct {
    Name     string `json:"name" example:"John Doe"`    // User's full name
    Email    string `json:"email" example:"[email protected]"` // User's email address
    Password string `json:"password" example:"secret123"` // User's password
}

Viewing the Documentation

After generating the docs, you can view them by accessing the Swagger UI at /docs/index.html when your server is running.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the [LICENSE NAME] - see the LICENSE.md file for details.