Skip to content

[CRE=804] - Add tx idempotency key to EVM Service SubmitTransaction reply #1527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ilija42 merged 2 commits into from
Sep 8, 2025
Merged

[CRE=804] - Add tx idempotency key to EVM Service SubmitTransaction reply #1527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2291697
Add tx idempotency key to EVM Service SubmitTransaction reply
ilija42 Sep 7, 2025
153f6c0
Merge branch 'main' into CRE-804-submittx-txid
ilija42 Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions pkg/chains/evm/evm.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pkg/chains/evm/evm.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,7 @@ message SubmitTransactionRequest {
message SubmitTransactionReply {
bytes txHash = 1;
TxStatus txStatus = 2;
string tx_idempotency_key = 3; // idempotency key generated for this transaction
Copy link
Copy Markdown
Contributor

@patrickhuie19 patrickhuie19 Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are txHash and tx_idempotency_key related in any way? we do that for workflowExecutionIDs, and it tends to be pretty useful in scenarios when you need to forecast an execution ID

}

// TransactionStatus is an enum for the status of a transaction.
Expand Down
10 changes: 6 additions & 4 deletions pkg/loop/internal/relayer/evm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ func (e *EVMClient) SubmitTransaction(ctx context.Context, txRequest evmtypes.Su
}

return &evmtypes.TransactionResult{
TxStatus: evmpb.ConvertTxStatusFromProto(reply.TxStatus),
TxHash: evmtypes.Hash(reply.TxHash),
TxStatus: evmpb.ConvertTxStatusFromProto(reply.TxStatus),
TxHash: evmtypes.Hash(reply.TxHash),
TxIdempotencyKey: reply.TxIdempotencyKey,
}, nil
}

Expand Down Expand Up @@ -514,8 +515,9 @@ func (e *evmServer) SubmitTransaction(ctx context.Context, request *evmpb.Submit
return nil, err
}
return &evmpb.SubmitTransactionReply{
TxHash: txResult.TxHash[:],
TxStatus: evmpb.ConvertTxStatusToProto(txResult.TxStatus),
TxHash: txResult.TxHash[:],
TxStatus: evmpb.ConvertTxStatusToProto(txResult.TxStatus),
TxIdempotencyKey: txResult.TxIdempotencyKey,
}, nil
}

Expand Down
5 changes: 3 additions & 2 deletions pkg/loop/internal/relayerset/evm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,8 +411,9 @@ func (s *Server) SubmitTransaction(ctx context.Context, request *evmpb.SubmitTra
}

return &evmpb.SubmitTransactionReply{
TxHash: txResult.TxHash[:],
TxStatus: evmpb.ConvertTxStatusToProto(txResult.TxStatus),
TxHash: txResult.TxHash[:],
TxStatus: evmpb.ConvertTxStatusToProto(txResult.TxStatus),
TxIdempotencyKey: txResult.TxIdempotencyKey,
}, nil
}

Expand Down
5 changes: 3 additions & 2 deletions pkg/types/chains/evm/evm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ func (e *TxError) Error() string {

// PLEX-1524 - Refactor this to return the Tx Hash in a Transaction type and a second return value for the TxStatus. We may even be able to return the whole transaction object instead of just the hash.
type TransactionResult struct {
TxStatus TransactionStatus
TxHash Hash
TxStatus TransactionStatus
TxHash Hash
TxIdempotencyKey string // Idempotency key used for tracking purposes of transactions.
}

type GasConfig struct {
Expand Down
Loading