diff --git a/wasmbinding/bindings/msg.go b/wasmbinding/bindings/msg.go index 92c92c779..2a7df315b 100644 --- a/wasmbinding/bindings/msg.go +++ b/wasmbinding/bindings/msg.go @@ -42,11 +42,11 @@ type NeutronMsg struct { /// that they are the admin of. /// Currently, the burn from address must be the admin contract. BurnTokens *BurnTokens `json:"burn_tokens,omitempty"` - /// Contracts can set before send hook for an existing factory denom + /// Contracts can set a before-send hook for an existing factory denom /// that they are the admin of. - /// Currently, the set before hook call should be performed from address that must be the admin contract. + /// Currently, the before-send hook must be set by the admin contract. SetBeforeSendHook *SetBeforeSendHook `json:"set_before_send_hook,omitempty"` - /// Force transferring of a specific denom is only allowed for the creator of the denom registered during CreateDenom. + /// Force-transferring a specific denom is only allowed for the admin of the denom. ForceTransfer *ForceTransfer `json:"force_transfer,omitempty"` /// Setting of metadata for a specific denom is only allowed for the admin of the denom. /// It allows the overwriting of the denom metadata in the bank module. @@ -171,19 +171,19 @@ type BurnTokens struct { BurnFromAddress string `json:"burn_from_address"` } -// SetBeforeSendHook Allowing to assign a CosmWasm contract to call with a BeforeSend hook for a specific denom is only -// allowed for the creator of the denom registered during CreateDenom. +// SetBeforeSendHook assigns a CosmWasm contract as the BeforeSend hook for a specific denom. +// Only the denom admin can set it. type SetBeforeSendHook struct { Denom string `json:"denom"` ContractAddr string `json:"contract_addr"` } -// SetDenomMetadata is sets the denom's bank metadata +// SetDenomMetadata sets the denom's bank metadata. type SetDenomMetadata struct { banktypes.Metadata } -// ForceTransfer forces transferring of a specific denom is only allowed for the creator of the denom registered during CreateDenom. +// ForceTransfer force-transfers a specific denom. Only the denom admin can perform this action. type ForceTransfer struct { Denom string `json:"denom"` Amount math.Int `json:"amount"` diff --git a/wasmbinding/message_plugin.go b/wasmbinding/message_plugin.go index 883887255..bfd6c5664 100644 --- a/wasmbinding/message_plugin.go +++ b/wasmbinding/message_plugin.go @@ -463,7 +463,7 @@ func PerformCreateDenom(f *tokenfactorykeeper.Keeper, ctx sdk.Context, contractA return nil } -// createDenom forces a transfer of a tokenFactory token +// forceTransfer forces a transfer of a tokenfactory token. func (m *CustomMessenger) forceTransfer(ctx sdk.Context, contractAddr sdk.AccAddress, forceTransfer *bindings.ForceTransfer) ([]sdk.Event, [][]byte, [][]*types.Any, error) { err := PerformForceTransfer(m.TokenFactory, ctx, contractAddr, forceTransfer) if err != nil { diff --git a/x/coinfactory/types/msgs.go b/x/coinfactory/types/msgs.go index f7d2e0e0d..25dcc8c64 100644 --- a/x/coinfactory/types/msgs.go +++ b/x/coinfactory/types/msgs.go @@ -151,7 +151,7 @@ func (m MsgBurn) GetSigners() []sdk.AccAddress { var _ sdk.Msg = &MsgForceTransfer{} -// NewMsgForceTransfer creates a transfer funds from one account to another +// NewMsgForceTransfer creates a message to force-transfer funds from one account to another. func NewMsgForceTransfer(sender string, amount sdk.Coin, fromAddr, toAddr string) *MsgForceTransfer { return &MsgForceTransfer{ Sender: sender, @@ -196,7 +196,7 @@ func (m MsgForceTransfer) GetSigners() []sdk.AccAddress { var _ sdk.Msg = &MsgChangeAdmin{} -// NewMsgChangeAdmin creates a message to burn tokens +// NewMsgChangeAdmin creates a message to change the admin of a denom. func NewMsgChangeAdmin(sender, denom, newAdmin string) *MsgChangeAdmin { return &MsgChangeAdmin{ Sender: sender, diff --git a/x/tokenfactory/types/msgs.go b/x/tokenfactory/types/msgs.go index f7d2e0e0d..25dcc8c64 100644 --- a/x/tokenfactory/types/msgs.go +++ b/x/tokenfactory/types/msgs.go @@ -151,7 +151,7 @@ func (m MsgBurn) GetSigners() []sdk.AccAddress { var _ sdk.Msg = &MsgForceTransfer{} -// NewMsgForceTransfer creates a transfer funds from one account to another +// NewMsgForceTransfer creates a message to force-transfer funds from one account to another. func NewMsgForceTransfer(sender string, amount sdk.Coin, fromAddr, toAddr string) *MsgForceTransfer { return &MsgForceTransfer{ Sender: sender, @@ -196,7 +196,7 @@ func (m MsgForceTransfer) GetSigners() []sdk.AccAddress { var _ sdk.Msg = &MsgChangeAdmin{} -// NewMsgChangeAdmin creates a message to burn tokens +// NewMsgChangeAdmin creates a message to change the admin of a denom. func NewMsgChangeAdmin(sender, denom, newAdmin string) *MsgChangeAdmin { return &MsgChangeAdmin{ Sender: sender,