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.

Sign up for GitHub

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

Jump to bottom

Move solomachine docs to the docs directory #2908

Merged
merged 3 commits into from
Dec 8, 2022
Merged

Move solomachine docs to the docs directory #2908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77c167a
docs: moved solomachine docs from spec to docs directory
chatton Dec 8, 2022
d2ffe72
docs: updated structure of docs to have solomachine nested under ligh…
chatton Dec 8, 2022
db003f3
Merge branch 'main' into cian/issue#651-move-solo-machine-documentati…
chatton Dec 8, 2022
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
118 changes: 76 additions & 42 deletions docs/.vuepress/config.js
View file
Open in desktop
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
4 changes: 2 additions & 2 deletions ...lients/06-solomachine/spec/01_concepts.md → ...ibc/light-clients/solomachine/concepts.md
View file
Open in desktop
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
0 ...ght-clients/06-solomachine/spec/README.md → .../light-clients/solomachine/solomachine.md
View file
Open in desktop
File renamed without changes.
1 change: 0 additions & 1 deletion ...t-clients/06-solomachine/spec/02_state.md → docs/ibc/light-clients/solomachine/state.md
View file
Open in desktop
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 ...-solomachine/spec/03_state_transitions.md → ...-clients/solomachine/state_transitions.md
View file
Open in desktop
File renamed without changes.