move AddressCodec interfaces to cl-common

Author: ogtownsend

pkg/types/ccipocr3/interfaces.go

@@ -25,6 +25,40 @@ type AddressCodec interface {
 	AddressStringToBytes(string, ChainSelector) (UnknownAddress, error)
 }
 
+type AddressCodecBundle interface {
+	AddressBytesToString(addr UnknownAddress, chainSelector ChainSelector) (string, error)
+	AddressStringToBytes(addr string, chainSelector ChainSelector) (UnknownAddress, error)
+	TransmitterBytesToString(addr UnknownAddress, chainSelector ChainSelector) (string, error)
+	OracleIDAsAddressBytes(oracleID uint8, chainSelector ChainSelector) ([]byte, error)
+}
+
+// ChainSpecificAddressCodec is an interface that defines the methods for encoding and decoding addresses for a specific chain
+type ChainSpecificAddressCodec interface {
+	// AddressBytesToString converts an address from bytes to string
+	AddressBytesToString([]byte) (string, error)
+	// AddressStringToBytes converts an address from string to bytes
+	AddressStringToBytes(string) ([]byte, error)
+	// OracleIDAsAddressBytes returns a valid address for this chain family with the bytes set to the given oracle ID.
+	OracleIDAsAddressBytes(oracleID uint8) ([]byte, error)
+	// TransmitterBytesToString converts a transmitter account from bytes to string
+	TransmitterBytesToString([]byte) (string, error)
+}
+
+// ExtraDataCodecBundle is an interface that defines methods for decoding extra args and dest exec data.
+type ExtraDataCodecBundle interface {
+	DecodeExtraArgs(extraArgs Bytes, sourceChainSelector ChainSelector) (map[string]any, error)
+	DecodeTokenAmountDestExecData(destExecData Bytes, sourceChainSelector ChainSelector) (map[string]any, error)
+}
+
+// SourceChainExtraDataCodec is an interface for decoding source chain specific extra args and dest exec data into a map[string]any representation for a specific chain
+// For chain A to chain B message, this interface will be the chain A specific codec
+type SourceChainExtraDataCodec interface {
+	// DecodeExtraArgsToMap reformat bytes into a chain agnostic map[string]any representation for extra args
+	DecodeExtraArgsToMap(extraArgs Bytes) (map[string]any, error)
+	// DecodeDestExecDataToMap reformat bytes into a chain agnostic map[string]interface{} representation for dest exec data
+	DecodeDestExecDataToMap(destExecData Bytes) (map[string]any, error)
+}
+
 // RMNCrypto provides a chain-agnostic interface for verifying RMN signatures.
 // For example, on EVM, RMN reports are abi-encoded prior to being signed.
 // On Solana, they would be borsh encoded instead, etc.

pkg/types/ccipocr3/plugincodec.go

@@ -15,33 +15,6 @@ type Codec struct {
 	SourceChainExtraDataCodec
 }
 
-// ChainSpecificAddressCodec is an interface that defines the methods for encoding and decoding addresses for a specific chain
-type ChainSpecificAddressCodec interface {
-	// AddressBytesToString converts an address from bytes to string
-	AddressBytesToString([]byte) (string, error)
-	// AddressStringToBytes converts an address from string to bytes
-	AddressStringToBytes(string) ([]byte, error)
-	// OracleIDAsAddressBytes returns a valid address for this chain family with the bytes set to the given oracle ID.
-	OracleIDAsAddressBytes(oracleID uint8) ([]byte, error)
-	// TransmitterBytesToString converts a transmitter account from bytes to string
-	TransmitterBytesToString([]byte) (string, error)
-}
-
-// SourceChainExtraDataCodec is an interface for decoding source chain specific extra args and dest exec data into a map[string]any representation for a specific chain
-// For chain A to chain B message, this interface will be the chain A specific codec
-type SourceChainExtraDataCodec interface {
-	// DecodeExtraArgsToMap reformat bytes into a chain agnostic map[string]any representation for extra args
-	DecodeExtraArgsToMap(extraArgs Bytes) (map[string]any, error)
-	// DecodeDestExecDataToMap reformat bytes into a chain agnostic map[string]interface{} representation for dest exec data
-	DecodeDestExecDataToMap(destExecData Bytes) (map[string]any, error)
-}
-
-// ExtraDataCodecBundle is an interface that defines methods for decoding extra args and dest exec data.
-type ExtraDataCodecBundle interface {
-	DecodeExtraArgs(extraArgs Bytes, sourceChainSelector ChainSelector) (map[string]any, error)
-	DecodeTokenAmountDestExecData(destExecData Bytes, sourceChainSelector ChainSelector) (map[string]any, error)
-}
-
 // ExtraDataCodecMap is a map of chain family to SourceChainExtraDataCodec
 type ExtraDataCodecMap map[string]SourceChainExtraDataCodec
 
