Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: remove Request suffix in Msgs #422

Merged
merged 7 commits into from
Jul 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions buf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ lint:
- COMMENTS
except:
- SERVICE_SUFFIX
- RPC_REQUEST_STANDARD_NAME
ignore:
- cosmos
- gogoproto
Expand Down
34 changes: 17 additions & 17 deletions docs/modules/data/protobuf.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@
- [Query](#regen.data.v1alpha2.Query)

- [regen/data/v1alpha2/tx.proto](#regen/data/v1alpha2/tx.proto)
- [MsgAnchorDataRequest](#regen.data.v1alpha2.MsgAnchorDataRequest)
- [MsgAnchorData](#regen.data.v1alpha2.MsgAnchorData)
- [MsgAnchorDataResponse](#regen.data.v1alpha2.MsgAnchorDataResponse)
- [MsgSignDataRequest](#regen.data.v1alpha2.MsgSignDataRequest)
- [MsgSignData](#regen.data.v1alpha2.MsgSignData)
- [MsgSignDataResponse](#regen.data.v1alpha2.MsgSignDataResponse)
- [MsgStoreRawDataRequest](#regen.data.v1alpha2.MsgStoreRawDataRequest)
- [MsgStoreRawData](#regen.data.v1alpha2.MsgStoreRawData)
- [MsgStoreRawDataResponse](#regen.data.v1alpha2.MsgStoreRawDataResponse)

- [Msg](#regen.data.v1alpha2.Msg)
Expand Down Expand Up @@ -435,10 +435,10 @@ Query is the regen.data.v1alpha2 Query service



<a name="regen.data.v1alpha2.MsgAnchorDataRequest"></a>
<a name="regen.data.v1alpha2.MsgAnchorData"></a>

### MsgAnchorDataRequest
MsgAnchorDataRequest is the Msg/AnchorData request type.
### MsgAnchorData
MsgAnchorData is the Msg/AnchorData request type.


| Field | Type | Label | Description |
Expand All @@ -454,7 +454,7 @@ MsgAnchorDataRequest is the Msg/AnchorData request type.
<a name="regen.data.v1alpha2.MsgAnchorDataResponse"></a>

### MsgAnchorDataResponse
MsgAnchorDataRequest is the Msg/AnchorData response type.
MsgAnchorData is the Msg/AnchorData response type.


| Field | Type | Label | Description |
Expand All @@ -466,10 +466,10 @@ MsgAnchorDataRequest is the Msg/AnchorData response type.



<a name="regen.data.v1alpha2.MsgSignDataRequest"></a>
<a name="regen.data.v1alpha2.MsgSignData"></a>

### MsgSignDataRequest
MsgSignDataRequest is the Msg/SignData request type.
### MsgSignData
MsgSignData is the Msg/SignData request type.


| Field | Type | Label | Description |
Expand All @@ -492,10 +492,10 @@ MsgSignDataResponse is the Msg/SignData response type.



<a name="regen.data.v1alpha2.MsgStoreRawDataRequest"></a>
<a name="regen.data.v1alpha2.MsgStoreRawData"></a>

### MsgStoreRawDataRequest
MsgStoreRawDataRequest is the Msg/StoreRawData request type.
### MsgStoreRawData
MsgStoreRawData is the Msg/StoreRawData request type.


| Field | Type | Label | Description |
Expand All @@ -512,7 +512,7 @@ MsgStoreRawDataRequest is the Msg/StoreRawData request type.
<a name="regen.data.v1alpha2.MsgStoreRawDataResponse"></a>

### MsgStoreRawDataResponse
MsgStoreRawDataRequest is the Msg/StoreRawData response type.
MsgStoreRawData is the Msg/StoreRawData response type.



Expand All @@ -532,17 +532,17 @@ Msg is the regen.data.v1alpha1 Msg service

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| AnchorData | [MsgAnchorDataRequest](#regen.data.v1alpha2.MsgAnchorDataRequest) | [MsgAnchorDataResponse](#regen.data.v1alpha2.MsgAnchorDataResponse) | AnchorData "anchors" a piece of data to the blockchain based on its secure hash, effectively providing a tamper resistant timestamp.
| AnchorData | [MsgAnchorData](#regen.data.v1alpha2.MsgAnchorData) | [MsgAnchorDataResponse](#regen.data.v1alpha2.MsgAnchorDataResponse) | AnchorData "anchors" a piece of data to the blockchain based on its secure hash, effectively providing a tamper resistant timestamp.

The sender in AnchorData is not attesting to the veracity of the underlying data. They can simply be a intermediary providing timestamp services. SignData should be used to create a digital signature attesting to the veracity of some piece of data. |
| SignData | [MsgSignDataRequest](#regen.data.v1alpha2.MsgSignDataRequest) | [MsgSignDataResponse](#regen.data.v1alpha2.MsgSignDataResponse) | SignData allows for signing of an arbitrary piece of data on the blockchain. By "signing" data the signers are making a statement about the veracity of the data itself. It is like signing a legal document, meaning that I agree to all conditions and to the best of my knowledge everything is true. When anchoring data, the sender is not attesting to the veracity of the data, they are simply communicating that it exists.
| SignData | [MsgSignData](#regen.data.v1alpha2.MsgSignData) | [MsgSignDataResponse](#regen.data.v1alpha2.MsgSignDataResponse) | SignData allows for signing of an arbitrary piece of data on the blockchain. By "signing" data the signers are making a statement about the veracity of the data itself. It is like signing a legal document, meaning that I agree to all conditions and to the best of my knowledge everything is true. When anchoring data, the sender is not attesting to the veracity of the data, they are simply communicating that it exists.

On-chain signatures have the following benefits: - on-chain identities can be managed using different cryptographic keys that change over time through key rotation practices - an on-chain identity may represent an organization and through delegation individual members may sign on behalf of the group - the blockchain transaction envelope provides built-in replay protection and timestamping

SignData implicitly calls AnchorData if the data was not already anchored.

SignData can be called multiple times for the same content hash with different signers and those signers will be appended to the list of signers. |
| StoreRawData | [MsgStoreRawDataRequest](#regen.data.v1alpha2.MsgStoreRawDataRequest) | [MsgStoreRawDataResponse](#regen.data.v1alpha2.MsgStoreRawDataResponse) | StoreRawData stores a piece of raw data corresponding to an ContentHash.Raw on the blockchain.
| StoreRawData | [MsgStoreRawData](#regen.data.v1alpha2.MsgStoreRawData) | [MsgStoreRawDataResponse](#regen.data.v1alpha2.MsgStoreRawDataResponse) | StoreRawData stores a piece of raw data corresponding to an ContentHash.Raw on the blockchain.

StoreRawData implicitly calls AnchorData if the data was not already anchored.

Expand Down
Loading