Skip to content

Commit

Permalink
docs(logic): update proto docs with new tx
Browse files Browse the repository at this point in the history
  • Loading branch information
bdeneux committed Mar 27, 2023
1 parent 16435d2 commit 2d613dd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
22 changes: 22 additions & 0 deletions docs/proto/logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,9 @@ utilized within a query, or limiting the depth of the backtracking algorithm.
- [QueryService](#logic.v1beta2.QueryService)

- [logic/v1beta2/tx.proto](#logic/v1beta2/tx.proto)
- [MsgUpdateParams](#logic.v1beta2.MsgUpdateParams)
- [MsgUpdateParamsResponse](#logic.v1beta2.MsgUpdateParamsResponse)

- [MsgService](#logic.v1beta2.MsgService)

- [Scalar Value Types](#scalar-value-types)
Expand Down Expand Up @@ -420,6 +423,24 @@ QueryService defines the gRPC querier service.

## logic/v1beta2/tx.proto

<a name="logic.v1beta2.MsgUpdateParams"></a>

### MsgUpdateParams

MsgUpdateParams defines a Msg for updating the x/logic module parameters.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `authority` | [string](#string) | | authority is the address of the governance account. |
| `params` | [Params](#logic.v1beta2.Params) | | params defines the x/logic parameters to update. NOTE: All parameters must be supplied. |

<a name="logic.v1beta2.MsgUpdateParamsResponse"></a>

### MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a
MsgUpdateParams message.

[//]: # (end messages)

[//]: # (end enums)
Expand All @@ -435,6 +456,7 @@ Do nothing for now as the service is without any side effects.

| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint |
| ----------- | ------------ | ------------- | ------------| ------- | -------- |
| `UpdateParams` | [MsgUpdateParams](#logic.v1beta2.MsgUpdateParams) | [MsgUpdateParamsResponse](#logic.v1beta2.MsgUpdateParamsResponse) | UpdateParams defined a governance operation for updating the x/logic module parameters. The authority is hard-coded to the Cosmos SDK x/gov module account | |

[//]: # (end services)

Expand Down
2 changes: 1 addition & 1 deletion proto/logic/v1beta2/tx.proto
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ service MsgService {
}


// MsgUpdateParams defines a Msg for updating the x/incentives module parameters.
// MsgUpdateParams defines a Msg for updating the x/logic module parameters.
message MsgUpdateParams {
option (cosmos.msg.v1.signer) = "authority";
// authority is the address of the governance account.
Expand Down
2 changes: 1 addition & 1 deletion x/logic/types/tx.pb.go

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

0 comments on commit 2d613dd

Please sign in to comment.