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)
  • func (depContainers *DepsContainers) DevnetEndpoint(ctx context.Context, protocol string) (string, error)
  • func (depContainers *DepsContainers) DevnetLogs(ctx context.Context) (io.ReadCloser, error)
  • func (depContainers *DepsContainers) PostgresEndpoint(ctx context.Context, protocol string) (string, error)
  • func (depContainers *DepsContainers) PostgresLogs(ctx context.Context) (io.ReadCloser, error)
• type DevnetConfig
• type PostgresConfig

Constants

const (
	DefaultPostgresDatabase              = "postgres"
	DefaultPostgresDockerImage           = "postgres:16-alpine"
	DefaultPostgresPort                  = "5432"
	DefaultPostgresUser                  = "postgres"
	DefaultPostgresPassword              = "password"
	DefaultDevnetDockerImage             = "cartesi/rollups-node-devnet:devel"
	DefaultDevnetPort                    = "8545"
	DefaultDevnetBlockTime               = "1"
	DefaultDevnetBlockToWaitForOnStartup = "21"
	DefaultDevnetNoMining                = false
)

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 {
	Postgres *PostgresConfig
	Devnet   *DevnetConfig
}

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

func (*DepsContainers) DevnetEndpoint

func (depContainers *DepsContainers) DevnetEndpoint(
	ctx context.Context,
	protocol string,
) (string, error)

func (*DepsContainers) DevnetLogs

func (depContainers *DepsContainers) DevnetLogs(ctx context.Context) (io.ReadCloser, error)

func (*DepsContainers) PostgresEndpoint

func (depContainers *DepsContainers) PostgresEndpoint(
	ctx context.Context,
	protocol string,
) (string, error)

func (*DepsContainers) PostgresLogs

func (depContainers *DepsContainers) PostgresLogs(ctx context.Context) (io.ReadCloser, error)

type DevnetConfig

type DevnetConfig struct {
	DockerImage             string
	Port                    string
	BlockTime               string
	BlockToWaitForOnStartup string
	NoMining                bool
}

type PostgresConfig

type PostgresConfig struct {
	DockerImage string
	Port        string
	Password    string
}