core

README

Core

Core contains common libraries used across our Go repositories.

Documentation

Overview

Package core contains the core dependencies

Index

• Constants
• Variables
• func BytesToSlice(bytes [32]byte) []byte
• func CopyBigInt(val *big.Int) *big.Int
• func EnumScan(src interface{}) (uint8, error)
• func EnumValue(enum EnumInter) (driver.Value, error)
• func ExpandOrReturnPath(path string) string
• func GetEnv(name, defaultVal string) string
• func GetEnvInt(name string, defaultVal int) int
• func IsTest() bool
• func PtrTo[T any](v T) *T
• func RandomItem[T any](items []T) (res T, _ error)
• type Enum
• type EnumInter

Examples

• PtrTo

Constants

const EnumDataType = "integer"

EnumDataType is exported here to be passed as GormDataType.

Variables

var LogLevels = []zapcore.Level{zapcore.DebugLevel, zapcore.InfoLevel, zapcore.WarnLevel, zapcore.ErrorLevel, zapcore.DPanicLevel, zapcore.PanicLevel, zapcore.FatalLevel}

LogLevels stores available log levels in serverity order.

Functions

func BytesToSlice

func BytesToSlice(bytes [32]byte) []byte

BytesToSlice converts a 32 bit array to a slice slice.

func CopyBigInt

func CopyBigInt(val *big.Int) *big.Int

CopyBigInt creates a copy of a big int without mutating the original.

func EnumScan

func EnumScan(src interface{}) (uint8, error)

EnumScan converts the enum to a value. the returned uint 8 should be used. Note this should only be used for a non-nullable enum.

func EnumValue

func EnumValue(enum EnumInter) (driver.Value, error)

EnumValue converts the enum to a value.

func ExpandOrReturnPath

func ExpandOrReturnPath(path string) string

ExpandOrReturnPath expands a homedir path, if it can't be expanded, the original dir is returned since on these systems homedir cannot be used anyway.

func GetEnv

func GetEnv(name, defaultVal string) string

GetEnv gets an environment variable. If it is not present, the default variable is used.

func GetEnvInt

func GetEnvInt(name string, defaultVal int) int

GetEnvInt gets an environment variable as an int. if not found or cast the defaultVal is returned.

func IsTest

func IsTest() bool

IsTest returns true if the current process is a test.

func PtrTo

func PtrTo[T any](v T) *T

PtrTo returns a pointer to the given value.

Example

package main

import (
	"fmt"
	"github.com/ethereum/go-ethereum/common"
	"github.com/synapsecns/sanguine/core"
	"reflect"
)

func main() {
	res := core.PtrTo(common.Hash{})
	fmt.Println(reflect.TypeOf(res))
}

Output:

*common.Hash

func RandomItem

func RandomItem[T any](items []T) (res T, _ error)

RandomItem is a generic function to get a random item from a slice.

Types

type Enum

type Enum interface {
	EnumInter
	fmt.Stringer
	GormDataType() string
	sql.Scanner
	driver.Valuer
}

Enum is a type used to define interfaces db enums must conform to. it is kept here so it can be used throughout the app.

type EnumInter

type EnumInter interface {
	Int() uint8
}

EnumInter ensures an enum has a type to access an integer.