Documentation
¶
Overview ¶
Package chains provides multi-blockchain chain loading and management capabilities for the Chainlink Deployments Framework (CLD) engine.
This package implements a unified interface for loading and initializing blockchain connections across multiple blockchain families, including EVM, Solana, Aptos, Sui, TON, and Tron networks. It provides concurrent chain loading with proper error handling and configuration-based chain selection.
Core Components ¶
The package is built around several key components:
- ChainLoader interface: Defines the contract for loading blockchain connections
- LoadChains function: Main entry point for concurrent chain loading
- Chain-specific loaders: Individual implementations for each blockchain family
- Configuration-based initialization: Uses network configs and secrets for setup
Chain Loading Process ¶
The chain loading process follows these steps:
- Filter requested chain selectors based on available loaders and configuration
- Create appropriate chain loaders for each supported blockchain family
- Load chains concurrently using goroutines for optimal performance
- Collect results and handle any loading errors
- Return a unified BlockChains collection or aggregated error information
Usage Example ¶
ctx := context.Background()
// Load configuration
cfg := &config.Config{
Networks: networkConfig,
Env: envConfig,
}
// Specify which chains to load
chainSelectors := []uint64{
chainsel.ETHEREUM_TESTNET_SEPOLIA.Selector,
chainsel.POLYGON_TESTNET_MUMBAI.Selector,
}
// Load chains concurrently
chains, err := LoadChains(ctx, logger, cfg, chainSelectors)
if err != nil {
// Handle loading errors
log.Fatal(err)
}
// Use loaded chains for deployments
for _, chain := range chains.All() {
// Perform blockchain operations
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LoadChains ¶
func LoadChains( ctx context.Context, lggr logger.Logger, cfg *config.Config, chainselToLoad []uint64, ) (fchain.BlockChains, error)
LoadChains concurrently loads all chains for the given environment. Each chain is loaded in parallel, and the results (including any errors) are collected for each chain. If any chains fail to load, the function aggregates the errors and returns a detailed error message specifying which chains failed and the reasons for failure.
Types ¶
type ChainLoader ¶
type ChainLoader interface {
Load(ctx context.Context, selector uint64) (fchain.BlockChain, error)
}
ChainLoader is an interface that defines the methods for loading a chain.
Source Files