deps

Documentation

Overview

Package deps provides mechanisms to run Node dependencies using docker

Index

• Constants
• func Terminate(ctx context.Context, depContainers *DepsContainers) error
• type DepsConfig
  • func NewDefaultDepsConfig() *DepsConfig
• type DepsContainers
  • func Run(ctx context.Context, depsConfig DepsConfig) (*DepsContainers, error)

Constants

const (
	DefaultPostgresDockerImage = "postgres:16-alpine"
	DefaultPostgresPort        = "5432"
	DefaultPostgresPassword    = "password"
	DefaultDevnetDockerImage   = "cartesi/rollups-devnet:devel"
	DefaultDevnetPort          = "8545"
)

Functions

func Terminate

func Terminate(ctx context.Context, depContainers *DepsContainers) error

Terminate terminates all dependencies containers. This method waits for all the containers to terminate or gives an error if it fails to terminate one of the containers

Types

type DepsConfig

type DepsConfig struct {
	PostgresDockerImage string
	PostgresPort        string
	PostgresPassword    string
	DevnetDockerImage   string
	DevnetPort          string
}

Struct to hold Node dependencies containers configurations

func NewDefaultDepsConfig

func NewDefaultDepsConfig() *DepsConfig

Builds a DepsConfig struct with default values

type DepsContainers

type DepsContainers struct {
	// contains filtered or unexported fields
}

Struct to represent the Node dependencies containers

func Run

func Run(ctx context.Context, depsConfig DepsConfig) (*DepsContainers, error)

Run starts the Node dependencies containers. The returned DepContainers struct can be used to gracefully terminate the containers using the Terminate method