Added codec to solana accessor to decode events

Author: amit-momin

pkg/solana/ccip/chainaccessor/config.go

@@ -17,6 +17,7 @@ import (
 	"github.com/smartcontractkit/chainlink-ccip/pkg/consts"
 )
 
+// https://github.com/smartcontractkit/chainlink-ccip/blob/7cae1b8434dd376eb70f2ddaace43093982f3a57/chains/solana/contracts/programs/rmn-remote/src/state.rs#L20-L27
 var globalCurseValue = []byte{1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}
 
 // getOffRampStaticConfig retrieves static configuration for the off-ramp contract

pkg/solana/ccip/chainaccessor/event.go

@@ -3,6 +3,7 @@ package chainaccessor
 import (
 	"context"
 	"crypto/sha3"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"math/big"
@@ -72,6 +73,7 @@ var (
 	execStateChangedStatePath    = consts.EventAttributeState
 )
 
+// Map of relevant events and their metadata required to build the codec and bind program addresses
 var eventFilterConfigMap = map[string]filterConfig{
 	consts.EventNameCCIPMessageSent: {
 		idl:           ccipRouterIDL,
@@ -126,6 +128,40 @@ func (a *SolanaAccessor) bindContractEvent(ctx context.Context, contractName str
 	return nil
 }
 
+func buildEventsCodec() (types.RemoteCodec, error) {
+	parsed := &codec.ParsedTypes{
+		DecoderDefs: make(map[string]codec.Entry),
+	}
+
+	for eventName, eventCfg := range eventFilterConfigMap {
+		var codecIDL codec.IDL
+		if err := json.Unmarshal([]byte(eventCfg.idl), &codecIDL); err != nil {
+			return nil, fmt.Errorf("unexpected error: invalid CCIP OffRamp IDL, error: %w", err)
+		}
+
+		idlDef, err := codec.FindDefinitionFromIDL(codec.ChainConfigTypeInstructionDef, eventName, codecIDL)
+		if err != nil {
+			return nil, err
+		}
+		eventIdl, isOk := idlDef.(codec.IdlEvent)
+		if !isOk {
+			return nil, fmt.Errorf("unexpected type from IDL definition for event read: %q", eventName)
+		}
+		entry, err := codec.CreateCodecEntry(eventIdl, eventName, codecIDL, nil)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create codec entry for event %s, error: %w", eventName, err)
+		}
+		parsed.DecoderDefs[eventName] = entry
+	}
+
+	codec, err := parsed.ToCodec()
+	if err != nil {
+		return nil, fmt.Errorf("failed to build codec: %w", err)
+	}
+
+	return codec, nil
+}
+
 // registerFilterIfNotExists registers a filter for the given event if it doesn't already exist.
 func (a *SolanaAccessor) registerFilterIfNotExists(
 	ctx context.Context,
@@ -173,13 +209,13 @@ func (a *SolanaAccessor) registerFilterIfNotExists(
 // chainaccessor.SendRequestedEvent. This function is idempotent and performs a
 // one-to-one mapping of event fields from the Solana format to the standard CCIP format.
 func (a *SolanaAccessor) convertCCIPMessageSent(ctx context.Context, logs []logpollertypes.Log, onrampAddr solana.PublicKey) ([]*chainaccessor.SendRequestedEvent, error) {
-	iter, err := a.decodeLogsIntoSequences(ctx, logs, &ccip.EventCCIPMessageSent{})
+	iter, err := a.decodeLogsIntoSequences(ctx, consts.EventNameCCIPMessageSent, logs, &ccip.EventCCIPMessageSent{})
 	if err != nil {
 		return nil, fmt.Errorf("failed to decode logs into sequences: %w", err)
 	}
 
 	if len(logs) != len(iter) {
-		return nil, fmt.Errorf("failed to convert all logs into generic ccip event, logs %d, events %s", len(logs), len(iter))
+		return nil, fmt.Errorf("failed to convert all logs into generic ccip event, logs %d, events %d", len(logs), len(iter))
 	}
 
 	genericEvents := make([]*chainaccessor.SendRequestedEvent, 0)
@@ -269,7 +305,7 @@ func processSubKeyPaths(cfg filterConfig) [][]string {
 func (a *SolanaAccessor) processCommitReports(
 	ctx context.Context, logs []logpollertypes.Log, ts time.Time, limit int,
 ) ([]ccipocr3.CommitPluginReportWithMeta, error) {
-	iter, err := a.decodeLogsIntoSequences(ctx, logs, &ccip.EventCommitReportAccepted{})
+	iter, err := a.decodeLogsIntoSequences(ctx, consts.EventNameCommitReportAccepted, logs, &ccip.EventCommitReportAccepted{})
 	if err != nil {
 		return nil, fmt.Errorf("failed to decode logs into sequences: %w", err)
 	}
@@ -490,7 +526,7 @@ func createExecutedMessagesKeyFilter(rangesPerChain map[ccipocr3.ChainSelector][
 }
 
 func (a *SolanaAccessor) processExecutionStateChangesEvents(ctx context.Context, logs []logpollertypes.Log, nonEmptyRangesPerChain map[ccipocr3.ChainSelector][]ccipocr3.SeqNumRange) (map[ccipocr3.ChainSelector][]ccipocr3.SeqNum, error) {
-	iter, err := a.decodeLogsIntoSequences(ctx, logs, &ccip.EventExecutionStateChanged{})
+	iter, err := a.decodeLogsIntoSequences(ctx, consts.EventNameExecutionStateChanged, logs, &ccip.EventExecutionStateChanged{})
 	if err != nil {
 		return nil, fmt.Errorf("failed to decode logs into sequences: %w", err)
 	}
@@ -545,6 +581,7 @@ func validateExecutionStateChangedEvent(
 
 func (a *SolanaAccessor) decodeLogsIntoSequences(
 	ctx context.Context,
+	eventName string,
 	logs []logpollertypes.Log,
 	into any,
 ) ([]types.Sequence, error) {
@@ -572,15 +609,17 @@ func (a *SolanaAccessor) decodeLogsIntoSequences(
 		// create a new value of the same type as 'into' for the data to be extracted to
 		sequences[idx].Data = typeVal.Interface()
 
-		if err := a.decodeLog(ctx, &logs[idx], sequences[idx].Data); err != nil {
+		if err := a.decodeLog(ctx, eventName, logs[idx], sequences[idx].Data); err != nil {
 			return nil, err
 		}
 	}
 
 	return sequences, nil
 }
 
-func (a *SolanaAccessor) decodeLog(ctx context.Context, log *logpollertypes.Log, into any) error {
-	// TODO: add decoding logic
-	return errors.New("not implemented")
+func (a *SolanaAccessor) decodeLog(ctx context.Context, eventName string, log logpollertypes.Log, into any) error {
+	if err := a.codec.Decode(ctx, log.Data, into, eventName); err != nil {
+		return fmt.Errorf("%w: failed to decode log data for event %s: %s", types.ErrInvalidType, eventName, err.Error())
+	}
+	return nil
 }

pkg/solana/ccip/chainaccessor/solana_accessor.go

@@ -11,6 +11,7 @@ import (
 	"github.com/gagliardetto/solana-go"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
+	"github.com/smartcontractkit/chainlink-common/pkg/types"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
@@ -31,11 +32,9 @@ import (
 var ErrNoBindings = errors.New("no bindings found")
 
 type AccessorLogPoller interface {
-	Start(ctx context.Context) error
 	Ready() error
 	HasFilter(context.Context, string) bool
 	RegisterFilter(context.Context, logpollertypes.Filter) error
-	UnregisterFilter(ctx context.Context, name string) error
 	FilteredLogs(context.Context, []query.Expression, query.LimitAndSort, string) ([]logpollertypes.Log, error)
 }
 
@@ -50,6 +49,7 @@ type SolanaAccessor struct {
 	bindingsMu sync.RWMutex
 	addrCodec  ccipocr3.ChainSpecificAddressCodec
 	fee        fees.Estimator
+	codec      types.RemoteCodec
 }
 
 var _ ccipocr3.ChainAccessor = (*SolanaAccessor)(nil)
@@ -61,9 +61,15 @@ func NewSolanaAccessor(
 	logPoller AccessorLogPoller,
 	fee fees.Estimator,
 	addrCodec ccipocr3.ChainSpecificAddressCodec,
-) (ccipocr3.ChainAccessor, error) {
+) (*SolanaAccessor, error) {
 	// TODO: validate state of client and logPoller (should be initialized in NewChain)
 	lggr := logger.Named(l, "SolanaAccessor")
+
+	codec, err := buildEventsCodec()
+	if err != nil {
+		return nil, fmt.Errorf("failed to build codec parsed types: %w", err)
+	}
+
 	return &SolanaAccessor{
 		lggr:          lggr,
 		chainSelector: chainSelector,
@@ -73,6 +79,7 @@ func NewSolanaAccessor(
 		bindingsMu:    sync.RWMutex{},
 		fee:           fee,
 		addrCodec:     addrCodec,
+		codec:         codec,
 	}, nil
 }