@@ -86,3 +59,67 @@ func (c ExtraDataCodecMap) DecodeTokenAmountDestExecData(destExecData Bytes, sou
 
 	return codec.DecodeDestExecDataToMap(destExecData)
 }
+
+// AddressCodecMap is a map of chain family to ChainSpecificAddressCodec
+type AddressCodecMap map[string]ChainSpecificAddressCodec
+
+var _ AddressCodecBundle = AddressCodecMap{}
+
+// AddressBytesToString converts an address from bytes to string
+func (ac AddressCodecMap) AddressBytesToString(addr UnknownAddress, chainSelector ChainSelector) (string, error) {
+	family, err := chainsel.GetSelectorFamily(uint64(chainSelector))
+	if err != nil {
+		return "", fmt.Errorf("failed to get chain family for selector %d: %w", chainSelector, err)
+	}
+
+	codec, exist := ac[family]
+	if !exist {
+		return "", fmt.Errorf("unsupported family for address decode type %s", family)
+	}
+
+	return codec.AddressBytesToString(addr)
+}
+
+// TransmitterBytesToString converts a transmitter account from bytes to string
+func (ac AddressCodecMap) TransmitterBytesToString(addr UnknownAddress, chainSelector ChainSelector) (string, error) {
+	family, err := chainsel.GetSelectorFamily(uint64(chainSelector))
+	if err != nil {
+		return "", fmt.Errorf("failed to get chain family for selector %d: %w", chainSelector, err)
+	}
+
+	codec, exist := ac[family]
+	if !exist {
+		return "", fmt.Errorf("unsupported family for transmitter decode type %s", family)
+	}
+
+	return codec.TransmitterBytesToString(addr)
+}
+
+// AddressStringToBytes converts an address from string to bytes
+func (ac AddressCodecMap) AddressStringToBytes(addr string, chainSelector ChainSelector) (UnknownAddress, error) {
+	family, err := chainsel.GetSelectorFamily(uint64(chainSelector))
+	if err != nil {
+		return nil, fmt.Errorf("failed to get chain family for selector %d: %w", chainSelector, err)
+	}
+	codec, exist := ac[family]
+	if !exist {
+		return nil, fmt.Errorf("unsupported family for address decode type %s", family)
+	}
+
+	return codec.AddressStringToBytes(addr)
+}
+
+// OracleIDAsAddressBytes returns valid address bytes for a given chain selector and oracle ID.
+// Used for making nil transmitters in the OCR config valid, it just means that this oracle does not support the destination chain.
+func (ac AddressCodecMap) OracleIDAsAddressBytes(oracleID uint8, chainSelector ChainSelector) ([]byte, error) {
+	family, err := chainsel.GetSelectorFamily(uint64(chainSelector))
+	if err != nil {
+		return nil, fmt.Errorf("failed to get chain family for selector %d: %w", chainSelector, err)
+	}
+	codec, exist := ac[family]
+	if !exist {
+		return nil, fmt.Errorf("unsupported family for address decode type %s", family)
+	}
+
+	return codec.OracleIDAsAddressBytes(oracleID)
+}