From 1b0fcdc9f059419328ed2b6b2393320fb042270f Mon Sep 17 00:00:00 2001 From: Matt Kocubinski Date: Tue, 11 Jul 2023 12:23:42 -0500 Subject: [PATCH] docs(x/auth): improve godoc for `GetSigningTxData` (#16933) --- x/auth/tx/adapter.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/x/auth/tx/adapter.go b/x/auth/tx/adapter.go index b13848d8aa49..50081fdbde33 100644 --- a/x/auth/tx/adapter.go +++ b/x/auth/tx/adapter.go @@ -13,7 +13,10 @@ import ( ) // GetSigningTxData returns an x/tx/signing.TxData representation of a transaction for use in the signing -// API defined in x/tx. +// API defined in x/tx. The reason for all of this conversion is that x/tx depends on the protoreflect API +// defined in google.golang.org/protobuf while x/auth/tx depends on the legacy proto API defined in +// github.com/gogo/protobuf and the downstream SDK fork of that library, github.com/cosmos/gogoproto. +// Therefore we need to convert between the two APIs. func (w *wrapper) GetSigningTxData() txsigning.TxData { body := w.tx.Body authInfo := w.tx.AuthInfo