mirror of https://github.com/certusone/wasmd.git
Merge PR #250: Docs-update
This commit is contained in:
Marko
Alexander Bezobchuk
parent
ce3725293f
commit
f61b391aee
|
|
@ -13,9 +13,10 @@ executors:
|
|||
GO_VERSION: "1.13"
|
||||
docs:
|
||||
docker:
|
||||
- image: tendermintdev/jq_curl
|
||||
- image: tendermintdev/docker-website-deployment
|
||||
environment:
|
||||
AWS_REGION: us-east-1
|
||||
LEDGER_ENABLED: false
|
||||
|
||||
|
||||
commands:
|
||||
|
|
@ -226,24 +227,11 @@ jobs:
|
|||
steps:
|
||||
- checkout
|
||||
- run:
|
||||
name: Trigger website build
|
||||
command: |
|
||||
curl --silent \
|
||||
--show-error \
|
||||
-X POST \
|
||||
--header "Content-Type: application/json" \
|
||||
-d "{\"branch\": \"$CIRCLE_BRANCH\"}" \
|
||||
"https://circleci.com/api/v1.1/project/github/$CIRCLE_PROJECT_USERNAME/$WEBSITE_REPO_NAME/build?circle-token=$TENDERBOT_API_TOKEN" > response.json
|
||||
|
||||
RESULT=`jq -r '.status' response.json`
|
||||
MESSAGE=`jq -r '.message' response.json`
|
||||
|
||||
if [[ ${RESULT} == "null" ]] || [[ ${RESULT} -ne "200" ]]; then
|
||||
echo "CircleCI API call failed: $MESSAGE"
|
||||
exit 1
|
||||
else
|
||||
echo "Website build started"
|
||||
fi
|
||||
name: "Build docs"
|
||||
command: make build-docs
|
||||
- run:
|
||||
name: "Upload docs to S3"
|
||||
command: make sync-docs
|
||||
|
||||
macos-ci:
|
||||
executor: mac
|
||||
|
|
@ -382,11 +370,17 @@ workflows:
|
|||
- master
|
||||
- develop
|
||||
- deploy-docs:
|
||||
context: gaia-docs-deployment-staging
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- docs-update
|
||||
- deploy-docs:
|
||||
context: gaia-docs-deployment
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
- develop
|
||||
- setup-dependencies:
|
||||
# filters here are needed to enable this job also for tags
|
||||
filters:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
name: Check links
|
||||
on: [pull_request]
|
||||
jobs:
|
||||
link-check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Link Checker
|
||||
uses: peter-evans/link-checker@v1
|
||||
with:
|
||||
args: -v -r *
|
||||
|
|
@ -17,6 +17,7 @@ docs/_build
|
|||
docs/tutorial
|
||||
dist
|
||||
tools-stamp
|
||||
docs/node_modules
|
||||
|
||||
# Data - ideally these don't exist
|
||||
baseapp/data/*
|
||||
|
|
|
|||
21
Makefile
21
Makefile
|
|
@ -90,6 +90,27 @@ install: go.sum
|
|||
go install -mod=readonly $(BUILD_FLAGS) ./cmd/gaiad
|
||||
go install -mod=readonly $(BUILD_FLAGS) ./cmd/gaiacli
|
||||
|
||||
|
||||
########################################
|
||||
### Documentation
|
||||
|
||||
build-docs:
|
||||
@cd docs && \
|
||||
while read p; do \
|
||||
(git checkout $${p} && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
|
||||
mkdir -p ~/output/$${p} ; \
|
||||
cp -r .vuepress/dist/* ~/output/$${p}/ ; \
|
||||
cp ~/output/$${p}/index.html ~/output ; \
|
||||
done < versions ;
|
||||
|
||||
sync-docs:
|
||||
cd ~/output && \
|
||||
echo "role_arn = ${DEPLOYMENT_ROLE_ARN}" >> /root/.aws/config ; \
|
||||
echo "CI job = ${CIRCLE_BUILD_URL}" >> version.html ; \
|
||||
aws s3 sync . s3://${WEBSITE_BUCKET} --profile terraform --delete ; \
|
||||
aws cloudfront create-invalidation --distribution-id ${CF_DISTRIBUTION_ID} --profile terraform --path "/*" ;
|
||||
.PHONY: sync-docs
|
||||
|
||||
########################################
|
||||
### Tools & dependencies
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
<template>
|
||||
<div></div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
mounted() {
|
||||
window.location.assign(`${this.$site.base}hub-overview/overview.html`)
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
|
@ -0,0 +1,160 @@
|
|||
module.exports = {
|
||||
theme: "cosmos",
|
||||
title: "Cosmos Hub",
|
||||
head: [
|
||||
[
|
||||
"link",
|
||||
{
|
||||
rel: "stylesheet",
|
||||
type: "text/css",
|
||||
href: "https://cloud.typography.com/6138116/7255612/css/fonts.css"
|
||||
}
|
||||
],
|
||||
],
|
||||
base: process.env.VUEPRESS_BASE || "/",
|
||||
themeConfig: {
|
||||
docsRepo: "cosmos/gaia",
|
||||
docsDir: "docs",
|
||||
editLinks: true,
|
||||
label: "hub",
|
||||
sidebar: [
|
||||
{
|
||||
title: "Resources",
|
||||
children: [
|
||||
{
|
||||
title: "Tutorials",
|
||||
path: "https://tutorials.cosmos.network"
|
||||
},
|
||||
{
|
||||
title: "SDK API Reference",
|
||||
path: "https://godoc.org/github.com/cosmos/cosmos-sdk"
|
||||
},
|
||||
{
|
||||
title: "REST API Spec",
|
||||
path: "https://cosmos.network/rpc/"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
gutter: {
|
||||
title: "Help & Support",
|
||||
editLink: true,
|
||||
chat: {
|
||||
title: "Riot Chat",
|
||||
text: "Chat with Cosmos developers on Riot Chat.",
|
||||
url: "https://riot.im/app/#/room/#cosmos-sdk:matrix.org",
|
||||
bg: "linear-gradient(225.11deg, #2E3148 0%, #161931 95.68%)"
|
||||
},
|
||||
forum: {
|
||||
title: "Cosmos SDK Forum",
|
||||
text: "Join the SDK Developer Forum to learn more.",
|
||||
url: "https://forum.cosmos.network/",
|
||||
bg: "linear-gradient(225deg, #46509F -1.08%, #2F3564 95.88%)",
|
||||
logo: "cosmos"
|
||||
},
|
||||
github: {
|
||||
title: "Found an Issue?",
|
||||
text: "Help us improve this page by suggesting edits on GitHub."
|
||||
}
|
||||
},
|
||||
footer: {
|
||||
logo: "/logo-bw.svg",
|
||||
textLink: {
|
||||
text: "cosmos.network",
|
||||
url: "/"
|
||||
},
|
||||
services: [
|
||||
{
|
||||
service: "medium",
|
||||
url: "https://blog.cosmos.network/"
|
||||
},
|
||||
{
|
||||
service: "twitter",
|
||||
url: "https://twitter.com/cosmos"
|
||||
},
|
||||
{
|
||||
service: "linkedin",
|
||||
url: "https://www.linkedin.com/company/tendermint/"
|
||||
},
|
||||
{
|
||||
service: "reddit",
|
||||
url: "https://reddit.com/r/cosmosnetwork"
|
||||
},
|
||||
{
|
||||
service: "telegram",
|
||||
url: "https://t.me/cosmosproject"
|
||||
},
|
||||
{
|
||||
service: "youtube",
|
||||
url: "https://www.youtube.com/c/CosmosProject"
|
||||
}
|
||||
],
|
||||
smallprint:
|
||||
"This website is maintained by Tendermint Inc. The contents and opinions of this website are those of Tendermint Inc.",
|
||||
links: [
|
||||
{
|
||||
title: "Documentation",
|
||||
children: [
|
||||
{
|
||||
title: "Cosmos SDK",
|
||||
url: "https://docs.cosmos.network"
|
||||
},
|
||||
{
|
||||
title: "Cosmos Hub",
|
||||
url: "https://hub.cosmos.network/"
|
||||
},
|
||||
{
|
||||
title: "Tendermint Core",
|
||||
url: "https://docs.tendermint.com/"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
title: "Community",
|
||||
children: [
|
||||
{
|
||||
title: "Cosmos blog",
|
||||
url: "https://blog.cosmos.network/"
|
||||
},
|
||||
{
|
||||
title: "Forum",
|
||||
url: "https://forum.cosmos.network/"
|
||||
},
|
||||
{
|
||||
title: "Chat",
|
||||
url: "https://riot.im/app/#/room/#cosmos-sdk:matrix.org"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
title: "Contributing",
|
||||
children: [
|
||||
{
|
||||
title: "Contributing to the docs",
|
||||
url:
|
||||
"https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md"
|
||||
},
|
||||
{
|
||||
title: "Source code on GitHub",
|
||||
url: "https://github.com/cosmos/cosmos-sdk/"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
plugins: [
|
||||
// [
|
||||
// "@vuepress/google-analytics",
|
||||
// {
|
||||
// ga: "UA-51029217-12"
|
||||
// }
|
||||
// ],
|
||||
[
|
||||
"sitemap",
|
||||
{
|
||||
hostname: "https://hub.cosmos.network"
|
||||
}
|
||||
]
|
||||
]
|
||||
};
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<svg width="144" height="28" viewBox="0 0 144 28" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M16 20.0202L14.0251 18.0202C13.275 18.72 12.5167 19.2745 11.7497 19.6829C10.9834 20.091 10.0666 20.2951 9.00008 20.2951C8.16662 20.2951 7.3959 20.1329 6.68758 19.8077C5.97926 19.4826 5.36673 19.0371 4.84999 18.4701C4.33325 17.9035 3.93355 17.2411 3.64989 16.4829C3.36656 15.7247 3.22523 14.9118 3.22523 14.0457C3.22523 13.1789 3.36656 12.3705 3.64989 11.6204C3.93355 10.8706 4.33325 10.2166 4.84999 9.65808C5.36673 9.09989 5.97926 8.6584 6.68758 8.33326C7.3959 8.00846 8.16662 7.8459 9.00008 7.8459C9.99983 7.8459 10.8916 8.0459 11.6748 8.44591C12.4584 8.84558 13.2001 9.37072 13.8997 10.0207L15.8749 7.74606C15.4583 7.34605 15.0168 6.97944 14.55 6.64587C14.0835 6.31264 13.5752 6.02494 13.025 5.78345C12.4749 5.54163 11.8708 5.35444 11.2124 5.22122C10.554 5.08765 9.82477 5.02087 9.02504 5.02087C7.69171 5.02087 6.47508 5.25865 5.37516 5.73354C4.2749 6.20842 3.32507 6.85835 2.525 7.68333C1.72493 8.50831 1.10431 9.47056 0.66245 10.5707C0.220592 11.6706 0 12.8457 0 14.0956C0 15.3621 0.224977 16.5453 0.67493 17.6455C1.12488 18.745 1.74585 19.6991 2.53748 20.5076C3.32912 21.3157 4.26646 21.9531 5.34986 22.4199C6.43326 22.8867 7.61683 23.1198 8.89991 23.1198C9.71684 23.1198 10.4626 23.0489 11.1375 22.9073C11.8125 22.7656 12.4334 22.5575 13.0001 22.2827C13.5667 22.0074 14.096 21.6823 14.5877 21.3076C15.0792 20.9325 15.55 20.5032 16 20.0202" fill="#2E3148" />
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M55.6691 9.97591C55.6691 9.39376 55.9177 8.8991 56.4152 8.49193C56.9123 8.08409 57.6087 7.88051 58.5037 7.88051C59.2995 7.88051 60.0868 8.03462 60.8657 8.34219C61.645 8.64975 62.4323 9.09461 63.2277 9.67642L64.8688 7.35691C63.9741 6.64184 63.0167 6.09737 61.9972 5.72352C60.9774 5.34933 59.8298 5.16223 58.5534 5.16223C57.6916 5.16223 56.8959 5.2827 56.1706 5.52397C55.4413 5.76491 54.82 6.10982 54.3018 6.55872C53.7838 7.00795 53.3776 7.544 53.0793 8.16754C52.7851 8.79108 52.6359 9.48529 52.6359 10.2502C52.6359 11.0648 52.7643 11.755 53.0213 12.3203C53.2783 12.8857 53.6553 13.3679 54.1444 13.767C54.6332 14.1661 55.2424 14.4985 55.9633 14.7647C56.6886 15.0309 57.5135 15.2715 58.4457 15.4878C59.2582 15.6874 59.9167 15.8785 60.4266 16.0612C60.9322 16.2443 61.33 16.4398 61.6242 16.6474C61.914 16.8554 62.1133 17.0839 62.221 17.3332C62.3287 17.5829 62.3824 17.8652 62.3824 18.1812C62.3824 18.8633 62.1049 19.4037 61.5497 19.8025C60.9942 20.2019 60.2441 20.4011 59.2995 20.4011C58.2055 20.4011 57.2273 20.2056 56.3655 19.8149C55.5034 19.4243 54.65 18.8633 53.8043 18.1314L51.9646 20.3264C53.0089 21.274 54.1444 21.9766 55.3709 22.4339C56.5977 22.8912 57.8821 23.1197 59.2247 23.1197C60.1364 23.1197 60.9738 23.0033 61.7363 22.7708C62.4944 22.5376 63.1492 22.1967 63.688 21.7478C64.2307 21.2989 64.6534 20.7504 64.96 20.102C65.2626 19.4535 65.4159 18.7136 65.4159 17.8821C65.4159 17.1505 65.2958 16.5145 65.0553 15.9741C64.8148 15.4337 64.4585 14.9602 63.9946 14.5524C63.5303 14.1452 62.9419 13.7999 62.2374 13.5173C61.5333 13.2349 60.7208 12.9772 59.809 12.7443C58.9761 12.5448 58.2924 12.3533 57.7496 12.1706C57.2109 11.9879 56.7882 11.7883 56.4772 11.5719C56.1706 11.3559 55.9596 11.1231 55.8432 10.8737C55.7275 10.624 55.6691 10.3249 55.6691 9.97591" fill="#2E3148" />
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M89.7054 10.223V22.6955H92.7433V5.30359H89.4809L84.1768 13.5276L78.8726 5.30359H75.6106V22.6955H78.6485V10.2726L84.1019 18.4221H84.2017L89.7054 10.223Z" fill="#2E3148" />
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M118.268 14.0956C118.268 14.9455 118.122 15.7496 117.831 16.5081C117.54 17.2663 117.137 17.9244 116.621 18.4825C116.105 19.0407 115.486 19.4826 114.762 19.8077C114.038 20.1328 113.244 20.2951 112.379 20.2951C111.514 20.2951 110.715 20.1284 109.983 19.7952C109.252 19.4617 108.623 19.0117 108.099 18.4454C107.576 17.8785 107.168 17.2161 106.877 16.4579C106.586 15.6997 106.44 14.8953 106.44 14.0457C106.44 13.1954 106.586 12.3913 106.877 11.6331C107.168 10.8746 107.571 10.2166 108.087 9.65806C108.603 9.09986 109.223 8.65837 109.946 8.33324C110.67 8.00844 111.464 7.84587 112.329 7.84587C113.194 7.84587 113.993 8.01249 114.725 8.34605C115.456 8.67928 116.085 9.12921 116.608 9.69583C117.133 10.2621 117.54 10.9249 117.831 11.6831C118.122 12.4413 118.268 13.2457 118.268 14.0956ZM121.487 14.0457C121.487 12.8123 121.262 11.6456 120.813 10.5455C120.364 9.44593 119.74 8.4874 118.942 7.67085C118.143 6.85397 117.187 6.20842 116.072 5.73354C114.957 5.25865 113.727 5.02087 112.379 5.02087C111.032 5.02087 109.801 5.2627 108.686 5.74602C107.571 6.22933 106.606 6.88331 105.791 7.70829C104.976 8.53327 104.344 9.49585 103.895 10.5957C103.446 11.6956 103.221 12.8622 103.221 14.0956C103.221 15.3287 103.446 16.495 103.895 17.5952C104.344 18.6954 104.968 19.6536 105.766 20.4701C106.565 21.2867 107.521 21.9326 108.636 22.4074C109.75 22.8823 110.981 23.1198 112.329 23.1198C113.676 23.1198 114.908 22.8779 116.022 22.395C117.137 21.9117 118.101 21.2577 118.917 20.4324C119.732 19.6077 120.364 18.6451 120.813 17.5453C121.262 16.4454 121.487 15.2788 121.487 14.0457V14.0457Z" fill="#2E3148" />
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M134.253 9.97591C134.253 9.39376 134.502 8.8991 134.999 8.49193C135.496 8.08409 136.192 7.88051 137.088 7.88051C137.883 7.88051 138.671 8.03462 139.45 8.34219C140.229 8.64975 141.016 9.09461 141.812 9.67642L143.453 7.35691C142.558 6.64184 141.6 6.09737 140.581 5.72352C139.562 5.34933 138.414 5.16223 137.137 5.16223C136.276 5.16223 135.48 5.2827 134.755 5.52397C134.025 5.76491 133.404 6.10982 132.886 6.55872C132.368 7.00795 131.962 7.544 131.663 8.16754C131.369 8.79108 131.22 9.48529 131.22 10.2502C131.22 11.0648 131.348 11.755 131.605 12.3203C131.862 12.8857 132.239 13.3679 132.728 13.767C133.217 14.1661 133.826 14.4985 134.548 14.7647C135.273 15.0309 136.097 15.2715 137.03 15.4878C137.842 15.6874 138.501 15.8785 139.011 16.0612C139.516 16.2443 139.914 16.4398 140.208 16.6474C140.498 16.8554 140.697 17.0839 140.805 17.3332C140.913 17.5829 140.967 17.8652 140.967 18.1812C140.967 18.8633 140.689 19.4037 140.134 19.8025C139.578 20.2019 138.828 20.4011 137.883 20.4011C136.789 20.4011 135.811 20.2056 134.949 19.8149C134.088 19.4243 133.234 18.8633 132.388 18.1314L130.549 20.3264C131.593 21.274 132.728 21.9766 133.955 22.4339C135.181 22.8912 136.466 23.1197 137.809 23.1197C138.72 23.1197 139.557 23.0033 140.32 22.7708C141.078 22.5376 141.733 22.1967 142.272 21.7478C142.815 21.2989 143.237 20.7504 143.544 20.102C143.846 19.4535 144 18.7136 144 17.8821C144 17.1505 143.879 16.5145 143.639 15.9741C143.399 15.4337 143.043 14.9602 142.578 14.5524C142.114 14.1452 141.526 13.7999 140.821 13.5173C140.117 13.2349 139.304 12.9772 138.393 12.7443C137.56 12.5448 136.876 12.3533 136.334 12.1706C135.795 11.9879 135.372 11.7883 135.061 11.5719C134.755 11.3559 134.543 11.1231 134.427 10.8737C134.311 10.624 134.253 10.3249 134.253 9.97591" fill="#2E3148" />
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M36.8401 8.78536L28.5159 17.0984C28.4086 16.8904 28.3117 16.6737 28.2249 16.4489C27.9342 15.6936 27.7888 14.8922 27.7888 14.0458C27.7888 13.1987 27.9342 12.3977 28.2249 11.6424C28.5159 10.8867 28.919 10.2312 29.4345 9.67476C29.9499 9.11868 30.5694 8.67885 31.2924 8.35495C32.0158 8.03138 32.8095 7.86942 33.6739 7.86942C34.5386 7.86942 35.3367 8.03541 36.0679 8.36771C36.3397 8.49103 36.5971 8.63013 36.8401 8.78536ZM36.1056 19.786C35.3822 20.1099 34.5884 20.2715 33.7241 20.2715C32.8593 20.2715 32.0613 20.1055 31.3298 19.7736C31.0582 19.6499 30.8008 19.5108 30.5583 19.3552L38.8821 11.0429C38.9894 11.2505 39.0863 11.4669 39.1731 11.692C39.4638 12.4474 39.6092 13.2487 39.6092 14.0955C39.6092 14.9422 39.4638 15.7432 39.1731 16.4989C38.8821 17.2542 38.479 17.9098 37.9635 18.4658C37.4481 19.0219 36.829 19.4621 36.1056 19.786ZM37.365 22.3635C38.479 21.882 39.4433 21.2305 40.2579 20.4083C41.0725 19.5868 41.704 18.6278 42.1529 17.5321C42.602 16.4364 42.8265 15.2742 42.8265 14.0458C42.8265 12.817 42.602 11.6548 42.1529 10.5588C41.8867 9.90893 41.559 9.30883 41.17 8.75813L46.5841 3.35152L44.4328 1.20312L39.0022 6.62619C38.5147 6.29422 37.9854 6.00728 37.4148 5.76502C36.3007 5.29193 35.0706 5.05505 33.7241 5.05505C32.3772 5.05505 31.1471 5.29596 30.033 5.77745C28.919 6.25894 27.9547 6.91045 27.1401 7.73231C26.3255 8.55417 25.6936 9.51312 25.2448 10.6088C24.7959 11.7045 24.5715 12.8668 24.5715 14.0955C24.5715 15.3239 24.7959 16.4858 25.2448 17.5819C25.5113 18.232 25.839 18.8321 26.2279 19.3832L20.8142 24.7891L22.9656 26.9375L28.3958 21.5148C28.8833 21.8467 29.4126 22.1337 29.9832 22.3759C31.0973 22.849 32.3274 23.0856 33.6739 23.0856C35.0208 23.0856 36.2509 22.8447 37.365 22.3635V22.3635Z" fill="#2E3148" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 8.6 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 16 KiB |
|
|
@ -0,0 +1,3 @@
|
|||
:root
|
||||
--accent-color #ba3ed9
|
||||
--background #161931
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
-->
|
||||
|
||||
# Updating the docs
|
||||
|
||||
If you want to open a PR on Gaia to update the documentation, please follow the guidelines in the [`CONTRIBUTING.md`](https://github.com/cosmos/gaia/tree/master/CONTRIBUTING.md)
|
||||
|
|
@ -6,15 +11,14 @@ If you want to open a PR on Gaia to update the documentation, please follow the
|
|||
|
||||
The documentation for Gaia is hosted at:
|
||||
|
||||
- https://hub.cosmos.network/docs/
|
||||
- https://hub.cosmos.network/docs/
|
||||
|
||||
built from the files in this (`/docs`) directory for [master](https://github.com/cosmos/gaia/tree/master/docs)
|
||||
|
||||
|
||||
### How It Works
|
||||
|
||||
There is a CircleCI job listening for changes in the `/docs` directory, on both
|
||||
the `master` and `develop` branches. Any updates to files in this directory
|
||||
the `master` and `develop` branches. Any updates to files in this directory
|
||||
on those branches will automatically trigger a website deployment. Under the hood,
|
||||
the private website repository has a `make build-docs` target consumed by a CircleCI job in that repo.
|
||||
|
||||
|
|
@ -95,14 +99,14 @@ much as possible with its [counterpart in the Tendermint Core repo](https://gith
|
|||
### Update and Build the RPC docs
|
||||
|
||||
1. Execute the following command at the root directory to install the swagger-ui generate tool.
|
||||
```bash
|
||||
make tools
|
||||
```
|
||||
```bash
|
||||
make tools
|
||||
```
|
||||
2. Edit API docs
|
||||
1. Directly Edit API docs manually: `cmd/gaiacli/swagger-ui/swagger.yaml`.
|
||||
2. Edit API docs within the [Swagger Editor](https://editor.swagger.io/). Please refer to this [document](https://swagger.io/docs/specification/2-0/basic-structure/) for the correct structure in `.yaml`.
|
||||
1. Directly Edit API docs manually: `cmd/gaiacli/swagger-ui/swagger.yaml`.
|
||||
2. Edit API docs within the [Swagger Editor](https://editor.swagger.io/). Please refer to this [document](https://swagger.io/docs/specification/2-0/basic-structure/) for the correct structure in `.yaml`.
|
||||
3. Download `swagger.yaml` and replace the old `swagger.yaml` under fold `cmd/gaiacli/swagger-ui`.
|
||||
4. Compile gaiacli
|
||||
```bash
|
||||
make install
|
||||
```
|
||||
```bash
|
||||
make install
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
layout: home
|
||||
-->
|
||||
|
||||
# Cosmos Hub Documentation
|
||||
|
||||
Welcome to the documentation of the **Cosmos Hub application: `gaia`**.
|
||||
|
|
@ -22,10 +28,10 @@ Welcome to the documentation of the **Cosmos Hub application: `gaia`**.
|
|||
|
||||
## Additional Resources
|
||||
|
||||
- [Validator Resources](./validators/README.md): Contains documentation for `gaia` validators.
|
||||
- [Delegator Resources](./delegators/README.md): Contains documentation for delegators.
|
||||
- [Validator Resources](./validators/README.md): Contains documentation for `gaia` validators.
|
||||
- [Delegator Resources](./delegators/README.md): Contains documentation for delegators.
|
||||
- [Other Resources](./resources/README.md): Contains documentation on `gaiacli`, genesis file, service providers, ledger wallets, ...
|
||||
- [Cosmos Hub Archives](./resources/archives.md): State archives of past iteration of the Cosmos Hub.
|
||||
- [Cosmos Hub Archives](./resources/archives.md): State archives of past iteration of the Cosmos Hub.
|
||||
|
||||
# Contribute
|
||||
|
||||
|
|
@ -34,4 +40,4 @@ considerations when making changes.
|
|||
|
||||
# Version
|
||||
|
||||
This documentation is built from the following commit:
|
||||
This documentation is built from the following commit:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 2
|
||||
---
|
||||
-->
|
||||
|
||||
# Delegator FAQ
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 1
|
||||
---
|
||||
-->
|
||||
|
||||
# Delegator Guide (CLI)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 3
|
||||
---
|
||||
-->
|
||||
|
||||
# Delegator Security
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
<!--
|
||||
order: false
|
||||
parent:
|
||||
order: 3
|
||||
---
|
||||
-->
|
||||
|
||||
# Gaia Tutorials
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 6
|
||||
---
|
||||
-->
|
||||
|
||||
# Deploy Your Own Gaia Testnet
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 2
|
||||
---
|
||||
-->
|
||||
|
||||
# Install Gaia
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 3
|
||||
---
|
||||
-->
|
||||
|
||||
# Join the Cosmos Hub Mainnet
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 4
|
||||
---
|
||||
-->
|
||||
|
||||
# Join the Public Testnet
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 5
|
||||
---
|
||||
-->
|
||||
|
||||
# Upgrade Your Node
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 1
|
||||
---
|
||||
-->
|
||||
|
||||
# What is Gaia?
|
||||
|
||||
|
|
|
|||
|
|
@ -1,71 +1,9 @@
|
|||
---
|
||||
<!--
|
||||
order: false
|
||||
parent:
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
-->
|
||||
|
||||
# Cosmos Hub
|
||||
|
||||
The Cosmos Hub is the first of [thousands of interconnected blockchains](https://cosmos.network) that will eventually comprise the **Cosmos Network**. The primary token of the Cosmos Hub is the **ATOM**, but the Hub will support many tokens in the future.
|
||||
|
||||
## The ATOM
|
||||
|
||||
Do you have ATOM tokens? With ATOM, you have the superpower to contribute to the security and governance of the Cosmos Hub. Delegate your ATOM to one or more of the 100 validators on the Cosmos Hub blockchain to earn more ATOM through Proof-of-Stake. You can also vote with your ATOM to influence the future of the Cosmos Hub through on-chain governance proposals.
|
||||
|
||||
Learn more about [being a delegator](../delegators/delegator-faq.md), learn about [the security risks](../delegators/delegator-security.md), and start participating with one of the following wallets.
|
||||
|
||||
## Cosmos Hub Wallets
|
||||
|
||||
::: warning
|
||||
Do your own research and take precautions in regards to wallet security. Neither Tendermint Inc nor the Interchain Foundation is liable if you lose your funds using these third party wallets.
|
||||
:::
|
||||
|
||||
These community-maintained web and mobile wallets allow you to store & transfer ATOM, delegate ATOM to validators, and vote on on-chain governance proposals. Note that we do not endorse any of the wallets, they are listed for your convenience.
|
||||
|
||||
* [Atomic Wallet](https://atomicwallet.io/) - Android, Linux, macOS, Windows
|
||||
* [Cobo](https://cobo.com/) - Android, iOS
|
||||
* [Cosmostation](https://www.cosmostation.io/) - Android, iOS
|
||||
* [Huobi Wallet](https://www.huobiwallet.com/) - Android, iOS
|
||||
* [imToken](https://token.im/) - Android, iOS
|
||||
* [Lunagram](https://lunamint.com/) - Android, iOS
|
||||
* [Lunie](https://lunie.io) - Web
|
||||
* [Math Wallet](https://www.mathwallet.org/en/) - Android, iOS, Web
|
||||
* [Rainbow Wallet](https://www.rainbow.one) - Android, iOS
|
||||
* [Qbao Wallet](https://qbao.fund/) - Android, iOS
|
||||
* [Trust Wallet](https://trustwallet.com/) Android, iOS
|
||||
* [Wetez](https://www.wetez.io/pc/homepage) - Android, iOS
|
||||
|
||||
|
||||
## Cosmos Hub Explorers
|
||||
|
||||
These block explorers allow you to search, view and analyze Cosmos Hub data—like blocks, transactions, validators, etc.
|
||||
|
||||
* [Big Dipper](https://cosmos.bigdipper.live)
|
||||
* [Cosmos Overview](https://genesislab.net)
|
||||
* [Coris](http://coris.network)
|
||||
* [Cosmos Visualizer](https://nylira.net/3d)
|
||||
* [Hubble](https://hubble.figment.network)
|
||||
* [Mintscan](https://mintscan.io)
|
||||
* [Stargazer](https://stargazer.certus.one)
|
||||
|
||||
## Cosmos Hub CLI
|
||||
|
||||
`gaiacli` is a command-line interface that lets you interact with the Cosmos Hub. `gaiacli` is the only tool that supports 100% of the Cosmos Hub features, including accounts, transfers, delegation, and governance. Learn more about `gaiacli` with the [delegator's CLI guide](../delegators/delegator-guide-cli.md).
|
||||
|
||||
## Running a full-node on the Cosmos Hub Mainnet
|
||||
|
||||
In order to run a full-node for the Cosmos Hub mainnet, you must first [install `gaiad`](../gaia-tutorials/installation.md). Then, follow [the guide](../gaia-tutorials/join-mainnet.md).
|
||||
|
||||
If you are looking to run a validator node, follow the [validator setup guide](../validators/validator-setup.md).
|
||||
|
||||
## Join the Community
|
||||
|
||||
Have questions, comments, or new ideas? Participate in the Cosmos community through one of the following channels. Also check out the [latest events](https://cosmos.network/community).
|
||||
|
||||
* [Cosmos Community Chat](https://t.me/cosmosproject)
|
||||
* [Cosmos Developer Chat](https://riot.im/app/#/room/#cosmos:matrix.org)
|
||||
* [Cosmos Forum](https://forum.cosmos.network)
|
||||
* [Cosmos on Reddit](https://reddit.com/r/cosmosnetwork)
|
||||
|
||||
To learn more about the Cosmos Hub and how it fits within the Cosmos Network, visit [cosmos.network](https://cosmos.network).
|
||||
Read the [overview](./overview.md).
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
<!--
|
||||
order: 1
|
||||
-->
|
||||
|
||||
|
||||
|
||||
# Introduction
|
||||
|
||||
The Cosmos Hub is the first of [thousands of interconnected blockchains](https://cosmos.network) that will eventually comprise the **Cosmos Network**. The primary token of the Cosmos Hub is the **ATOM**, but the Hub will support many tokens in the future.
|
||||
|
||||
## The ATOM
|
||||
|
||||
Do you have ATOM tokens? With ATOM, you have the superpower to contribute to the security and governance of the Cosmos Hub. Delegate your ATOM to one or more of the 100 validators on the Cosmos Hub blockchain to earn more ATOM through Proof-of-Stake. You can also vote with your ATOM to influence the future of the Cosmos Hub through on-chain governance proposals.
|
||||
|
||||
Learn more about [being a delegator](../delegators/delegator-faq.md), learn about [the security risks](../delegators/delegator-security.md), and start participating with one of the following wallets.
|
||||
|
||||
## Cosmos Hub Wallets
|
||||
|
||||
::: warning
|
||||
Do your own research and take precautions in regards to wallet security. Neither Tendermint Inc nor the Interchain Foundation is liable if you lose your funds using these third party wallets.
|
||||
:::
|
||||
|
||||
These community-maintained web and mobile wallets allow you to store & transfer ATOM, delegate ATOM to validators, and vote on on-chain governance proposals. Note that we do not endorse any of the wallets, they are listed for your convenience.
|
||||
|
||||
* [Atomic Wallet](https://atomicwallet.io/) - Android, Linux, macOS, Windows
|
||||
* [Cobo](https://cobo.com/) - Android, iOS
|
||||
* [Cosmostation](https://www.cosmostation.io/) - Android, iOS
|
||||
* [Huobi Wallet](https://www.huobiwallet.com/) - Android, iOS
|
||||
* [imToken](https://token.im/) - Android, iOS
|
||||
* [Lunagram](https://lunamint.com/) - Android, iOS
|
||||
* [Lunie](https://lunie.io) - Web
|
||||
* [Math Wallet](https://www.mathwallet.org/en/) - Android, iOS, Web
|
||||
* [Rainbow Wallet](https://www.rainbow.one) - Android, iOS
|
||||
* [Qbao Wallet](https://qbao.fund/) - Android, iOS
|
||||
* [Trust Wallet](https://trustwallet.com/) Android, iOS
|
||||
* [Wetez](https://www.wetez.io/pc/homepage) - Android, iOS
|
||||
|
||||
|
||||
## Cosmos Hub Explorers
|
||||
|
||||
These block explorers allow you to search, view and analyze Cosmos Hub data—like blocks, transactions, validators, etc.
|
||||
|
||||
* [Big Dipper](https://cosmos.bigdipper.live)
|
||||
* [Cosmos Overview](https://genesislab.net)
|
||||
* [Coris](http://coris.network)
|
||||
* [Cosmos Visualizer](https://nylira.net/3d)
|
||||
* [Hubble](https://hubble.figment.network)
|
||||
* [Mintscan](https://mintscan.io)
|
||||
* [Stargazer](https://stargazer.certus.one)
|
||||
|
||||
## Cosmos Hub CLI
|
||||
|
||||
`gaiacli` is a command-line interface that lets you interact with the Cosmos Hub. `gaiacli` is the only tool that supports 100% of the Cosmos Hub features, including accounts, transfers, delegation, and governance. Learn more about `gaiacli` with the [delegator's CLI guide](../delegators/delegator-guide-cli.md).
|
||||
|
||||
## Running a full-node on the Cosmos Hub Mainnet
|
||||
|
||||
In order to run a full-node for the Cosmos Hub mainnet, you must first [install `gaiad`](../gaia-tutorials/installation.md). Then, follow [the guide](../gaia-tutorials/join-mainnet.md).
|
||||
|
||||
If you are looking to run a validator node, follow the [validator setup guide](../validators/validator-setup.md).
|
||||
|
||||
## Join the Community
|
||||
|
||||
Have questions, comments, or new ideas? Participate in the Cosmos community through one of the following channels. Also check out the [latest events](https://cosmos.network/community).
|
||||
|
||||
* [Cosmos Community Chat](https://t.me/cosmosproject)
|
||||
* [Cosmos Developer Chat](https://riot.im/app/#/room/#cosmos:matrix.org)
|
||||
* [Cosmos Forum](https://forum.cosmos.network)
|
||||
* [Cosmos on Reddit](https://reddit.com/r/cosmosnetwork)
|
||||
|
||||
To learn more about the Cosmos Hub and how it fits within the Cosmos Network, visit [cosmos.network](https://cosmos.network).
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
-->
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
-->
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
-->
|
||||
|
||||
# Migration Instructions
|
||||
|
||||
This directory houses Cosmos Hub major upgrade migration instructions.
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,15 @@
|
|||
{
|
||||
"name": "docs",
|
||||
"version": "1.0.0",
|
||||
"description": "Welcome to the Gaia documentation!",
|
||||
"main": "index.js",
|
||||
"dependencies": {
|
||||
"vuepress-theme-cosmos": "^1.0.133"
|
||||
},
|
||||
"scripts": {
|
||||
"serve": "trap 'exit 0' SIGINT; vuepress dev --no-cache",
|
||||
"build": "trap 'exit 0' SIGINT; vuepress build --no-cache"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC"
|
||||
}
|
||||
|
|
@ -1,8 +1,10 @@
|
|||
---
|
||||
<!--
|
||||
order: false
|
||||
parent:
|
||||
order: 5
|
||||
---
|
||||
-->
|
||||
|
||||
# Resources
|
||||
|
||||
This folder contains resources on the `gaia` software.
|
||||
|
||||
|
|
@ -11,4 +13,4 @@ This folder contains resources on the `gaia` software.
|
|||
- [HD Wallets for `gaia`](./hd-wallets.md)
|
||||
- [Ledger Integration for `gaia`](./ledger.md)
|
||||
- [Service Providers Documentation](./service-providers.md)
|
||||
- [Reproducible Builds](./reproducible-builds.md)
|
||||
- [Reproducible Builds](./reproducible-builds.md)
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
<!--
|
||||
order: 7
|
||||
---
|
||||
-->
|
||||
|
||||
# Cosmos Hub Archives
|
||||
|
||||
With each breaking upgrade of the Cosmos Hub, the network is restarted at height 0. During this process, an export of the last state of the previous network is made to produce the genesis state of the new one.
|
||||
With each breaking upgrade of the Cosmos Hub, the network is restarted at height 0. During this process, an export of the last state of the previous network is made to produce the genesis state of the new one.
|
||||
|
||||
As a result, the blocks of the previous networks are not downloaded by new clients (as they sync from the new genesis state), and may be deleted by existing full-nodes.
|
||||
As a result, the blocks of the previous networks are not downloaded by new clients (as they sync from the new genesis state), and may be deleted by existing full-nodes.
|
||||
|
||||
In an effort to maintain transparency, the interchain hosts archives of the previous versions of the Cosmos Hub network. These archives can be found [here](https://archive.interchain.io/).
|
||||
|
||||
|
|
@ -21,5 +22,4 @@ If you would like to search explorers for previous hub data, these are some link
|
|||
- [Cosmos Hub 1](https://hubble.figment.network/cosmos/chains/cosmoshub-1)
|
||||
- [Cosmos Hub 2](https://hubble.figment.network/cosmos/chains/cosmoshub-2)
|
||||
|
||||
|
||||
If you want to makes archives available to the community, feel free to open a PR to this file and add them.
|
||||
If you want to makes archives available to the community, feel free to open a PR to this file and add them.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 1
|
||||
---
|
||||
-->
|
||||
|
||||
# Gaia Client
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ order: 1
|
|||
|
||||
`gaiacli` is the tool that enables you to interact with the node that runs on the Cosmos Hub network, whether you run it yourself or not. Let us set it up properly. In order to install it, follow the [installation procedure](../gaia-tutorials/installation.md).
|
||||
|
||||
### Setting up gaiacli
|
||||
### Setting up gaiacli
|
||||
|
||||
The main command used to set up `gaiacli` is the following:
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ The main command used to set up `gaiacli` is the following:
|
|||
gaiacli config <flag> <value>
|
||||
```
|
||||
|
||||
It allows you to set a default value for each given flag.
|
||||
It allows you to set a default value for each given flag.
|
||||
|
||||
First, set up the address of the full-node you want to connect to:
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ gaiacli config node <host>:<port>
|
|||
# example: gaiacli config node https://77.87.106.33:26657
|
||||
```
|
||||
|
||||
If you run your own full-node, just use `tcp://localhost:26657` as the address.
|
||||
If you run your own full-node, just use `tcp://localhost:26657` as the address.
|
||||
|
||||
Then, let us set the default value of the `--trust-node` flag:
|
||||
|
||||
|
|
@ -174,12 +174,12 @@ is included in a block.
|
|||
|
||||
### Fees & Gas
|
||||
|
||||
Each transaction may either supply fees or gas prices, but not both.
|
||||
Each transaction may either supply fees or gas prices, but not both.
|
||||
|
||||
Validator's have a minimum gas price (multi-denom) configuration and they use
|
||||
this value when when determining if they should include the transaction in a block during `CheckTx`, where `gasPrices >= minGasPrices`. Note, your transaction must supply fees that are greater than or equal to __any__ of the denominations the validator requires.
|
||||
this value when when determining if they should include the transaction in a block during `CheckTx`, where `gasPrices >= minGasPrices`. Note, your transaction must supply fees that are greater than or equal to **any** of the denominations the validator requires.
|
||||
|
||||
__Note__: With such a mechanism in place, validators may start to prioritize
|
||||
**Note**: With such a mechanism in place, validators may start to prioritize
|
||||
txs by `gasPrice` in the mempool, so providing higher fees or gas prices may yield higher tx priority.
|
||||
|
||||
e.g.
|
||||
|
|
@ -198,7 +198,7 @@ gaiacli tx send ... --gas-prices=0.025uatom
|
|||
|
||||
#### Get Tokens
|
||||
|
||||
On a testnet, getting tokens is usually done via a faucet.
|
||||
On a testnet, getting tokens is usually done via a faucet.
|
||||
|
||||
#### Query Account Balance
|
||||
|
||||
|
|
@ -326,7 +326,7 @@ You can find a list of available `events` on each of the SDK modules:
|
|||
- [Slashing events](https://github.com/cosmos/cosmos-sdk/blob/master/x/slashing/spec/06_events.md)
|
||||
- [Distribution events](https://github.com/cosmos/cosmos-sdk/blob/master/x/distribution/spec/06_events.md)
|
||||
- [Bank events](https://github.com/cosmos/cosmos-sdk/blob/master/x/bank/spec/04_events.md)
|
||||
:::
|
||||
:::
|
||||
|
||||
#### Matching a Transaction's Hash
|
||||
|
||||
|
|
@ -565,8 +565,8 @@ Some considerations about the voting process:
|
|||
- Voting is done by bonded `ATOM` holders on a 1 bonded `ATOM` 1 vote basis
|
||||
- Delegators inherit the vote of their validator if they don't vote
|
||||
- Votes are tallied at the end of the voting period (2 weeks on mainnet) where
|
||||
each address can vote multiple times to update its `Option` value (paying the transaction fee each time),
|
||||
only the most recently cast vote will count as valid
|
||||
each address can vote multiple times to update its `Option` value (paying the transaction fee each time),
|
||||
only the most recently cast vote will count as valid
|
||||
- Voters can choose between options `Yes`, `No`, `NoWithVeto` and `Abstain`
|
||||
- At the end of the voting period, a proposal is accepted iff:
|
||||
- `(YesVotes / (YesVotes+NoVotes+NoWithVetoVotes)) > 1/2`
|
||||
|
|
@ -638,7 +638,7 @@ respective parameter, eg. `MaxValidators` should be an integer and not a decimal
|
|||
|
||||
Proper vetting of a parameter change proposal should prevent this from happening
|
||||
(no deposits should occur during the governance process), but it should be noted
|
||||
regardless.
|
||||
regardless.
|
||||
|
||||
:::
|
||||
|
||||
|
|
@ -863,7 +863,7 @@ gaiacli tx sign \
|
|||
unsignedTx.json \
|
||||
--multisig=<multisig_address> \
|
||||
--from=p1 \
|
||||
--output-document=p1signature.json
|
||||
--output-document=p1signature.json
|
||||
```
|
||||
|
||||
Once the signature is generated, `p1` transmits both `unsignedTx.json` and
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 2
|
||||
---
|
||||
-->
|
||||
|
||||
# Genesis File
|
||||
|
||||
|
|
@ -16,13 +16,13 @@ The genesis file is stored in `~/.gaiad/config/genesis.toml`.
|
|||
|
||||
## What is a Genesis File
|
||||
|
||||
A genesis file is a JSON file which defines the initial state of your blockchain. It can be seen as height `0` of your blockchain. The first block, at height `1`, will reference the genesis file as its parent.
|
||||
A genesis file is a JSON file which defines the initial state of your blockchain. It can be seen as height `0` of your blockchain. The first block, at height `1`, will reference the genesis file as its parent.
|
||||
|
||||
The state defined in the genesis file contains all the necessary information, like initial token allocation, genesis time, default parameters, and more. Let us break down these information.
|
||||
|
||||
## Genesis Time and Chain_id
|
||||
## Genesis Time and Chain_id
|
||||
|
||||
The `genesis_time` is defined at the top of the genesis file. It is a `UTC` timestamps which specifies when the blockchain is due to start. At this time, genesis validators are supposed to come online and start participating in the consensus process. The blockchain starts when more than 2/3rd of the genesis validators (weighted by voting power) are online.
|
||||
The `genesis_time` is defined at the top of the genesis file. It is a `UTC` timestamps which specifies when the blockchain is due to start. At this time, genesis validators are supposed to come online and start participating in the consensus process. The blockchain starts when more than 2/3rd of the genesis validators (weighted by voting power) are online.
|
||||
|
||||
```json
|
||||
"genesis_time": "2019-03-13T17:00:00.000000000Z",
|
||||
|
|
@ -39,12 +39,12 @@ The `chain_id` is a unique identifier for your chain. It helps differentiate bet
|
|||
Next, the genesis file defines consensus parameters. Consensus parameters regroup all the parameters that are related to the consensus layer, which is `Tendermint` in the case of `gaia`. Let us look at these parameters:
|
||||
|
||||
- `block`
|
||||
+ `max_bytes`: Maximum number of bytes per block.
|
||||
+ `max_gas`: Gas limit per block. Each transaction included in the block will consume some gas. The total gas used by transactions included in a block cannot exceed this limit.
|
||||
- `max_bytes`: Maximum number of bytes per block.
|
||||
- `max_gas`: Gas limit per block. Each transaction included in the block will consume some gas. The total gas used by transactions included in a block cannot exceed this limit.
|
||||
- `evidence`
|
||||
+ `max_age`: An evidence is a proof that a validator signed two different blocks at the same height (and round). This is an explicitly malicious behaviour that is punished at the state-machine level. The `max_age` defines the maximum number of **blocks** after which an evidence is not valid anymore.
|
||||
- `max_age`: An evidence is a proof that a validator signed two different blocks at the same height (and round). This is an explicitly malicious behaviour that is punished at the state-machine level. The `max_age` defines the maximum number of **blocks** after which an evidence is not valid anymore.
|
||||
- `validator`
|
||||
+ `pub_key_types`: The types of pubkey (`ed25519`, `secp256k1`, ...) that are accepted for validators. Currently only `ed25519` is accepted.
|
||||
- `pub_key_types`: The types of pubkey (`ed25519`, `secp256k1`, ...) that are accepted for validators. Currently only `ed25519` is accepted.
|
||||
|
||||
```json
|
||||
"consensus_params": {
|
||||
|
|
@ -65,7 +65,7 @@ Next, the genesis file defines consensus parameters. Consensus parameters regrou
|
|||
|
||||
## Application State
|
||||
|
||||
The application state defines the initial state of the state-machine.
|
||||
The application state defines the initial state of the state-machine.
|
||||
|
||||
### Genesis Accounts
|
||||
|
||||
|
|
@ -110,12 +110,12 @@ Let us break down the parameters:
|
|||
- `sequence_number`: This number is used to count the number of transactions sent by this account. It is incremented each time a transaction is included in a block, and used to prevent replay attacks. Initial value is `0`.
|
||||
- `account_number`: Unique identifier for the account. It is generated the first time a transaction including this account is included in a block.
|
||||
- `original_vesting`: Vesting is natively supported by `gaia`. You can define an amount of token owned by the account that needs to be vested for a period of time before they can be transferred. Vested tokens can be delegated. Default value is `null`.
|
||||
- `delegated_free`: Amount of delegated tokens that can be transferred after they've been vested. Most of the time, will be `null` in genesis.
|
||||
- `delegated_free`: Amount of delegated tokens that can be transferred after they've been vested. Most of the time, will be `null` in genesis.
|
||||
- `delegated_vesting`: Amount of delegated tokens that are still vesting. Most of the time, will be `null` in genesis.
|
||||
- `start_time`: Block at which the vesting period starts. `0` most of the time in genesis.
|
||||
- `end_time`: Block at which the vesting period ends. `0` if no vesting for this account.
|
||||
|
||||
### Bank
|
||||
### Bank
|
||||
|
||||
The `bank` module handles tokens. The only parameter that needs to be defined in this section is wether `transfers` are enabled at genesis or not.
|
||||
|
||||
|
|
@ -154,13 +154,13 @@ The `staking` module handles the bulk of the Proof-of-Stake logic of the state-m
|
|||
Let us break down the parameters:
|
||||
|
||||
- `pool`
|
||||
+ `not_bonded_tokens`: Defines the amount of tokens not bonded (i.e. delegated) in genesis. Generally, it equals the total supply of the staking token (`uatom` in this example).
|
||||
+ `bonded_tokens`: Amount of bonded tokens in genesis. Generally `0`.
|
||||
- `not_bonded_tokens`: Defines the amount of tokens not bonded (i.e. delegated) in genesis. Generally, it equals the total supply of the staking token (`uatom` in this example).
|
||||
- `bonded_tokens`: Amount of bonded tokens in genesis. Generally `0`.
|
||||
- `params`
|
||||
+ `unbonding_time`: Time in **nanosecond** it takes for tokens to complete unbonding.
|
||||
+ `max_validators`: Maximum number of active validators.
|
||||
+ `max_entries`: Maximum unbonding delegations and redelegations between a particular pair of delegator / validator.
|
||||
+ `bond_denom`: Denomination of the staking token.
|
||||
- `unbonding_time`: Time in **nanosecond** it takes for tokens to complete unbonding.
|
||||
- `max_validators`: Maximum number of active validators.
|
||||
- `max_entries`: Maximum unbonding delegations and redelegations between a particular pair of delegator / validator.
|
||||
- `bond_denom`: Denomination of the staking token.
|
||||
- `last_total_power`: Total amount of voting power. Generally `0` in genesis (except if genesis was generated using a previous state).
|
||||
- `last_validator_powers`: Power of each validator in last known state. Generally `null` in genesis (except if genesis was generated using a previous state).
|
||||
- `validators`: List of last known validators. Generally `null` in genesis (except if genesis was generated using a previous state).
|
||||
|
|
@ -193,15 +193,15 @@ The `mint` module governs the logic of inflating the supply of token. The `mint`
|
|||
Let us break down the parameters:
|
||||
|
||||
- `minter`
|
||||
+ `inflation`: Initial yearly percentage of increase in the total supply of staking token, compounded weekly. A `0.070000000000000000` value means the target is `7%` yearly inflation, compounded weekly.
|
||||
+ `annual_provisions`: Calculated each block. Initialize at `0.000000000000000000`.
|
||||
- `inflation`: Initial yearly percentage of increase in the total supply of staking token, compounded weekly. A `0.070000000000000000` value means the target is `7%` yearly inflation, compounded weekly.
|
||||
- `annual_provisions`: Calculated each block. Initialize at `0.000000000000000000`.
|
||||
- `params`
|
||||
+ `mint_denom`: Denom of the staking token that is inflated.
|
||||
+ `inflation_rate_change`: Max yearly change in inflation.
|
||||
+ `inflation_max`: Maximum level of inflation.
|
||||
+ `inflation_min`: Minimum level of inflation.
|
||||
+ `goal_bonded`: Percentage of the total supply that is targeted to be bonded. If the percentage of bonded staking tokens is below this target, the inflation increases (following `inflation_rate_change`) until it reaches `inflation_max`. If the percentage of bonded staking tokens is above this target, the inflation decreases (following `inflation_rate_change`) until it reaches `inflation_min`.
|
||||
+ `blocks_per_year`: Estimation of the amount of blocks per year. Used to compute the block reward coming from inflated staking token (called block provisions).
|
||||
- `mint_denom`: Denom of the staking token that is inflated.
|
||||
- `inflation_rate_change`: Max yearly change in inflation.
|
||||
- `inflation_max`: Maximum level of inflation.
|
||||
- `inflation_min`: Minimum level of inflation.
|
||||
- `goal_bonded`: Percentage of the total supply that is targeted to be bonded. If the percentage of bonded staking tokens is below this target, the inflation increases (following `inflation_rate_change`) until it reaches `inflation_max`. If the percentage of bonded staking tokens is above this target, the inflation decreases (following `inflation_rate_change`) until it reaches `inflation_min`.
|
||||
- `blocks_per_year`: Estimation of the amount of blocks per year. Used to compute the block reward coming from inflated staking token (called block provisions).
|
||||
|
||||
### Distribution
|
||||
|
||||
|
|
@ -230,16 +230,16 @@ The `distribution` module handles the logic of distribution block provisions and
|
|||
Let us break down the parameters:
|
||||
|
||||
- `fee_pool`
|
||||
+ `community_pool`: The community pool is a pool of tokens that can be used to pay for bounties. It is allocated via governance proposals. Generally `null` in genesis.
|
||||
- `community_pool`: The community pool is a pool of tokens that can be used to pay for bounties. It is allocated via governance proposals. Generally `null` in genesis.
|
||||
- `community_tax`: The tax percentage on fees and block rewards that goes to the community pool.
|
||||
- `base_proposer_reward`: Base bonus on transaction fees collected in a valid block that goes to the proposer of block. If value is `0.010000000000000000`, 1% of the fees go to the proposer.
|
||||
- `base_proposer_reward`: Base bonus on transaction fees collected in a valid block that goes to the proposer of block. If value is `0.010000000000000000`, 1% of the fees go to the proposer.
|
||||
- `bonus_proposer_reward`: Max bonus on transaction fees collected in a valid block that goes to the proposer of block. The bonus depends on the number of `precommits` the proposer includes. If the proposer includes 2/3rd `precommits` weighted by voting power (minimum for the block to be valid), they get a bonus of `base_proposer_reward`. This bonus increases linearly up to `bonus_proposer_reward` if the proposer includes 100% of `precommits`.
|
||||
- `withdraw_addr_enabled`: If `true`, delegators can set a different address to withdraw their rewards. Set to `false` if you want to disable transfers at genesis, as it can be used as a way to get around the restriction.
|
||||
- `delegator_withdraw_infos`: List of delegators withdraw address. Generally `null` if genesis was not exported from previous state.
|
||||
- `previous_proposer`: Proposer of the previous block. Set to `""` if genesis was not exported from previous state.
|
||||
- `outstanding_rewards`: Outstanding (un-withdrawn) rewards. Set to `null` if genesis was not exported from previous state.
|
||||
- `validator_accumulated_commission`: Outstanding (un-withdrawn) commission of validators. Set to `null` if genesis was not exported from previous state.
|
||||
- `validator_historical_rewards`: Set of information related to the historical rewards of validators and used by the `distribution` module for various computation. Set to `null` if genesis was not exported from previous state.
|
||||
- `validator_historical_rewards`: Set of information related to the historical rewards of validators and used by the `distribution` module for various computation. Set to `null` if genesis was not exported from previous state.
|
||||
- `validators_current_rewards`: Set of information related to the current rewards of validators and used by the `distribution` module for various computation. Set to `null` if genesis was not exported from previous state.
|
||||
- `delegator_starting_infos`: Tracks the previous validator period, the delegation's amount of staking token, and the creation height (to check later on if any slashes have occurred). Set to `null` if genesis was not exported from previous state.
|
||||
- `validator_slash_events`: Set of information related to the past slashing of validators. Set to `null` if genesis was not exported from previous state.
|
||||
|
|
@ -282,17 +282,17 @@ Let us break down the parameters:
|
|||
- `votes`: List of votes for each proposal ID. Set to `null` if genesis was not exported from previous state.
|
||||
- `proposals`: List of proposals for each proposal ID: Set to `null` if genesis was not exported from previous state.
|
||||
- `deposit_params`
|
||||
+ `min_deposit`: The minimum deposit required for the proposal to enter `Voting Period`. If multiple denoms are provided, the `OR` operator applies.
|
||||
+ `max_deposit_period`: The maximum period (in **nanoseconds**) after which it is not possible to deposit on the proposal anymore.
|
||||
- `min_deposit`: The minimum deposit required for the proposal to enter `Voting Period`. If multiple denoms are provided, the `OR` operator applies.
|
||||
- `max_deposit_period`: The maximum period (in **nanoseconds**) after which it is not possible to deposit on the proposal anymore.
|
||||
- `voting_params`
|
||||
+ `voting_period`: Length of the voting period in **nanoseconds**.
|
||||
- `voting_period`: Length of the voting period in **nanoseconds**.
|
||||
- `tally_params`
|
||||
+ `quorum`: Minimum percentage of bonded staking tokens that needs to vote for the result to be valid.
|
||||
+ `threshold`: Minimum percentage of votes that need to be `YES` for the result to be valid.
|
||||
+ `veto`: Maximum percentage `NO_WITH_VETO` votes for the result to be valid.
|
||||
+ `governance_penalty`: Penalty for validators that do not vote on a given proposal.
|
||||
- `quorum`: Minimum percentage of bonded staking tokens that needs to vote for the result to be valid.
|
||||
- `threshold`: Minimum percentage of votes that need to be `YES` for the result to be valid.
|
||||
- `veto`: Maximum percentage `NO_WITH_VETO` votes for the result to be valid.
|
||||
- `governance_penalty`: Penalty for validators that do not vote on a given proposal.
|
||||
|
||||
### Slashing
|
||||
### Slashing
|
||||
|
||||
The `slashing` module handles the logic to slash delegators if their validator misbehave. The `slashing` section in genesis looks as follows:
|
||||
|
||||
|
|
@ -314,12 +314,12 @@ The `slashing` module handles the logic to slash delegators if their validator m
|
|||
Let us break down the parameters:
|
||||
|
||||
- `params`
|
||||
+ `max_evidence_age`: Maximum age of the evidence in **nanoseconds**.
|
||||
+ `signed_blocks_window`: Moving window of blocks to figure out offline validators.
|
||||
+ `min_signed_per_window`: Minimum percentage of `precommits`that must be present in the `block window` for the validator to be considered online.
|
||||
+ `downtime_jail_duration`: Duration in **nanoseconds** for which a validator is jailed after they get slashed for downtime.
|
||||
+ `slash_fraction_double_sign`: Percentage of delegators bonded stake slashed when their validator double signs.
|
||||
+ `slash_fraction_downtime`: Percentage of delegators bonded stake slashed when their validator is down.
|
||||
- `max_evidence_age`: Maximum age of the evidence in **nanoseconds**.
|
||||
- `signed_blocks_window`: Moving window of blocks to figure out offline validators.
|
||||
- `min_signed_per_window`: Minimum percentage of `precommits`that must be present in the `block window` for the validator to be considered online.
|
||||
- `downtime_jail_duration`: Duration in **nanoseconds** for which a validator is jailed after they get slashed for downtime.
|
||||
- `slash_fraction_double_sign`: Percentage of delegators bonded stake slashed when their validator double signs.
|
||||
- `slash_fraction_downtime`: Percentage of delegators bonded stake slashed when their validator is down.
|
||||
- `signing_infos`: Various infos per validator needed by the `slashing` module. Set to `{}` if genesis was not exported from previous state.
|
||||
- `missed_blocks`: Various infos related to missed blocks needed by the `slashing` module. Set to `{}` if genesis was not exported from previous state.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 3
|
||||
---
|
||||
-->
|
||||
|
||||
# HD Wallets
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 4
|
||||
---
|
||||
-->
|
||||
|
||||
# Ledger Nano Support
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 6
|
||||
---
|
||||
-->
|
||||
|
||||
# Build Gaia Deterministically
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 5
|
||||
---
|
||||
-->
|
||||
|
||||
# Service Providers
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
-->
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<!--
|
||||
parent:
|
||||
order: false
|
||||
-->
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
<!--
|
||||
order: false
|
||||
parent:
|
||||
order: 4
|
||||
---
|
||||
-->
|
||||
|
||||
# Validators
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 5
|
||||
---
|
||||
-->
|
||||
|
||||
# KMS - Key Management System
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 6
|
||||
---
|
||||
-->
|
||||
|
||||
# Setting up Tendermint KMS + Ledger
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 1
|
||||
---
|
||||
-->
|
||||
|
||||
# Validators Overview
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 4
|
||||
---
|
||||
-->
|
||||
|
||||
# Validator Security
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 3
|
||||
---
|
||||
-->
|
||||
|
||||
# Validator FAQ
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<!--
|
||||
order: 2
|
||||
---
|
||||
-->
|
||||
|
||||
# Run a Validator on the Cosmos Hub Mainnet
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
master
|
||||
|
|
@ -3,4 +3,4 @@
|
|||
Here contains the files required for automated deployment of either local or remote testnets.
|
||||
|
||||
Doing so is best accomplished using the `make` targets. For more information, see the
|
||||
[networks documentation](/docs/gaia/networks.md)
|
||||
[networks documentation](../docs/gaia-tutorials/deploy-testnet.md)
|
||||
|
|
|
|||
Loading…
Reference in New Issue