README
¶
Core
Core contains common libraries used across our Go repositories.
Documentation
¶
Overview ¶
Package core contains the core dependencies
Index ¶
- Variables
- func BytesToSlice(bytes [32]byte) []byte
- func CopyBigInt(val *big.Int) *big.Int
- 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)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
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 ¶
BytesToSlice converts a 32 bit array to a slice slice.
func CopyBigInt ¶
CopyBigInt creates a copy of a big int without mutating the original.
func ExpandOrReturnPath ¶ added in v0.0.6
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 ¶
GetEnv gets an environment variable. If it is not present, the default variable is used.
func GetEnvInt ¶
GetEnvInt gets an environment variable as an int. if not found or cast the defaultVal is returned.
func IsTest ¶ added in v0.0.11
func IsTest() bool
IsTest returns true if the current process is a test.
func PtrTo ¶ added in v0.0.32
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 ¶ added in v0.0.36
RandomItem is a generic function to get a random item from a slice.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package assets provides static assets we want to embed in the application in the main folder and documentation related assets in subfolders.
|
Package assets provides static assets we want to embed in the application in the main folder and documentation related assets in subfolders. |
|
Package bytemap is an implementation of https://github.com/google/triemap/blob/main/bytemap.go with generic support for values
|
Package bytemap is an implementation of https://github.com/google/triemap/blob/main/bytemap.go with generic support for values |
|
Package commandline contains common utilities for use across clis
|
Package commandline contains common utilities for use across clis |
|
Package config contains the configuration required to run a node.
|
Package config contains the configuration required to run a node. |
|
Package dbcommon provides common database functionality
|
Package dbcommon provides common database functionality |
|
Package ginhelper provides some common functionality across gin servers.
|
Package ginhelper provides some common functionality across gin servers. |
|
Package mapmutex provides an extensible, type-safe mutex implementation TODO: use generics
|
Package mapmutex provides an extensible, type-safe mutex implementation TODO: use generics |
|
Package merkle provides the tools to create a merkle tree and keep track of its historical states.
|
Package merkle provides the tools to create a merkle tree and keep track of its historical states. |
|
Package metrics implements a metrics dashboard with either datadog or prometheus (coming soon)
|
Package metrics implements a metrics dashboard with either datadog or prometheus (coming soon) |
|
newrelic
Package newrelic provides custom wrpapers for newrelic.
|
Package newrelic provides custom wrpapers for newrelic. |
|
Package mocktesting is used for mocking out the testing.T interface.
|
Package mocktesting is used for mocking out the testing.T interface. |
|
Package observer provides an observer implementation
|
Package observer provides an observer implementation |
|
Package processlog contains an opinionated method for piping logs from external processes into stdout and readbale files for testing..
|
Package processlog contains an opinionated method for piping logs from external processes into stdout and readbale files for testing.. |
|
Package prom exposes metrics on synapse-node
|
Package prom exposes metrics on synapse-node |
|
Package server provides a way to access a server TODO: consider moving this into gin helper
|
Package server provides a way to access a server TODO: consider moving this into gin helper |
|
Package testsuite contains the standard test suite
|
Package testsuite contains the standard test suite |
|
Package threaditer extends iter with a mutex for thread safe use
|
Package threaditer extends iter with a mutex for thread safe use |
|
Package toml contains common utilities for implementing toml types.
|
Package toml contains common utilities for implementing toml types. |
Click to show internal directories.
Click to hide internal directories.