From aeebe619fbf0c5399fb08ad1ffc64e0031826c65 Mon Sep 17 00:00:00 2001 From: David Terpay <35130517+davidterpay@users.noreply.github.com> Date: Mon, 27 Nov 2023 17:10:43 -0500 Subject: [PATCH] fix: String representation of escrow address (#238) * greedy approach to lane verification * docs * base lane testing * mev lane testing nits * abci top level testing done * network spamming in E2E * string rep of escrow address * nit * removing logs from testing * query test (cherry picked from commit 736b2d3997f417d6ea04ebeebba6aeb6f86ecdca) --- proto/sdk/auction/v1/query.proto | 5 +- x/auction/keeper/grpc_query.go | 3 +- x/auction/keeper/grpc_query_test.go | 21 +++++++ x/auction/keeper/keeper_test.go | 5 +- x/auction/types/query.pb.go | 98 ++++++++++++++++++++++------- 5 files changed, 108 insertions(+), 24 deletions(-) create mode 100644 x/auction/keeper/grpc_query_test.go diff --git a/proto/sdk/auction/v1/query.proto b/proto/sdk/auction/v1/query.proto index 2eaa41c8..652a3195 100644 --- a/proto/sdk/auction/v1/query.proto +++ b/proto/sdk/auction/v1/query.proto @@ -22,6 +22,9 @@ message QueryParamsRequest {} // QueryParamsResponse is the response type for the Query/Params RPC method. message QueryParamsResponse { - // params defines the parameters of the module. + // Params defines the parameters of the module. Params params = 1 [ (gogoproto.nullable) = false ]; + // EscrowAddressString is the string representation of the escrow address stored + // in params. + string escrow_address_string = 2; } \ No newline at end of file diff --git a/x/auction/keeper/grpc_query.go b/x/auction/keeper/grpc_query.go index 95a25123..58891910 100644 --- a/x/auction/keeper/grpc_query.go +++ b/x/auction/keeper/grpc_query.go @@ -29,5 +29,6 @@ func (q QueryServer) Params(c context.Context, _ *types.QueryParamsRequest) (*ty return nil, err } - return &types.QueryParamsResponse{Params: params}, nil + escrowAddress := sdk.AccAddress(params.EscrowAccountAddress) + return &types.QueryParamsResponse{Params: params, EscrowAddressString: escrowAddress.String()}, nil } diff --git a/x/auction/keeper/grpc_query_test.go b/x/auction/keeper/grpc_query_test.go new file mode 100644 index 00000000..a124a228 --- /dev/null +++ b/x/auction/keeper/grpc_query_test.go @@ -0,0 +1,21 @@ +package keeper_test + +import ( + sdk "github.com/cosmos/cosmos-sdk/types" + + "github.com/skip-mev/block-sdk/x/auction/types" +) + +func (s *KeeperTestSuite) TestQueryParams() { + s.Run("can query module params", func() { + params, err := s.auctionkeeper.GetParams(s.ctx) + s.Require().NoError(err) + + escrowAddress := sdk.AccAddress(params.EscrowAccountAddress) + + res, err := s.queryServer.Params(s.ctx, &types.QueryParamsRequest{}) + s.Require().NoError(err) + s.Require().Equal(params, res.Params) + s.Require().Equal(escrowAddress.String(), res.EscrowAddressString) + }) +} diff --git a/x/auction/keeper/keeper_test.go b/x/auction/keeper/keeper_test.go index f77fc70d..37967021 100644 --- a/x/auction/keeper/keeper_test.go +++ b/x/auction/keeper/keeper_test.go @@ -25,9 +25,11 @@ type KeeperTestSuite struct { stakingKeeper *mocks.StakingKeeper encCfg testutils.EncodingConfig ctx sdk.Context - msgServer types.MsgServer key *storetypes.KVStoreKey authorityAccount sdk.AccAddress + + msgServer types.MsgServer + queryServer types.QueryServer } func TestKeeperTestSuite(t *testing.T) { @@ -61,4 +63,5 @@ func (s *KeeperTestSuite) SetupTest() { s.Require().NoError(err) s.msgServer = keeper.NewMsgServerImpl(s.auctionkeeper) + s.queryServer = keeper.NewQueryServer(s.auctionkeeper) } diff --git a/x/auction/types/query.pb.go b/x/auction/types/query.pb.go index 439aab98..a2b2b4a4 100644 --- a/x/auction/types/query.pb.go +++ b/x/auction/types/query.pb.go @@ -69,8 +69,11 @@ var xxx_messageInfo_QueryParamsRequest proto.InternalMessageInfo // QueryParamsResponse is the response type for the Query/Params RPC method. type QueryParamsResponse struct { - // params defines the parameters of the module. + // Params defines the parameters of the module. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"` + // EscrowAddressString is the string representation of the escrow address stored + // in params. + EscrowAddressString string `protobuf:"bytes,2,opt,name=escrow_address_string,json=escrowAddressString,proto3" json:"escrow_address_string,omitempty"` } func (m *QueryParamsResponse) Reset() { *m = QueryParamsResponse{} } @@ -113,6 +116,13 @@ func (m *QueryParamsResponse) GetParams() Params { return Params{} } +func (m *QueryParamsResponse) GetEscrowAddressString() string { + if m != nil { + return m.EscrowAddressString + } + return "" +} + func init() { proto.RegisterType((*QueryParamsRequest)(nil), "sdk.auction.v1.QueryParamsRequest") proto.RegisterType((*QueryParamsResponse)(nil), "sdk.auction.v1.QueryParamsResponse") @@ -121,26 +131,29 @@ func init() { func init() { proto.RegisterFile("sdk/auction/v1/query.proto", fileDescriptor_47f76418be29a6d6) } var fileDescriptor_47f76418be29a6d6 = []byte{ - // 303 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xe2, 0x92, 0x2a, 0x4e, 0xc9, 0xd6, - 0x4f, 0x2c, 0x4d, 0x2e, 0xc9, 0xcc, 0xcf, 0xd3, 0x2f, 0x33, 0xd4, 0x2f, 0x2c, 0x4d, 0x2d, 0xaa, - 0xd4, 0x2b, 0x28, 0xca, 0x2f, 0xc9, 0x17, 0xe2, 0x2b, 0x4e, 0xc9, 0xd6, 0x83, 0xca, 0xe9, 0x95, - 0x19, 0x4a, 0x89, 0xa4, 0xe7, 0xa7, 0xe7, 0x83, 0xa5, 0xf4, 0x41, 0x2c, 0x88, 0x2a, 0x29, 0x99, - 0xf4, 0xfc, 0xfc, 0xf4, 0x9c, 0x54, 0xfd, 0xc4, 0x82, 0x4c, 0xfd, 0xc4, 0xbc, 0xbc, 0xfc, 0x92, - 0x44, 0x90, 0xfa, 0x62, 0xa8, 0xac, 0x74, 0x72, 0x7e, 0x71, 0x6e, 0x7e, 0x31, 0xc4, 0x5c, 0x34, - 0x0b, 0xa4, 0x64, 0xd0, 0x2c, 0x4f, 0x4f, 0xcd, 0x4b, 0x2d, 0xce, 0x84, 0x6a, 0x55, 0x12, 0xe1, - 0x12, 0x0a, 0x04, 0x29, 0x0e, 0x48, 0x2c, 0x4a, 0xcc, 0x2d, 0x0e, 0x4a, 0x2d, 0x2c, 0x4d, 0x2d, - 0x2e, 0x51, 0xf2, 0xe6, 0x12, 0x46, 0x11, 0x2d, 0x2e, 0xc8, 0xcf, 0x2b, 0x4e, 0x15, 0x32, 0xe1, - 0x62, 0x2b, 0x00, 0x8b, 0x48, 0x30, 0x2a, 0x30, 0x6a, 0x70, 0x1b, 0x89, 0xe9, 0xa1, 0x3a, 0x5e, - 0x0f, 0xa2, 0xde, 0x89, 0xe5, 0xc4, 0x3d, 0x79, 0x86, 0x20, 0xa8, 0x5a, 0xa3, 0x56, 0x46, 0x2e, - 0x56, 0xb0, 0x69, 0x42, 0x35, 0x5c, 0x6c, 0x10, 0x15, 0x42, 0x4a, 0xe8, 0x3a, 0x31, 0x1d, 0x21, - 0xa5, 0x8c, 0x57, 0x0d, 0xc4, 0x49, 0x4a, 0x9a, 0x1d, 0xcf, 0x37, 0x68, 0x31, 0x36, 0x5d, 0x7e, - 0x32, 0x99, 0x49, 0x4e, 0x48, 0x46, 0x3f, 0x29, 0x27, 0x3f, 0x39, 0x5b, 0x17, 0xcd, 0xc7, 0x10, - 0x77, 0x38, 0xb9, 0x9f, 0x78, 0x24, 0xc7, 0x78, 0xe1, 0x91, 0x1c, 0xe3, 0x83, 0x47, 0x72, 0x8c, - 0x13, 0x1e, 0xcb, 0x31, 0x5c, 0x78, 0x2c, 0xc7, 0x70, 0xe3, 0xb1, 0x1c, 0x43, 0x94, 0x6e, 0x7a, - 0x66, 0x49, 0x46, 0x69, 0x92, 0x5e, 0x72, 0x7e, 0xae, 0x7e, 0x71, 0x76, 0x66, 0x81, 0x6e, 0x6e, - 0x6a, 0x19, 0x92, 0x51, 0x15, 0x70, 0xc3, 0x4a, 0x2a, 0x0b, 0x52, 0x8b, 0x93, 0xd8, 0xc0, 0x41, - 0x67, 0x0c, 0x08, 0x00, 0x00, 0xff, 0xff, 0x23, 0x86, 0x8c, 0xe6, 0xd7, 0x01, 0x00, 0x00, + // 341 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x7c, 0x90, 0xc1, 0x4a, 0xc3, 0x40, + 0x10, 0x86, 0xb3, 0x45, 0x0b, 0x46, 0xf0, 0x90, 0x56, 0x29, 0xb1, 0xc4, 0x12, 0x2f, 0x55, 0x68, + 0x96, 0x56, 0x5f, 0xc0, 0x5e, 0xbc, 0x6a, 0xbd, 0x79, 0x29, 0xdb, 0x64, 0x59, 0x43, 0x9a, 0x4c, + 0x9a, 0xd9, 0x54, 0x0b, 0x82, 0x20, 0x08, 0x1e, 0x05, 0x5f, 0xc4, 0xc7, 0xe8, 0xb1, 0xe0, 0xc5, + 0x93, 0x48, 0x2b, 0xf8, 0x1a, 0xd2, 0x6c, 0x10, 0x1b, 0xc1, 0x5b, 0x98, 0xef, 0xcb, 0x3f, 0xff, + 0x8e, 0x6e, 0xa2, 0x17, 0x50, 0x96, 0xba, 0xd2, 0x87, 0x88, 0x8e, 0xdb, 0x74, 0x94, 0xf2, 0x64, + 0xe2, 0xc4, 0x09, 0x48, 0x30, 0xb6, 0xd0, 0x0b, 0x9c, 0x9c, 0x39, 0xe3, 0xb6, 0x59, 0x15, 0x20, + 0x20, 0x43, 0x74, 0xf9, 0xa5, 0x2c, 0xb3, 0x2e, 0x00, 0xc4, 0x90, 0x53, 0x16, 0xfb, 0x94, 0x45, + 0x11, 0x48, 0xb6, 0xf4, 0x31, 0xa7, 0xbb, 0x2e, 0x60, 0x08, 0xa8, 0x72, 0x0b, 0x0b, 0xcc, 0x7a, + 0x61, 0xb9, 0xe0, 0x11, 0x47, 0x3f, 0xff, 0xd5, 0xae, 0xea, 0xc6, 0xf9, 0x52, 0x3e, 0x63, 0x09, + 0x0b, 0xb1, 0xc7, 0x47, 0x29, 0x47, 0x69, 0xdf, 0xe9, 0x95, 0x95, 0x29, 0xc6, 0x10, 0x21, 0x37, + 0x8e, 0xf5, 0x72, 0x9c, 0x4d, 0x6a, 0xa4, 0x41, 0x9a, 0x9b, 0x9d, 0x1d, 0x67, 0xb5, 0xbc, 0xa3, + 0xfc, 0xee, 0xda, 0xf4, 0x7d, 0x4f, 0xeb, 0xe5, 0xae, 0xd1, 0xd1, 0xb7, 0x39, 0xba, 0x09, 0x5c, + 0xf7, 0x99, 0xe7, 0x25, 0x1c, 0xb1, 0x8f, 0x32, 0xf1, 0x23, 0x51, 0x2b, 0x35, 0x48, 0x73, 0xa3, + 0x57, 0x51, 0xf0, 0x44, 0xb1, 0x8b, 0x0c, 0x75, 0x1e, 0x88, 0xbe, 0x9e, 0x35, 0x30, 0x6e, 0xf5, + 0xb2, 0x4a, 0x35, 0xec, 0xe2, 0xb6, 0xbf, 0xc5, 0xcd, 0xfd, 0x7f, 0x1d, 0xf5, 0x0c, 0xfb, 0xe0, + 0xf1, 0xeb, 0xe5, 0x90, 0xdc, 0xbf, 0x7e, 0x3e, 0x97, 0x2c, 0xa3, 0x4e, 0x07, 0x43, 0x70, 0x83, + 0x56, 0xe1, 0x4a, 0xaa, 0x7b, 0xf7, 0x74, 0x3a, 0xb7, 0xc8, 0x6c, 0x6e, 0x91, 0x8f, 0xb9, 0x45, + 0x9e, 0x16, 0x96, 0x36, 0x5b, 0x58, 0xda, 0xdb, 0xc2, 0xd2, 0x2e, 0x5b, 0xc2, 0x97, 0x57, 0xe9, + 0xc0, 0x71, 0x21, 0xa4, 0x18, 0xf8, 0x71, 0x2b, 0xe4, 0xe3, 0x5f, 0x51, 0x37, 0x3f, 0x61, 0x72, + 0x12, 0x73, 0x1c, 0x94, 0xb3, 0x73, 0x1f, 0x7d, 0x07, 0x00, 0x00, 0xff, 0xff, 0x1f, 0x3e, 0x57, + 0xb0, 0x0b, 0x02, 0x00, 0x00, } // Reference imports to suppress errors if they are not otherwise used. @@ -268,6 +281,13 @@ func (m *QueryParamsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error) { _ = i var l int _ = l + if len(m.EscrowAddressString) > 0 { + i -= len(m.EscrowAddressString) + copy(dAtA[i:], m.EscrowAddressString) + i = encodeVarintQuery(dAtA, i, uint64(len(m.EscrowAddressString))) + i-- + dAtA[i] = 0x12 + } { size, err := m.Params.MarshalToSizedBuffer(dAtA[:i]) if err != nil { @@ -309,6 +329,10 @@ func (m *QueryParamsResponse) Size() (n int) { _ = l l = m.Params.Size() n += 1 + l + sovQuery(uint64(l)) + l = len(m.EscrowAddressString) + if l > 0 { + n += 1 + l + sovQuery(uint64(l)) + } return n } @@ -430,6 +454,38 @@ func (m *QueryParamsResponse) Unmarshal(dAtA []byte) error { return err } iNdEx = postIndex + case 2: + if wireType != 2 { + return fmt.Errorf("proto: wrong wireType = %d for field EscrowAddressString", wireType) + } + var stringLen uint64 + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowQuery + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + stringLen |= uint64(b&0x7F) << shift + if b < 0x80 { + break + } + } + intStringLen := int(stringLen) + if intStringLen < 0 { + return ErrInvalidLengthQuery + } + postIndex := iNdEx + intStringLen + if postIndex < 0 { + return ErrInvalidLengthQuery + } + if postIndex > l { + return io.ErrUnexpectedEOF + } + m.EscrowAddressString = string(dAtA[iNdEx:postIndex]) + iNdEx = postIndex default: iNdEx = preIndex skippy, err := skipQuery(dAtA[iNdEx:])