Add TransactionLifecycleID by dimriou · Pull Request #396 · smartcontractkit/chainlink-evm

dimriou · 2026-03-23T14:20:52Z

This PR adds TransactionLifecycleID to txmv2 and enables it both for v1 and v2 for the dual broadcast relayer.

Depends on: Rename TracingID to TransactionLifecycleID chainlink-framework#95

github-actions · 2026-03-23T14:23:12Z

✅ API Diff Results - `github.com/smartcontractkit/chainlink-evm`

✅ Compatible Changes (2)

`pkg/txm/types.(*Transaction)` (1)

GetTransactionLifecycleID — ➕ Added

`pkg/txm/types.TxMeta` (1)

TransactionLifecycleID — ➕ Added

📄 View full apidiff report

pkg/txm/txm.go

cll-gg · 2026-03-23T18:00:04Z

pkg/transmitter/dual_contract_transmitter.go

 	return nil
 }

+func generateTracingIDForOCR2(configDigest ocrtypes.ConfigDigest, epoch uint32, round uint8) string {


Could make sense to add a quick test for this function, just to be 100% sure

cll-gg · 2026-03-23T18:01:34Z

pkg/txm/types/transaction.go

+	if meta != nil && meta.TracingID != nil {
+		return *meta.TracingID
+	}
+	return ""


Maybe unknown is clearer? It will differentiate it from the error case

I don't think unknown is consistent. I'd rather have it empty, or probably not log the field at all if it's nil in a future PR.

Fair, I do think it would be nice to differentiate between the unknown/unset situation and the error situation though

Sure, but we shouldn't relay an error in an unrelated log field just because the underlying method happened to fail. That was the intention of the error log above. Each time you'll make the call you'll see the empty field but you'll also see the failed to get meta of the transaction message. If you feel there is a better way to handle this, happy to discuss.

I'm not completely following this. Let's say we grep the logs for broadcasted transactions by querying e.g. <logs> |= "Broadcasted attempt". We will then see a number of broadcasts with their tracing ID attached. Then we can do a new search with <logs> | tracingID="<tracingID>".

However, if tracing ID is empty, then we don't know what happened: is it actually not set or were we unable to retrieve Meta? We won't see the failed to get meta of the transaction log line because we've already scoped the query to Broadcasted attempt.

Anyway, I'm fine leaving it like this since there's a very low chance GetMeta() returns an error, this would only happen on malformed json.

Yes, if you filter specifically with <logs> |= "Broadcasted attempt" you won't see it, but if you filter for the TXM logs, which is usually what we do, you'll be able to see a bunch of errors explaining the issue. If you're expecting a tracingID value and it's not there it's somewhat easy to infer what happened. Overall, I see the point, it's just I don't want to pollute the implementation with a custom handling for such an edge case, while we can retrieve the information by another log

Also this might be eventually split up to individual fields i.e. configDigest, epoch, round

That's true. Ok let's leave it like this

cll-gg · 2026-03-23T18:02:04Z

pkg/txm/types/transaction.go

 	return &m, nil
 }

+func (t *Transaction) GetTracingID(lggr logger.SugaredLogger) string {


Unfortunate that we have to pass the logger but I also don't see any better option

Yes, I struggled to find a good way to do this, but v1's GetMeta already does that so I just went with it.

cll-gg · 2026-03-23T18:05:02Z

pkg/txm/txm.go

+		select {
+		case triggerCh <- struct{}{}:
+		default:
+		}


Can't fully oversee the consequences of this change, can you explain this a bit?

Yes, this is the default way in go to not block the caller and just fill the channel and exit. Before we would (mistakenly) block after the buffer was filled. The old way may impact throughput on some rare cases, hence the change.

Copilot

Pull request overview

Adds a transaction tracing ID to support end-to-end correlation from OCR transmit through TXM lifecycle and dual-broadcast relaying.

Changes:

Introduces TracingID in TX meta and helpers to extract/log it across TXM components.
Updates TX string formatting/tests to avoid double-escaped meta fields in structured logs.
Generates and attaches an OCR2-derived tracing ID in the dual contract transmitter; bumps chainlink-framework/chains dependency.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
pkg/txm/types/transaction.go	Adds `TracingID` to `TxMeta`, improves `Transaction.String()`, and introduces `GetTracingID`.
pkg/txm/types/transaction_test.go	Extends tests to validate string/meta formatting and JSON-encoding behavior in logs.
pkg/txm/txm.go	Logs tracing IDs on create/broadcast/confirm; makes trigger signaling non-blocking.
pkg/txm/clientwrappers/dualbroadcast/meta_client.go	Includes tracing ID in dual-broadcast interception log.
pkg/transmitter/dual_contract_transmitter.go	Generates OCR2 tracing IDs, attaches them to tx meta, and logs transmit/create events.
pkg/transmitter/dual_contract_transmitter_test.go	Adds unit test for OCR2 tracing ID generation.
go.mod	Bumps `chainlink-framework/chains` version.
go.sum	Updates checksums for the bumped dependency.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/transmitter/dual_contract_transmitter.go

pkg/txm/types/transaction.go

pkg/txm/txm.go

augustbleeds · 2026-03-24T14:26:29Z

pkg/transmitter/dual_contract_transmitter.go

 }

