From 4e8c126e94f862cc032f606b7b29ab2fd2e9f951 Mon Sep 17 00:00:00 2001 From: Charly Date: Mon, 5 Dec 2022 14:57:43 +0100 Subject: [PATCH] chore: scaffold custom IBC light client development guide (#2860) --- docs/.vuepress/config.js | 50 +++++++++++++++++++++++ docs/ibc/light-clients/client-state.md | 3 ++ docs/ibc/light-clients/consensus-state.md | 3 ++ docs/ibc/light-clients/genesis.md | 3 ++ docs/ibc/light-clients/misbehaviour.md | 3 ++ docs/ibc/light-clients/overview.md | 3 ++ docs/ibc/light-clients/proofs.md | 3 ++ docs/ibc/light-clients/proposal.md | 3 ++ docs/ibc/light-clients/update.md | 3 ++ docs/ibc/light-clients/upgrade.md | 3 ++ 10 files changed, 77 insertions(+) create mode 100644 docs/ibc/light-clients/client-state.md create mode 100644 docs/ibc/light-clients/consensus-state.md create mode 100644 docs/ibc/light-clients/genesis.md create mode 100644 docs/ibc/light-clients/misbehaviour.md create mode 100644 docs/ibc/light-clients/overview.md create mode 100644 docs/ibc/light-clients/proofs.md create mode 100644 docs/ibc/light-clients/proposal.md create mode 100644 docs/ibc/light-clients/update.md create mode 100644 docs/ibc/light-clients/upgrade.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 3c4ea705609..17eced0029d 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -294,6 +294,56 @@ module.exports = { }, ], }, + { + title: "IBC Light Client Developer Guide", + 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: "Genesis Handling", + directory: false, + path: "/light-clients/genesis.html", + }, + ], + }, { title: "IBC Middleware Modules", children: [ diff --git a/docs/ibc/light-clients/client-state.md b/docs/ibc/light-clients/client-state.md new file mode 100644 index 00000000000..cfb3805268f --- /dev/null +++ b/docs/ibc/light-clients/client-state.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/consensus-state.md b/docs/ibc/light-clients/consensus-state.md new file mode 100644 index 00000000000..04de84a83d6 --- /dev/null +++ b/docs/ibc/light-clients/consensus-state.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/genesis.md b/docs/ibc/light-clients/genesis.md new file mode 100644 index 00000000000..695231196ad --- /dev/null +++ b/docs/ibc/light-clients/genesis.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/misbehaviour.md b/docs/ibc/light-clients/misbehaviour.md new file mode 100644 index 00000000000..99529dc2775 --- /dev/null +++ b/docs/ibc/light-clients/misbehaviour.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/overview.md b/docs/ibc/light-clients/overview.md new file mode 100644 index 00000000000..4e10266dfdb --- /dev/null +++ b/docs/ibc/light-clients/overview.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/proofs.md b/docs/ibc/light-clients/proofs.md new file mode 100644 index 00000000000..197c44cbc2b --- /dev/null +++ b/docs/ibc/light-clients/proofs.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/proposal.md b/docs/ibc/light-clients/proposal.md new file mode 100644 index 00000000000..1aa80c4f77e --- /dev/null +++ b/docs/ibc/light-clients/proposal.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/update.md b/docs/ibc/light-clients/update.md new file mode 100644 index 00000000000..ff7a3c6ce6b --- /dev/null +++ b/docs/ibc/light-clients/update.md @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/docs/ibc/light-clients/upgrade.md b/docs/ibc/light-clients/upgrade.md new file mode 100644 index 00000000000..cf8eae46ed7 --- /dev/null +++ b/docs/ibc/light-clients/upgrade.md @@ -0,0 +1,3 @@ + \ No newline at end of file