feat: add comments for the events of bridge module

proto/greenfield/bridge/event.proto

@@ -7,24 +7,40 @@ import "cosmos/base/v1beta1/coin.proto";
 
 option go_package = "github.com/bnb-chain/greenfield/x/bridge/types";
 
+// EventCrossTransferOut is emitted when a cross chain transfer out tx created
 message EventCrossTransferOut {
+  // From addres of the cross chain transfer tx
   string from = 1;
+  // To addres of the cross chain transfer tx
   string to = 2;
+  // Amount of the cross chain transfer tx
   cosmos.base.v1beta1.Coin amount = 3;
+  // Relayer fee of the cross chain transfer tx
   cosmos.base.v1beta1.Coin relayer_fee = 4;
+  // Sequence of the corresponding cross chain package
   uint64 sequence = 5;
 }
 
+// EventCrossTransferOutRefund is emitted when a cross chain transfer out tx failed
 message EventCrossTransferOutRefund {
+  // Refund address of the failed cross chain transfer tx
   string refund_address = 1;
+  // Amount of the failed cross chain transfer tx
   cosmos.base.v1beta1.Coin amount = 2;
+  // Refund reason of the failed cross chain transfer tx
   uint32 refund_reason = 3;
+  // Sequence of the corresponding cross chain package
   uint64 sequence = 4;
 }
 
+// EventCrossTransferIn is emitted when a cross chain transfer in tx happened
 message EventCrossTransferIn {
+  // Amount of the cross chain transfer tx
   cosmos.base.v1beta1.Coin amount = 1;
+  // Receiver of the cross chain transfer tx
   string receiver_address = 2;
+  // Refund of the cross chain transfer tx in BSC
   string refund_address = 3;
+  // Sequence of the corresponding cross chain package
   uint64 sequence = 4;
 }

proto/greenfield/bridge/genesis.proto

@@ -9,6 +9,7 @@ option go_package = "github.com/bnb-chain/greenfield/x/bridge/types";
 
 // GenesisState defines the bridge module's genesis state.
 message GenesisState {
+  // Params defines all the paramaters of the module.
   Params params = 1 [(gogoproto.nullable) = false];
   // this line is used by starport scaffolding # genesis/proto/state
 }

proto/greenfield/bridge/params.proto

@@ -7,6 +7,8 @@ option go_package = "github.com/bnb-chain/greenfield/x/bridge/types";
 
 // Params defines the parameters for the module.
 message Params {
+  // Relayer fee for the cross chain transfer out tx
   string transfer_out_relayer_fee = 1;
+  // Relayer fee for the ACK or FAIL_ACK package of the cross chain transfer out tx
   string transfer_out_ack_relayer_fee = 2;
 }

proto/greenfield/bridge/tx.proto

@@ -13,12 +13,14 @@ service Msg {
 // this line is used by starport scaffolding # proto/tx/rpc
 }
 
+// MsgTransferOut is the Msg/TransferOut request type.
 message MsgTransferOut {
   string from = 1;
   string to = 2;
   cosmos.base.v1beta1.Coin amount = 3;
 }
 
+// MsgTransferOutResponse is the Msg/TransferOut response type.
 message MsgTransferOutResponse {
 }