+func generateTracingIDForOCR2(reportTimestamp ocrtypes.ReportTimestamp) string {
+	return fmt.Sprintf("0x%s:%d:%d", reportTimestamp.ConfigDigest.Hex(), reportTimestamp.Epoch, reportTimestamp.Round)


the config digest captures the aggregator address right?

Not directly, but it's encapsulated.

augustbleeds

what's the main debugging path you'll use for this -- figuring out what happened to transmissions where primary succeeded but secondary failed?

dimriou · 2026-03-24T14:35:19Z

what's the main debugging path you'll use for this -- figuring out what happened to transmissions where primary succeeded but secondary failed?

Two things:

being able to quickly debug logs for a given transmission end to end (both primary & secondary).
understanding the parts of the code that are considered "checkpoints" for transmission and what information we can expose so we can create metrics/fire alerts in a following PR.

pkg/transmitter/dual_contract_transmitter.go

pkg/txm/txm.go

Add tracing ID

8a0cfba

github-advanced-security bot found potential problems Mar 23, 2026

View reviewed changes

pkg/txm/txm.go Fixed Show fixed Hide fixed

dimriou added 2 commits March 23, 2026 17:58

Update tracingID

b5f7f01

Improve logs

16775bb

github-advanced-security bot found potential problems Mar 23, 2026

View reviewed changes

pkg/txm/txm.go Fixed Show fixed Hide fixed

dimriou force-pushed the transaction_tracing branch from c890fb8 to 16775bb Compare March 23, 2026 17:26

cll-gg reviewed Mar 23, 2026

View reviewed changes

dimriou added 2 commits March 24, 2026 14:55

Update framework dep

e877780

Add tracingID to transaction creation

d9b80dd

dimriou force-pushed the transaction_tracing branch from 912d9bf to d9b80dd Compare March 24, 2026 13:33

Update tracing id signature

32a7fdb

dimriou marked this pull request as ready for review March 24, 2026 14:01

Copilot AI review requested due to automatic review settings March 24, 2026 14:01

dimriou requested review from a team as code owners March 24, 2026 14:01

product-security-plaid-production bot requested review from Oozyx, ilija42 and silaslenihan March 24, 2026 14:01

Copilot started reviewing on behalf of dimriou March 24, 2026 14:02 View session

Revert meta change

4272a55

Copilot AI reviewed Mar 24, 2026

View reviewed changes

pkg/transmitter/dual_contract_transmitter.go Outdated Show resolved Hide resolved

pkg/txm/types/transaction.go Show resolved Hide resolved

pkg/txm/types/transaction.go Show resolved Hide resolved

pkg/txm/txm.go Outdated Show resolved Hide resolved

dimriou added 3 commits March 24, 2026 16:12

Update transmit log

23622b1

Update transmit log

49a6329

Remove test for reverted change

5f49972

augustbleeds reviewed Mar 24, 2026

View reviewed changes

augustbleeds previously approved these changes Mar 24, 2026

View reviewed changes

jmank88 reviewed Mar 25, 2026

View reviewed changes

pkg/transmitter/dual_contract_transmitter.go Outdated Show resolved Hide resolved

dimriou changed the title ~~Add tracing ID~~ Add TransactionLifecycleID Mar 26, 2026

Rename tracingID to transactionLifecycleID

9810ef8

dimriou dismissed augustbleeds’s stale review via 9810ef8 March 26, 2026 14:57

github-advanced-security bot found potential problems Mar 26, 2026

View reviewed changes

pkg/txm/txm.go Dismissed Show dismissed Hide dismissed

Merge branch 'develop' into transaction_tracing

d762a11

dimriou requested a review from jmank88 March 26, 2026 16:18

jmank88 approved these changes Mar 26, 2026

View reviewed changes

dimriou requested a review from augustbleeds March 26, 2026 17:05

Conversation

dimriou commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ API Diff Results - github.com/smartcontractkit/chainlink-evm

✅ Compatible Changes (2)

pkg/txm/types.(*Transaction) (1)

pkg/txm/types.TxMeta (1)

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

augustbleeds left a comment

Choose a reason for hiding this comment

Uh oh!

dimriou commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dimriou commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 23, 2026 •

edited

Loading

✅ API Diff Results - `github.com/smartcontractkit/chainlink-evm`

`pkg/txm/types.(*Transaction)` (1)

`pkg/txm/types.TxMeta` (1)

dimriou commented Mar 24, 2026 •

edited

Loading