[NONEVM-904] Update address book to support nonevm

.changeset/late-seals-battle.md

@@ -0,0 +1,5 @@
+---
+"chainlink": minor
+---
+
+Update deployment address book to support non-evm chains

core/capabilities/ccip/delegate.go

@@ -179,6 +179,8 @@ func (d *Delegate) ServicesForSpec(ctx context.Context, spec job.Job) (services
 	if err != nil {
 		return nil, fmt.Errorf("failed to parse chain ID %s: %w", d.capabilityConfig.ExternalRegistry().RelayID().ChainID, err)
 	}
+
+	// NOTE: This does not support non-evm chains
 	homeChainChainSelector, err := chainsel.SelectorFromChainId(homeChainChainID)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get chain selector from chain ID %d", homeChainChainID)

core/capabilities/ccip/oraclecreator/bootstrap.go

@@ -145,6 +145,8 @@ func (i *bootstrapOracleCreator) Create(ctx context.Context, _ uint32, config cc
 	// TODO: add an api that returns chain family.
 	// NOTE: this doesn't really matter for the bootstrap node, it doesn't do anything on-chain.
 	// Its for the monitoring endpoint generation below.
+
+	// NOTE: This does not support non-evm chains
 	chainID, err := chainsel.ChainIdFromSelector(uint64(config.Config.ChainSelector))
 	if err != nil {
 		return nil, fmt.Errorf("failed to get chain ID from selector: %w", err)

core/capabilities/ccip/oraclecreator/plugin.go

@@ -120,6 +120,7 @@ func (i *pluginOracleCreator) Create(ctx context.Context, donID uint32, config c
 
 	// Assuming that the chain selector is referring to an evm chain for now.
 	// TODO: add an api that returns chain family.
+	// NOTE: This does not support non-evm chains
 	destChainID, err := chainsel.ChainIdFromSelector(uint64(config.Config.ChainSelector))
 	if err != nil {
 		return nil, fmt.Errorf("failed to get chain ID from selector %d: %w", config.Config.ChainSelector, err)
@@ -412,6 +413,7 @@ func decodeAndValidateOffchainConfig(
 }
 
 func (i *pluginOracleCreator) getChainSelector(chainID uint64) (cciptypes.ChainSelector, error) {
+	// NOTE: This does not support non-evm chains
 	chainSelector, ok := chainsel.EvmChainIdToChainSelector()[chainID]
 	if !ok {
 		return 0, fmt.Errorf("failed to get chain selector from chain ID %d", chainID)
@@ -420,6 +422,7 @@ func (i *pluginOracleCreator) getChainSelector(chainID uint64) (cciptypes.ChainS
 }
 
 func (i *pluginOracleCreator) getChainID(chainSelector cciptypes.ChainSelector) (uint64, error) {
+	// NOTE: This does not support non-evm chains
 	chainID, err := chainsel.ChainIdFromSelector(uint64(chainSelector))
 	if err != nil {
 		return 0, fmt.Errorf("failed to get chain ID from chain selector %d: %w", chainSelector, err)

core/services/ocr2/delegate.go

@@ -374,6 +374,7 @@ func (d *Delegate) cleanupEVM(ctx context.Context, jb job.Job, relayID types.Rel
 			return err
 		}
 		var chainSelector uint64
+		// NOTE: This does not support non-evm chains
 		chainSelector, err = chainselectors.SelectorFromChainId(chain.ID().Uint64())
 		if err != nil {
 			return err
@@ -1728,6 +1729,7 @@ func (d *Delegate) ccipCommitGetSrcProvider(ctx context.Context, jb job.Job, plu
 		return nil, 0, fmt.Errorf("get offRamp static config: %w", err)
 	}
 
+	// NOTE: This does not support non-evm chains
 	srcChainID, err = chainselectors.ChainIdFromSelector(offRampConfig.SourceChainSelector)
 	if err != nil {
 		return nil, 0, err
@@ -1883,6 +1885,7 @@ func (d *Delegate) ccipExecGetSrcProvider(ctx context.Context, jb job.Job, plugi
 		return nil, 0, fmt.Errorf("get offRamp static config: %w", err)
 	}
 
+	// NOTE: This does not support non-evm chains
 	srcChainID, err = chainselectors.ChainIdFromSelector(offRampConfig.SourceChainSelector)
 	if err != nil {
 		return nil, 0, err

core/services/ocr2/plugins/ccip/config/chain_config.go

@@ -20,6 +20,7 @@ func GetChainFromSpec(spec *job.OCR2OracleSpec, chainSet legacyevm.LegacyChainCo
 }
 
 func GetChainByChainSelector(chainSet legacyevm.LegacyChainContainer, chainSelector uint64) (legacyevm.Chain, int64, error) {
+	// NOTE: This does not support non-evm chains
 	chainID, err := chainselectors.ChainIdFromSelector(chainSelector)
 	if err != nil {
 		return nil, 0, err
@@ -36,10 +37,12 @@ func GetChainByChainID(chainSet legacyevm.LegacyChainContainer, chainID uint64)
 }
 
 func ResolveChainNames(sourceChainId int64, destChainId int64) (string, string, error) {
+	// NOTE: This does not support non-evm chains
 	sourceChainName, err := chainselectors.NameFromChainId(uint64(sourceChainId))
 	if err != nil {
 		return "", "", err
 	}
+	// NOTE: This does not support non-evm chains
 	destChainName, err := chainselectors.NameFromChainId(uint64(destChainId))
 	if err != nil {
 		return "", "", err

core/services/relay/evm/evm.go

@@ -197,6 +197,7 @@ func NewRelayer(ctx context.Context, lggr logger.Logger, chain legacyevm.Chain,
 	sugared := logger.Sugared(lggr).Named("Relayer")
 	mercuryORM := mercury.NewORM(opts.DS)
 	cdcFactory := sync.OnceValues(func() (llo.ChannelDefinitionCacheFactory, error) {
+		// NOTE: This does not support non-evm chains
 		chainSelector, err := chainselectors.SelectorFromChainId(chain.ID().Uint64())
 		if err != nil {
 			return nil, fmt.Errorf("failed to get chain selector for chain id %s: %w", chain.ID(), err)

core/services/relay/evm/write_target.go

@@ -18,6 +18,7 @@ import (
 func NewWriteTarget(ctx context.Context, relayer *Relayer, chain legacyevm.Chain, gasLimitDefault uint64, lggr logger.Logger) (*targets.WriteTarget, error) {
 	// generate ID based on chain selector
 	id := fmt.Sprintf("write_%[email protected]", chain.ID())
+	// NOTE: This does not support non-evm chains
 	chainName, err := chainselectors.NameFromChainId(chain.ID().Uint64())
 	if err == nil {
 		id = fmt.Sprintf("write_%[email protected]", chainName)

deployment/address_book.go

@@ -93,20 +93,22 @@ type AddressBookMap struct {
 	mtx              sync.RWMutex
 }
 
-// save will save an address for a given chain selector. It will error if there is a conflicting existing address.
-func (m *AddressBookMap) save(chainSelector uint64, address string, typeAndVersion TypeAndVersion) error {
-	_, exists := chainsel.ChainBySelector(chainSelector)
-	if !exists {
+// Save will save an address for a given chain selector. It will error if there is a conflicting existing address.
+func (m *AddressBookMap) Save(chainSelector uint64, address string, typeAndVersion TypeAndVersion) error {
+	family, err := chainsel.GetSelectorFamily(chainSelector)
+	if err != nil {
 		return errors.Wrapf(ErrInvalidChainSelector, "chain selector %d", chainSelector)
 	}
-	if address == "" || address == common.HexToAddress("0x0").Hex() {
-		return errors.Wrap(ErrInvalidAddress, "address cannot be empty")
-	}
-	if common.IsHexAddress(address) {
-		// IMPORTANT: WE ALWAYS STANDARDIZE ETHEREUM ADDRESS STRINGS TO EIP55
-		address = common.HexToAddress(address).Hex()
-	} else {
-		return errors.Wrapf(ErrInvalidAddress, "address %s is not a valid Ethereum address, only Ethereum addresses supported", address)
+	if family == chainsel.FamilyEVM {
+		if address == "" || address == common.HexToAddress("0x0").Hex() {
+			return errors.Wrap(ErrInvalidAddress, "address cannot be empty")
+		}
+		if common.IsHexAddress(address) {
+			// IMPORTANT: WE ALWAYS STANDARDIZE ETHEREUM ADDRESS STRINGS TO EIP55
+			address = common.HexToAddress(address).Hex()
+		} else {
+			return errors.Wrapf(ErrInvalidAddress, "address %s is not a valid Ethereum address, only Ethereum addresses supported for EVM chains", address)
+		}
 	}
 	if typeAndVersion.Type == "" {
 		return fmt.Errorf("type cannot be empty")
@@ -142,8 +144,8 @@ func (m *AddressBookMap) Addresses() (map[uint64]map[string]TypeAndVersion, erro
 }
 
 func (m *AddressBookMap) AddressesForChain(chainSelector uint64) (map[string]TypeAndVersion, error) {
-	_, exists := chainsel.ChainBySelector(chainSelector)
-	if !exists {
+	_, err := chainsel.GetChainIDFromSelector(chainSelector)
+	if err != nil {
 		return nil, errors.Wrapf(ErrInvalidChainSelector, "chain selector %d", chainSelector)
 	}
 

deployment/ccip/propose.go

@@ -64,6 +64,7 @@ func NewTestMCMSConfig(t *testing.T, e deployment.Environment) MCMSConfig {
 func SignProposal(t *testing.T, env deployment.Environment, proposal *timelock.MCMSWithTimelockProposal) *mcms.Executor {
 	executorClients := make(map[mcms.ChainIdentifier]mcms.ContractDeployBackend)
 	for _, chain := range env.Chains {
+		// NOTE: This does not support non-evm chains
 		chainselc, exists := chainsel.ChainBySelector(chain.Selector)
 		require.True(t, exists)
 		chainSel := mcms.ChainIdentifier(chainselc.Selector)
@@ -141,6 +142,7 @@ func GenerateAcceptOwnershipProposal(
 	// TODO: Accept rest of contracts
 	var batches []timelock.BatchChainOperation
 	for _, sel := range chains {
+		// NOTE: This does not support non-evm chains
 		chain, _ := chainsel.ChainBySelector(sel)
 		acceptOnRamp, err := state.Chains[sel].OnRamp.AcceptOwnership(deployment.SimTransactOpts())
 		if err != nil {

deployment/ccip/state.go

@@ -190,10 +190,12 @@ func (s CCIPOnChainState) View(chains []uint64) (map[string]view.ChainView, erro
 	m := make(map[string]view.ChainView)
 	for _, chainSelector := range chains {
 		// TODO: Need a utility for this
+		// NOTE: This does not support non-evm chains
 		chainid, err := chainsel.ChainIdFromSelector(chainSelector)
 		if err != nil {
 			return m, err
 		}
+		// NOTE: This does not support non-evm chains
 		chainName, err := chainsel.NameFromChainId(chainid)
 		if err != nil {
 			return m, err

deployment/common/view/nops.go

@@ -59,10 +59,12 @@ func GenerateNopsView(nodeIds []string, oc deployment.OffchainClient) (map[strin
 			IsEnabled:    nodeDetails.Node.IsEnabled,
 		}
 		for sel, ocrConfig := range node.SelToOCRConfig {
+			// NOTE: This does not support non-evm chains
 			chainid, err := chainsel.ChainIdFromSelector(sel)
 			if err != nil {
 				return nv, err
 			}
+			// NOTE: This does not support non-evm chains
 			chainName, err := chainsel.NameFromChainId(chainid)
 			if err != nil {
 				return nv, err

deployment/environment.go

@@ -280,6 +280,7 @@ func NodeInfo(nodeIDs []string, oc NodeChainConfigsLister) (Nodes, error) {
 			if err != nil {
 				return nil, err
 			}
+			// NOTE: This does not support non-evm chains
 			sel, err := chain_selectors.SelectorFromChainId(uint64(evmChainID))
 			if err != nil {
 				return nil, err

deployment/environment/devenv/chain.go

@@ -32,6 +32,7 @@ type ChainConfig struct {
 func NewChains(logger logger.Logger, configs []ChainConfig) (map[uint64]deployment.Chain, error) {
 	chains := make(map[uint64]deployment.Chain)
 	for _, chainCfg := range configs {
+		// NOTE: This does not support non-evm chains
 		selector, err := chainselectors.SelectorFromChainId(chainCfg.ChainID)
 		if err != nil {
 			return nil, fmt.Errorf("failed to get selector from chain id %d: %w", chainCfg.ChainID, err)

deployment/environment/devenv/don.go

@@ -405,6 +405,7 @@ func (n *Node) ExportEVMKeysForChain(chainId string) ([]*clclient.ExportedEVMKey
 // ReplayLogs replays logs for the chains on the node for given block numbers for each chain
 func (n *Node) ReplayLogs(blockByChain map[uint64]uint64) error {
 	for sel, block := range blockByChain {
+		// NOTE: This does not support non-evm chains
 		chainID, err := chainsel.ChainIdFromSelector(sel)
 		if err != nil {
 			return err

deployment/environment/memory/environment.go

@@ -57,6 +57,7 @@ func generateMemoryChain(t *testing.T, inputs map[uint64]EVMChain) map[uint64]de
 	chains := make(map[uint64]deployment.Chain)
 	for cid, chain := range inputs {
 		chain := chain
+		// NOTE: This does not support non-evm chains
 		sel, err := chainsel.SelectorFromChainId(cid)
 		require.NoError(t, err)
 		backend := NewBackend(chain.Backend)

deployment/environment/memory/node.go

@@ -56,6 +56,7 @@ type Node struct {
 
 func (n Node) ReplayLogs(chains map[uint64]uint64) error {
 	for sel, block := range chains {
+		// NOTE: This does not support non-evm chains
 		chainID, _ := chainsel.ChainIdFromSelector(sel)
 		if err := n.App.ReplayFromBlock(big.NewInt(int64(chainID)), block, false); err != nil {
 			return err

deployment/keystone/changeset/update_node_capabilities.go

@@ -49,6 +49,7 @@ func (req *MutateNodeCapabilitiesRequest) Validate() error {
 	if len(req.P2pToCapabilities) == 0 {
 		return fmt.Errorf("p2pToCapabilities is empty")
 	}
+	// NOTE: This does not support non-evm chains
 	_, exists := chainsel.ChainBySelector(req.RegistryChainSel)
 	if !exists {
 		return fmt.Errorf("registry chain selector %d does not exist", req.RegistryChainSel)

deployment/keystone/changeset/view.go

@@ -23,10 +23,12 @@ func ViewKeystone(e deployment.Environment) (json.Marshaler, error) {
 	}
 	chainViews := make(map[string]view.KeystoneChainView)
 	for chainSel, contracts := range state.ContractSets {
+		// NOTE: This does not support non-evm chains
 		chainid, err := chainsel.ChainIdFromSelector(chainSel)
 		if err != nil {
 			return nil, err
 		}
+		// NOTE: This does not support non-evm chains
 		chainName, err := chainsel.NameFromChainId(chainid)
 		if err != nil {
 			return nil, err

deployment/keystone/deploy.go

@@ -57,6 +57,7 @@ func (r ConfigureContractsRequest) Validate() error {
 			return fmt.Errorf("don validation failed for '%s': %w", don.Name, err)
 		}
 	}
+	// NOTE: This does not support non-evm chains
 	_, ok := chainsel.ChainBySelector(r.RegistryChainSel)
 	if !ok {
 		return fmt.Errorf("chain %d not found in environment", r.RegistryChainSel)

deployment/keystone/types.go

@@ -256,6 +256,7 @@ func NodeOperator(name string, adminAddress string) capabilities_registry.Capabi
 }
 
 func AdminAddress(n *Node, chainSel uint64) (string, error) {
+	// NOTE: This does not support non-evm chains
 	cid, err := chainsel.ChainIdFromSelector(chainSel)
 	if err != nil {
 		return "", fmt.Errorf("failed to get chain id from selector %d: %w", chainSel, err)
@@ -355,6 +356,7 @@ func firstChainConfigByType(ccfgs []*v1.ChainConfig, t v1.ChainType) (*v1.ChainC
 }
 
 func registryChainConfig(ccfgs []*v1.ChainConfig, t v1.ChainType, sel uint64) (*v1.ChainConfig, error) {
+	// NOTE: This does not support non-evm chains
 	chainId, err := chainsel.ChainIdFromSelector(sel)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get chain id from selector %d: %w", sel, err)

integration-tests/ccip-tests/actions/ccip_helpers.go

@@ -463,6 +463,7 @@ func (ccipModule *CCIPCommon) WaitForPriceUpdates(
 	destChainId uint64,
 	allTokens []common.Address,
 ) error {
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chainselectors.SelectorFromChainId(destChainId)
 	if err != nil {
 		return err
@@ -557,6 +558,7 @@ func (ccipModule *CCIPCommon) WatchForPriceUpdates(ctx context.Context, lggr *ze
 		return fmt.Errorf("no event subscription found")
 	}
 	processEvent := func(value, timestamp *big.Int, destChainSelector uint64, raw types.Log) error {
+		// NOTE: This does not support non-evm chains
 		destChain, err := chainselectors.ChainIdFromSelector(destChainSelector)
 		if err != nil {
 			return err
@@ -663,6 +665,7 @@ func (ccipModule *CCIPCommon) SyncUSDCDomain(destTransmitter *contracts.TokenTra
 	if destTransmitter == nil {
 		return fmt.Errorf("invalid address")
 	}
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chainselectors.SelectorFromChainId(destChainID)
 	if err != nil {
 		return fmt.Errorf("invalid chain id %w", err)
@@ -1391,6 +1394,7 @@ func (sourceCCIP *SourceCCIPModule) DeployContracts(lane *laneconfig.LaneConfig)
 	log.Info().Msg("Deploying source chain specific contracts")
 
 	sourceCCIP.LoadContracts(lane)
+	// NOTE: This does not support non-evm chains
 	sourceChainSelector, err := chainselectors.SelectorFromChainId(sourceCCIP.Common.ChainClient.GetChainID().Uint64())
 	if err != nil {
 		return fmt.Errorf("getting chain selector shouldn't fail %w", err)
@@ -1827,6 +1831,7 @@ func (sourceCCIP *SourceCCIPModule) SendRequest(
 	gasLimit *big.Int,
 ) (common.Hash, time.Duration, *big.Int, error) {
 	var d time.Duration
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chainselectors.SelectorFromChainId(sourceCCIP.DestinationChainId)
 	if err != nil {
 		return common.Hash{}, d, nil, fmt.Errorf("failed getting the chain selector: %w", err)
@@ -1896,6 +1901,7 @@ func DefaultSourceCCIPModule(
 		return nil, err
 	}
 
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chainselectors.SelectorFromChainId(destChainId)
 	if err != nil {
 		return nil, fmt.Errorf("failed getting the chain selector: %w", err)
@@ -2061,6 +2067,7 @@ func (destCCIP *DestCCIPModule) DeployContracts(
 	contractDeployer := destCCIP.Common.Deployer
 	log.Info().Msg("Deploying destination chain specific contracts")
 	destCCIP.LoadContracts(lane)
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chainselectors.SelectorFromChainId(destCCIP.Common.ChainClient.GetChainID().Uint64())
 	if err != nil {
 		return fmt.Errorf("failed to get chain selector for destination chain id %d: %w", destCCIP.Common.ChainClient.GetChainID().Uint64(), err)
@@ -2649,6 +2656,7 @@ func DefaultDestinationCCIPModule(
 		return nil, err
 	}
 
+	// NOTE: This does not support non-evm chains
 	sourceChainSelector, err := chainselectors.SelectorFromChainId(sourceChainId)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get chain selector for source chain id %d: %w", sourceChainId, err)
@@ -2858,6 +2866,7 @@ func (lane *CCIPLane) Multicall(noOfRequests int, multiSendAddr common.Address)
 	if err != nil {
 		return fmt.Errorf("failed to form the ccip message: %w", err)
 	}
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chainselectors.SelectorFromChainId(lane.Source.DestinationChainId)
 	if err != nil {
 		return fmt.Errorf("failed getting the chain selector: %w", err)
@@ -3043,10 +3052,12 @@ func (lane *CCIPLane) ExecuteManually(options ...ManualExecutionOption) error {
 					}
 				}
 			}
+			// NOTE: This does not support non-evm chains
 			destChainSelector, err := chainselectors.SelectorFromChainId(lane.DestChain.GetChainID().Uint64())
 			if err != nil {
 				return err
 			}
+			// NOTE: This does not support non-evm chains
 			sourceChainSelector, err := chainselectors.SelectorFromChainId(lane.SourceChain.GetChainID().Uint64())
 			if err != nil {
 				return err

integration-tests/ccip-tests/load/ccip_loadgen.go

@@ -269,6 +269,7 @@ func (c *CCIPE2ELoad) Call(_ *wasp.Generator) *wasp.Response {
 	lggr.Debug().Str("triggeredAt", time.Now().GoString()).Msg("triggering transfer")
 	var sendTx *types.Transaction
 
+	// NOTE: This does not support non-evm chains
 	destChainSelector, err := chain_selectors.SelectorFromChainId(sourceCCIP.DestinationChainId)
 	if err != nil {
 		res.Error = fmt.Sprintf("reqNo %d err %s - while getting selector from chainid", msgSerialNo, err.Error())

integration-tests/ccip-tests/load/ccip_multicall_loadgen.go

@@ -224,6 +224,7 @@ func (m *CCIPMultiCallLoadGenerator) MergeCalls() ([]contracts.CCIPMsgData, map[
 	statDetails := make(map[string]MultiCallReturnValues)
 
 	for _, e2eLoad := range m.E2ELoads {
+		// NOTE: This does not support non-evm chains
 		destChainSelector, err := chain_selectors.SelectorFromChainId(e2eLoad.Lane.Source.DestinationChainId)
 		if err != nil {
 			return ccipMsgs, statDetails, err