Skip to content

Problem: proto doc is outdated in solomachine #315

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
264 changes: 48 additions & 216 deletions docs/resources/cosmos-grpc-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -587,25 +587,15 @@
- [ibc/core/client/v1/genesis.proto](#ibc/core/client/v1/genesis.proto)
- [GenesisState](#ibc.core.client.v1.GenesisState)

- [ibc/lightclients/solomachine/v1/solomachine.proto](#ibc/lightclients/solomachine/v1/solomachine.proto)
- [ChannelStateData](#ibc.lightclients.solomachine.v1.ChannelStateData)
- [ClientState](#ibc.lightclients.solomachine.v1.ClientState)
- [ClientStateData](#ibc.lightclients.solomachine.v1.ClientStateData)
- [ConnectionStateData](#ibc.lightclients.solomachine.v1.ConnectionStateData)
- [ConsensusState](#ibc.lightclients.solomachine.v1.ConsensusState)
- [ConsensusStateData](#ibc.lightclients.solomachine.v1.ConsensusStateData)
- [Header](#ibc.lightclients.solomachine.v1.Header)
- [HeaderData](#ibc.lightclients.solomachine.v1.HeaderData)
- [Misbehaviour](#ibc.lightclients.solomachine.v1.Misbehaviour)
- [NextSequenceRecvData](#ibc.lightclients.solomachine.v1.NextSequenceRecvData)
- [PacketAcknowledgementData](#ibc.lightclients.solomachine.v1.PacketAcknowledgementData)
- [PacketCommitmentData](#ibc.lightclients.solomachine.v1.PacketCommitmentData)
- [PacketReceiptAbsenceData](#ibc.lightclients.solomachine.v1.PacketReceiptAbsenceData)
- [SignBytes](#ibc.lightclients.solomachine.v1.SignBytes)
- [SignatureAndData](#ibc.lightclients.solomachine.v1.SignatureAndData)
- [TimestampedSignatureData](#ibc.lightclients.solomachine.v1.TimestampedSignatureData)

- [DataType](#ibc.lightclients.solomachine.v1.DataType)
- [ibc/lightclients/solomachine/v3/solomachine.proto](#ibc/lightclients/solomachine/v3/solomachine.proto)
- [ClientState](#ibc.lightclients.solomachine.v3.ClientState)
- [ConsensusState](#ibc.lightclients.solomachine.v3.ConsensusState)
- [Header](#ibc.lightclients.solomachine.v3.Header)
- [HeaderData](#ibc.lightclients.solomachine.v3.HeaderData)
- [Misbehaviour](#ibc.lightclients.solomachine.v3.Misbehaviour)
- [SignBytes](#ibc.lightclients.solomachine.v3.SignBytes)
- [SignatureAndData](#ibc.lightclients.solomachine.v3.SignatureAndData)
- [TimestampedSignatureData](#ibc.lightclients.solomachine.v3.TimestampedSignatureData)

- [ibc/lightclients/tendermint/v1/tendermint.proto](#ibc/lightclients/tendermint/v1/tendermint.proto)
- [ClientState](#ibc.lightclients.tendermint.v1.ClientState)
Expand Down Expand Up @@ -8536,31 +8526,14 @@ GenesisState defines the ibc client submodule's genesis state.



<a name="ibc/lightclients/solomachine/v1/solomachine.proto"></a>
<a name="ibc/lightclients/solomachine/v3/solomachine.proto"></a>
<p align="right"><a href="#top">Top</a></p>

## ibc/lightclients/solomachine/v1/solomachine.proto



<a name="ibc.lightclients.solomachine.v1.ChannelStateData"></a>
## ibc/lightclients/solomachine/v3/solomachine.proto

### ChannelStateData
ChannelStateData returns the SignBytes data for channel state
verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| channel | [ibc.core.channel.v1.Channel](#ibc.core.channel.v1.Channel) | | |






<a name="ibc.lightclients.solomachine.v1.ClientState"></a>
<a name="ibc.lightclients.solomachine.v3.ClientState"></a>

### ClientState
ClientState defines a solo machine client that tracks the current consensus
Expand All @@ -8569,120 +8542,69 @@ state and if the client is frozen.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sequence | [uint64](#uint64) | | latest sequence of the client state |
| frozen_sequence | [uint64](#uint64) | | frozen sequence of the solo machine |
| consensus_state | [ConsensusState](#ibc.lightclients.solomachine.v1.ConsensusState) | | |
| allow_update_after_proposal | [bool](#bool) | | when set to true, will allow governance to update a solo machine client. The client will be unfrozen if it is frozen. |






<a name="ibc.lightclients.solomachine.v1.ClientStateData"></a>

### ClientStateData
ClientStateData returns the SignBytes data for client state verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| client_state | [google.protobuf.Any](#google.protobuf.Any) | | |






<a name="ibc.lightclients.solomachine.v1.ConnectionStateData"></a>

### ConnectionStateData
ConnectionStateData returns the SignBytes data for connection state
verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| connection | [ibc.core.connection.v1.ConnectionEnd](#ibc.core.connection.v1.ConnectionEnd) | | |
| `sequence` | [uint64](#uint64) | | latest sequence of the client state |
| `is_frozen` | [bool](#bool) | | frozen sequence of the solo machine |
| `consensus_state` | [ConsensusState](#ibc.lightclients.solomachine.v3.ConsensusState) | | |






<a name="ibc.lightclients.solomachine.v1.ConsensusState"></a>
<a name="ibc.lightclients.solomachine.v3.ConsensusState"></a>

### ConsensusState
ConsensusState defines a solo machine consensus state. The sequence of a consensus state
is contained in the &#34;height&#34; key used in storing the consensus state.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| public_key | [google.protobuf.Any](#google.protobuf.Any) | | public key of the solo machine |
| diversifier | [string](#string) | | diversifier allows the same public key to be re-used across different solo machine clients (potentially on different chains) without being considered misbehaviour. |
| timestamp | [uint64](#uint64) | | |






<a name="ibc.lightclients.solomachine.v1.ConsensusStateData"></a>

### ConsensusStateData
ConsensusStateData returns the SignBytes data for consensus state
verification.
ConsensusState defines a solo machine consensus state. The sequence of a
consensus state is contained in the "height" key used in storing the
consensus state.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| consensus_state | [google.protobuf.Any](#google.protobuf.Any) | | |
| `public_key` | [google.protobuf.Any](#google.protobuf.Any) | | public key of the solo machine |
| `diversifier` | [string](#string) | | diversifier allows the same public key to be re-used across different solo machine clients (potentially on different chains) without being considered misbehaviour. |
| `timestamp` | [uint64](#uint64) | | |






<a name="ibc.lightclients.solomachine.v1.Header"></a>
<a name="ibc.lightclients.solomachine.v3.Header"></a>

### Header
Header defines a solo machine consensus header


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sequence | [uint64](#uint64) | | sequence to update solo machine public key at |
| timestamp | [uint64](#uint64) | | |
| signature | [bytes](#bytes) | | |
| new_public_key | [google.protobuf.Any](#google.protobuf.Any) | | |
| new_diversifier | [string](#string) | | |
| `timestamp` | [uint64](#uint64) | | |
| `signature` | [bytes](#bytes) | | |
| `new_public_key` | [google.protobuf.Any](#google.protobuf.Any) | | |
| `new_diversifier` | [string](#string) | | |






<a name="ibc.lightclients.solomachine.v1.HeaderData"></a>
<a name="ibc.lightclients.solomachine.v3.HeaderData"></a>

### HeaderData
HeaderData returns the SignBytes data for update verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| new_pub_key | [google.protobuf.Any](#google.protobuf.Any) | | header public key |
| new_diversifier | [string](#string) | | header diversifier |
| `new_pub_key` | [google.protobuf.Any](#google.protobuf.Any) | | header public key |
| `new_diversifier` | [string](#string) | | header diversifier |






<a name="ibc.lightclients.solomachine.v1.Misbehaviour"></a>
<a name="ibc.lightclients.solomachine.v3.Misbehaviour"></a>

### Misbehaviour
Misbehaviour defines misbehaviour for a solo machine which consists
Expand All @@ -8691,103 +8613,35 @@ of a sequence and two signatures over different messages at that sequence.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| client_id | [string](#string) | | |
| sequence | [uint64](#uint64) | | |
| signature_one | [SignatureAndData](#ibc.lightclients.solomachine.v1.SignatureAndData) | | |
| signature_two | [SignatureAndData](#ibc.lightclients.solomachine.v1.SignatureAndData) | | |

| `sequence` | [uint64](#uint64) | | |
| `signature_one` | [SignatureAndData](#ibc.lightclients.solomachine.v3.SignatureAndData) | | |
| `signature_two` | [SignatureAndData](#ibc.lightclients.solomachine.v3.SignatureAndData) | | |





<a name="ibc.lightclients.solomachine.v1.NextSequenceRecvData"></a>

### NextSequenceRecvData
NextSequenceRecvData returns the SignBytes data for verification of the next
sequence to be received.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| next_seq_recv | [uint64](#uint64) | | |






<a name="ibc.lightclients.solomachine.v1.PacketAcknowledgementData"></a>

### PacketAcknowledgementData
PacketAcknowledgementData returns the SignBytes data for acknowledgement
verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| acknowledgement | [bytes](#bytes) | | |






<a name="ibc.lightclients.solomachine.v1.PacketCommitmentData"></a>

### PacketCommitmentData
PacketCommitmentData returns the SignBytes data for packet commitment
verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |
| commitment | [bytes](#bytes) | | |






<a name="ibc.lightclients.solomachine.v1.PacketReceiptAbsenceData"></a>

### PacketReceiptAbsenceData
PacketReceiptAbsenceData returns the SignBytes data for
packet receipt absence verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| path | [bytes](#bytes) | | |






<a name="ibc.lightclients.solomachine.v1.SignBytes"></a>
<a name="ibc.lightclients.solomachine.v3.SignBytes"></a>

### SignBytes
SignBytes defines the signed bytes used for signature verification.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sequence | [uint64](#uint64) | | |
| timestamp | [uint64](#uint64) | | |
| diversifier | [string](#string) | | |
| data_type | [DataType](#ibc.lightclients.solomachine.v1.DataType) | | type of the data used |
| data | [bytes](#bytes) | | marshaled data |
| `sequence` | [uint64](#uint64) | | the sequence number |
| `timestamp` | [uint64](#uint64) | | the proof timestamp |
| `diversifier` | [string](#string) | | the public key diversifier |
| `path` | [bytes](#bytes) | | the standardised path bytes |
| `data` | [bytes](#bytes) | | the marshaled data bytes |






<a name="ibc.lightclients.solomachine.v1.SignatureAndData"></a>
<a name="ibc.lightclients.solomachine.v3.SignatureAndData"></a>

### SignatureAndData
SignatureAndData contains a signature and the data signed over to create that
Expand All @@ -8796,17 +8650,17 @@ signature.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| signature | [bytes](#bytes) | | |
| data_type | [DataType](#ibc.lightclients.solomachine.v1.DataType) | | |
| data | [bytes](#bytes) | | |
| timestamp | [uint64](#uint64) | | |
| `signature` | [bytes](#bytes) | | |
| `path` | [bytes](#bytes) | | |
| `data` | [bytes](#bytes) | | |
| `timestamp` | [uint64](#uint64) | | |






<a name="ibc.lightclients.solomachine.v1.TimestampedSignatureData"></a>
<a name="ibc.lightclients.solomachine.v3.TimestampedSignatureData"></a>

### TimestampedSignatureData
TimestampedSignatureData contains the signature data and the timestamp of the
Expand All @@ -8815,36 +8669,14 @@ signature.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| signature_data | [bytes](#bytes) | | |
| timestamp | [uint64](#uint64) | | |


| `signature_data` | [bytes](#bytes) | | |
| `timestamp` | [uint64](#uint64) | | |






<a name="ibc.lightclients.solomachine.v1.DataType"></a>

### DataType
DataType defines the type of solo machine proof being created. This is done to preserve uniqueness of different
data sign byte encodings.

| Name | Number | Description |
| ---- | ------ | ----------- |
| DATA_TYPE_UNINITIALIZED_UNSPECIFIED | 0 | Default State |
| DATA_TYPE_CLIENT_STATE | 1 | Data type for client state verification |
| DATA_TYPE_CONSENSUS_STATE | 2 | Data type for consensus state verification |
| DATA_TYPE_CONNECTION_STATE | 3 | Data type for connection state verification |
| DATA_TYPE_CHANNEL_STATE | 4 | Data type for channel state verification |
| DATA_TYPE_PACKET_COMMITMENT | 5 | Data type for packet commitment verification |
| DATA_TYPE_PACKET_ACKNOWLEDGEMENT | 6 | Data type for packet acknowledgement verification |
| DATA_TYPE_PACKET_RECEIPT_ABSENCE | 7 | Data type for packet receipt absence verification |
| DATA_TYPE_NEXT_SEQUENCE_RECV | 8 | Data type for next sequence recv verification |
| DATA_TYPE_HEADER | 9 | Data type for header verification |





Expand Down