chains

package
v1.13.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 6, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

View Source 
var (
	// ErrChainIDEmpty is returned when chain is required but was empty.
	ErrChainIDEmpty = errors.New("chain id empty")
	// ErrChainIDInvalid is returned when a chain id does not match any configured chains.
	ErrChainIDInvalid = errors.New("chain id does not match any local chains")
)

Functions

This section is empty.

Types

type ChainConfig added in v1.10.0 

type ChainConfig[I ID, C Config, N Node] interface {
	// contains filtered or unexported methods
}

type ChainService added in v1.5.0 

type ChainService[C Config] interface {
	services.ServiceCtx
	UpdateConfig(C)
}

ChainService is a live, runtime chain instance, with supporting services.

type ChainSet added in v1.5.0 

type ChainSet[I ID, C Config, N Node, S ChainService[C]] interface {
	services.ServiceCtx

	Name() string
	HealthReport() map[string]error

	DBChainSet[I, C]

	DBNodeSet[I, N]

	// Chain returns the ChainService for this ID (if a configuration is available), creating one if necessary.
	Chain(context.Context, I) (S, error)
}

ChainSet manages a live set of ChainService instances.

func NewChainSet added in v1.5.0 

func NewChainSet[I ID, C Config, N Node, S ChainService[C]](
	opts ChainSetOpts[I, C, N, S], formatID func(I) string,
) (ChainSet[I, C, N, S], error)

NewChainSet returns a new ChainSet for the given ChainSetOpts. https://app.shortcut.com/chainlinklabs/story/33622/remove-legacy-config

func NewChainSetImmut added in v1.10.0 

func NewChainSetImmut[I ID, C Config, N Node, S ChainService[C]](chains map[string]S,
	opts ChainSetOpts[I, C, N, S], formatID func(I) string,
) (ChainSet[I, C, N, S], error)

NewChainSetImmut returns a new immutable ChainSet for the given ChainSetOpts.

type ChainSetOpts added in v1.5.0 

type ChainSetOpts[I ID, C Config, N Node, S ChainService[C]] interface {
	Validate() error
	// https://app.shortcut.com/chainlinklabs/story/33622/remove-legacy-config
	NewChain(DBChain[I, C]) (S, error)
	ORMAndLogger() (ORM[I, C, N], logger.Logger)
}

ChainSetOpts holds options for configuring a ChainSet via NewChainSet.

type ChainsORM added in v1.5.0 

type ChainsORM[I ID, CFG Config, C DBChain[I, CFG]] interface {
	Chain(I, ...pg.QOpt) (C, error)
	Chains(offset, limit int, qopts ...pg.QOpt) ([]C, int, error)
	CreateChain(id I, config CFG, qopts ...pg.QOpt) (C, error)
	UpdateChain(id I, enabled bool, config CFG, qopts ...pg.QOpt) (C, error)
	DeleteChain(id I, qopts ...pg.QOpt) error
	GetChainsByIDs(ids []I) (chains []C, err error)
	EnabledChains(...pg.QOpt) ([]C, error)
}

type Config added in v1.5.0 

type Config interface {
	sql.Scanner
	driver.Valuer
}

Config types should have fields for chain configuration, and implement sql.Scanner and driver.Valuer for persistence in JSON format.

type DBChain added in v1.5.0 

type DBChain[I ID, C Config] struct {
	ID        I
	Cfg       C
	CreatedAt time.Time
	UpdatedAt time.Time
	Enabled   bool
}

DBChain is a generic DB chain for an ID and Config.

A DBChain type alias can be used for convenience: 

type DBChain = chains.DBChain[string, pkg.ChainCfg]

type DBChainSet added in v1.5.0 

type DBChainSet[I ID, C Config] interface {
	Add(ctx context.Context, id I, cfg C) (DBChain[I, C], error)
	Show(id I) (DBChain[I, C], error)
	Configure(ctx context.Context, id I, enabled bool, cfg C) (DBChain[I, C], error)
	Remove(id I) error
	Index(offset, limit int) ([]DBChain[I, C], int, error)
}

DBChainSet is a generic interface for DBChain[I, C] configuration.

type DBNodeSet added in v1.5.0 

