Skip to content

Commit

Permalink
docs: move solomachine docs into the docs directory. (cosmos#2908)
Browse files Browse the repository at this point in the history
  • Loading branch information
chatton authored and zmanian committed Dec 19, 2022
1 parent a25a9d0 commit 9d7922f
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 45 deletions.
118 changes: 76 additions & 42 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -322,52 +322,86 @@ module.exports = {
],
},
{
title: "IBC Light Client Developer Guide",
title: "IBC Light Clients",
children: [
{
title: "Overview",
directory: false,
path: "/light-clients/overview.html",
},
{
title: "ClientState",
directory: false,
path: "light-clients/client-state.html",
},
{
title: "ConsensusState",
directory: false,
path: "/light-clients/consensus-state.html",
},
{
title: "Existence/Non-Existence Proofs",
directory: false,
path: "/light-clients/proofs.html",
},
{
title: "Updates Handling",
directory: false,
path: "/light-clients/update.html",
},
{
title: "Misbehaviour Handling",
directory: false,
path: "/light-clients/misbehaviour.html",
},
{
title: "Upgrades Handling",
directory: false,
path: "/light-clients/upgrade.html",
},
{
title: "Proposal Handling",
directory: false,
path: "/light-clients/proposal.html",
title: "Developer Guide",
directory: true,
path: "/ibc/light-clients",
children: [
{
title: "Overview",
directory: false,
path: "/ibc/light-clients/overview.html",
},
{
title: "ClientState",
directory: false,
path: "/ibc/light-clients/client-state.html",
},
{
title: "ConsensusState",
directory: false,
path: "/ibc/light-clients/consensus-state.html",
},
{
title: "Existence/Non-Existence Proofs",
directory: false,
path: "/ibc/light-clients/proofs.html",
},
{
title: "Updates Handling",
directory: false,
path: "/ibc/light-clients/update.html",
},
{
title: "Misbehaviour Handling",
directory: false,
path: "/ibc/light-clients/misbehaviour.html",
},
{
title: "Upgrades Handling",
directory: false,
path: "/ibc/light-clients/upgrade.html",
},
{
title: "Proposal Handling",
directory: false,
path: "/ibc/light-clients/proposal.html",
},
{
title: "Genesis Handling",
directory: false,
path: "/ibc/light-clients/genesis.html",
},
]
},
{
title: "Genesis Handling",
directory: false,
path: "/light-clients/genesis.html",
title: "Solomachine",
directory: true,
path: "/ibc/light-clients/solomachine",
children: [
{
title: "Solomachine",
directory: false,
path: "/ibc/light-clients/solomachine/solomachine.html",
},
{
title: "Concepts",
directory: false,
path: "/ibc/light-clients/solomachine/concepts.html",
},
{
title: "State",
directory: false,
path: "/ibc/light-clients/solomachine/state.html",
},
{
title: "State Transitions",
directory: false,
path: "/ibc/light-clients/solomachine/state_transitions.html",
},
],
},
],
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ data := &ClientStateData{
dataBz, err := cdc.Marshal(data)
```

The helper functions `...DataBytes()` in [proof.go](../proof.go) handle this
The helper functions `...DataBytes()` in [proof.go](../../../../modules/light-clients/06-solomachine/proof.go) handle this
functionality.

2. Construct the `SignBytes` and marshal it.
Expand All @@ -75,7 +75,7 @@ signBytes := &SignBytes{
signBz, err := cdc.Marshal(signBytes)
```

The helper functions `...SignBytes()` in [proof.go](../proof.go) handle this functionality.
The helper functions `...SignBytes()` in [proof.go](../../../../modules/light-clients/06-solomachine/proof.go) handle this functionality.
The `DataType` field is used to disambiguate what type of data was signed to prevent potential
proto encoding overlap.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ order: 2

The solo machine light client will only store consensus states for each update by a header
or a governance proposal. The latest client state is also maintained in the store.

0 comments on commit 9d7922f

Please sign in to comment.