type DBNodeSet[I ID, N Node] interface {
	GetNodes(ctx context.Context, offset, limit int) (nodes []N, count int, err error)
	GetNodesForChain(ctx context.Context, chainID I, offset, limit int) (nodes []N, count int, err error)
	CreateNode(context.Context, N) (N, error)
	DeleteNode(context.Context, int32) error
}

DBNodeSet is a generic interface for Node configuration.

type ID added in v1.5.0 

type ID any

ID types represent unique identifiers within a particular chain type. Using string is recommended.

type Node added in v1.5.0 

type Node any

Node types should be a struct including these default fields: 

ID        int32
Name      string
CreatedAt time.Time
UpdatedAt time.Time

type NodesORM added in v1.5.0 

type NodesORM[I ID, N Node] interface {
	CreateNode(N, ...pg.QOpt) (N, error)
	DeleteNode(int32, ...pg.QOpt) error
	GetNodesByChainIDs(chainIDs []I, qopts ...pg.QOpt) (nodes []N, err error)
	NodeNamed(string, ...pg.QOpt) (N, error)
	Nodes(offset, limit int, qopts ...pg.QOpt) (nodes []N, count int, err error)
	NodesForChain(chainID I, offset, limit int, qopts ...pg.QOpt) (nodes []N, count int, err error)
}

type ORM added in v1.4.0 

type ORM[I ID, C Config, N Node] interface {
	ChainsORM[I, C, DBChain[I, C]]

	NodesORM[I, N]

	StoreString(chainID I, key, val string) error
	Clear(chainID I, key string) error

	// SetupNodes is a shim to help with configuring multiple nodes via ENV.
	// All existing nodes are dropped, and any missing chains are automatically created.
	// Then all nodes are inserted, and conflicts are ignored.
	SetupNodes(nodes []N, chainIDs []I) error
	EnsureChains([]I, ...pg.QOpt) error
}

ORM manages chains and nodes.

func NewORM added in v1.4.0 

func NewORM[I ID, C Config, N Node](q pg.Q, prefix string, nodeCols ...string) ORM[I, C, N]

NewORM returns an ORM backed by q, for the tables <prefix>_chains and <prefix>_nodes with column <prefix>_chain_id. Additional Node fields should be included in nodeCols. https://app.shortcut.com/chainlinklabs/story/33622/remove-legacy-config

Example 
package main

import (
	"database/sql/driver"
	"encoding/json"
	"time"

	"github.com/pkg/errors"
	"gopkg.in/guregu/null.v4"

	"github.com/smartcontractkit/chainlink/core/chains"
	"github.com/smartcontractkit/chainlink/core/services/pg"
)

type Config struct {
	Foo null.String
}

func (c *Config) Scan(value any) error {
	b, ok := value.([]byte)
	if !ok {
		return errors.New("type assertion to []byte failed")
	}

	return json.Unmarshal(b, c)
}

func (c *Config) Value() (driver.Value, error) {
	return json.Marshal(c)
}

func main() {
	type Node = struct {
		ID             int32
		Name           string
		ExampleChainID string
		URL            string
		Bar            null.Int
		CreatedAt      time.Time
		UpdatedAt      time.Time
	}
	var q pg.Q
	_ = chains.NewORM[string, *Config, Node](q, "example", "url", "bar")

}

Output:

func NewORMImmut added in v1.10.0 

func NewORMImmut[I ID, C Config, N Node](chainConfigs ChainConfig[I, C, N]) ORM[I, C, N]

NewORMImmut returns an ORM backed by q, for the tables <prefix>_chains and <prefix>_nodes with column <prefix>_chain_id. Additional Node fields should be included in nodeCols.

Source Files

View all Source files

Directories

Path Synopsis
evm
client
client/mocks
config
config/mocks
config/v2
forwarders
gas
gas/cmd/arbgas
arbgas takes a single URL argument and prints the result of three GetLegacyGas calls to the Arbitrum gas estimator.
 arbgas takes a single URL argument and prints the result of three GetLegacyGas calls to the Arbitrum gas estimator.
gas/mocks
headtracker
headtracker/mocks
headtracker/types
label
log
log/mocks
logpoller
Package logpoller is a service for querying EVM log data.
 Package logpoller is a service for querying EVM log data.
logpoller/mocks
mocks
monitor
txmgr
txmgr/mocks
types
fees
mocks
monitor
soltxm
types

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.