Merge pull request #33 from status-im/develop

Develop
2019-04-03 14:38:48 +02:00 · 2019-04-03 14:38:48 +02:00 · 62aa329dbb
parent 0837e9143a 4c537fd365
commit 62aa329dbb
12 changed files with 138 additions and 14 deletions
--- a/source/_data/sidebar.yml
+++ b/source/_data/sidebar.yml
@ -4,7 +4,11 @@ docs:
    building: building.html
 #    milestones: milestones.html
    design: design.html
-    team: team.html
+    # team: team.html
    faq: faq.html
    contributor_guide: contributor_guide.html
+  Guides:
+    Testnet 0: t0.html
+    Testnet 1: t1.html
+    Custom Testnet: custom-nimbus-testnet.html
    
--- a/source/docs/custom-nimbus-testnet.md
+++ b/source/docs/custom-nimbus-testnet.md
@ -0,0 +1,72 @@
+---
+id: custom-nimbus-testnet
+title: Creating your own Nimbus testnet
+---
+
+## Building your own Nimbus testnet
+
+All beacon nodes joining your custom testnet MUST be compiled with the same beacon chain constants - i.e. if a node is compiled with 8 slots per epoch, one with 16 slots per epoch will not be compatible with it. With that in mind, let's do this step of building the basic beacon node binary from within `vendor/nim-beacon-chain`, and let's also build the tool that can generate validator keys.
+
+If you haven't cloned Nimbus already, do it now:
+
+```bash
+git clone https://github.com/status-im/nimbus
+cd nimbus
+make update
+cd vendor/nim-beacon-chain
+```
+
+Then let's build the binaries of the tools we'll need.
+
+```bash
+export NIMFLAGS="-d:release -d:SECONDS_PER_SLOT=30 -d:SHARD_COUNT=8 -d:SLOTS_PER_EPOCH=8" \
+&& make beacon_node validator_keygen
+```
+
+This will place the `beacon_node` binary and the `validator_keygen` tool in `build` in the current folder, i.e. `vendor/nim-beacon-chain`.
+
+Let's generate the folders where the node will store its data and then add the validator keys in there. I picked 500 keys.
+
+```bash
+mkdir -p $HOME/testnets/custom-network/data
+./build/validator_keygen --totalValidators=500 --outputDir="$HOME/testnets/custom-network"
+```
+
+This will have placed 500 private key files and 500 public key files into the specified output folder.
+
+Next, let's have the node generate a testnet for us with all the bells and whistles we might need to have others connect to us.
+
+```bash
+export NETWORK_DIR=$HOME/testnets/custom-network && ./build/beacon_node \
+--dataDir=$NETWORK_DIR/data \
+createTestnet \
+--networkId=666 \
+--validatorsDir=$NETWORK_DIR \
+--totalValidators=500 \
+--outputGenesis=$NETWORK_DIR/genesis.json \
+--outputNetwork=$NETWORK_DIR/custom-network.json \
+--bootstrapAddress=$(curl -s ifconfig.me) \
+--bootstrapPort=34000 \
+--genesisOffset=600
+```
+
+- We set the home folder of the custom network, pass it to the required params and have it generate the genesis file and the metadata file for others to join us through. 
+- The bootstrap address part is dynamically generated from the ifconfig.me service - you can manually input your public IP address here if you know it or if that service fails to detect it - test with `curl -s ifconfig.me` on the command line. 
+- The port is optional but recommended so you don't get some cross-chain noise when accidentally connecting to other nodes on the default port.
+- The `genesisOffset` flag sets the time of genesis to some time in the future - in this case 10 minutes. We do this to give everyone who intends to join ample chance to join on genesis time because if they don't and the chain expects validators to be there and perform their duties, they'll be seen as offline and penalized and eventually kicked off the beacon chain.
+
+Running the above command will result in two new files being created. In my case `$HOME/testnets/custom-network/genesis.json` and `$HOME/testnets/custom-network/custom-network.json`.
+
+We are now ready to connect and to share these files with those who would connect to us. Please note that in order to allow others to connect to you, you need to open the port you chose manually on your router and firewall for as long as Nimbus doesn't yet have UPnP implemented. If you're hosting your bootnode on something like DigitalOcean or AWS, there are firewall controls there that are quite intuitive. For your own local computer, please consult your router's manual on how to do that.
+
+The `genesis.json` file is the starting state, "block 0" of your testnet beacon chain. It contains the listed validators, initial shufflings, and everything the system needs in order to have the clients connecting to the network build on the same foundation. The `custom-network.json` file is the "metadata" file of your new network - it has identified your node, the one this file was generated with - as the bootstrap node and included its enode address under `bootstrapNodes`, along with the other required data and the root of the genesis. You can host these two files on a server somewhere or in a [Github Gist](https://gist.github.com) anyone grabbing them will be able to join your network if they execute the command:
+
+```bash
+./build/beacon_node --network=$HOME/testnets/custom-network/custom-network.json --stateSnapshot=$HOME/testnets/custom-network/genesis.json --tcpPort=34001 --udpPort=34001
+```
+
+However, they MUST first build their beacon node with the same parameters you did in the beginning of this setup.
+
+Congrats, you have a custom Nimbus testnet up and running!
+
+[![Screenshot-from-2019-03-29-21-25-15](https://our.status.im/content/images/2019/03/Screenshot-from-2019-03-29-21-25-15.png)](https://our.status.im/content/images/2019/03/Screenshot-from-2019-03-29-21-25-15.png)
--- a/source/docs/t0.md
+++ b/source/docs/t0.md
@ -0,0 +1,24 @@
+---
+id: t0
+title: Joining Nimbus Testnet0
+---
+
+This document is a very short guide on how to join our testnet. For a full explanation of what's going on behind the scenes, please see the official [announcement post](https://our.status.im/the-nimbus-mvp-testnet-is-here/).
+
+## Joining Nimbus Testnet 0
+
+Here is the full process if you're starting from scratch, without even Nim installed (you still need RocksDB though, so [install that first](https://github.com/status-im/nimbus#rocksdb)):
+
+```bash
+# Ensure you have rocksdb installed before running this!
+git clone https://github.com/status-im/nimbus
+cd nimbus
+make update # this might take a few minutes
+cd vendor/nim-beacon-chain # All Ethereum 2.0 functionality is in here
+make testnet0
+./build/testnet0_node # this launches the testnet0-specific node you just built
+```
+
+Congratulations, you should now be joining us - your node will start syncing with the current state of our beacon chain. Once you're in sync, you should also start proposing your own blocks and providing attestations - exciting! You are now among [Ethereum 2.0 Nimbus pioneers](https://gitcoin.co/kudos/1160/nimbus_pilot)!
+
+[![](https://our.status.im/content/images/2019/03/Annotation-2019-03-29-202131-1.png)](https://our.status.im/content/images/2019/03/Annotation-2019-03-29-202131-1.png)
--- a/source/docs/t1.md
+++ b/source/docs/t1.md
@ -0,0 +1,8 @@
+---
+id: t1
+title: Joining Nimbus Testnet1
+---
+
+## Joining Nimbus Testnet 1
+
+Testnet1 is under construction - announcement coming soon.
--- a/themes/navy/languages/en.yml
+++ b/themes/navy/languages/en.yml
@ -30,3 +30,7 @@ sidebar:
    team: Team
    options: Beyond the Basics
    contributor_guide: Contributor Guide
+    Testnet 0: Testnet 0
+    Testnet 1: Testnet 1
+    Custom Testnet: Custom Testnet
+    Guides: Guides
--- a/themes/navy/layout/index.swig
+++ b/themes/navy/layout/index.swig
@ -129,7 +129,7 @@
                </p>
            </div>
            <div class="contribute">
-                <img class="contributor" src="../img/ellipse.png" />
+                <img class="contributor" src="../img/tersec_moot.png" />
                <h3>Dustin Brody</h3>
                <p><a href="https://get.status.im/user/0x04ec0447abf1a0f7308b1acd52d0c4db6ebf287f7aea4588ff3a8e943143c4c3852cdf1b89474b829428e9ec1041d9ba47975b6154f970bf13f2ea2d87707d7276" style="color: #939ba1;">Pure Quickwitted Indianglassfish</a></p>
                <p>
@ -152,6 +152,14 @@
                    <span><a href="https://github.com/stefantalpalaru"><img src="../img/arrow_ogn.png" /></a></span>
                </p>
            </div>
+            <div class="contribute">
+                <img class="contributor" src="../img/kdeme_moot.png" />
+                <h3>Kim De Mey</h3>
+                <p><a href="https://get.status.im/" style="color: #939ba1;">? ? ?</a></p>
+                <p><a href="https://github.com/kdeme">See Github profile</a>
+                    <span><a href="https://github.com/kdeme"><img src="../img/arrow_ogn.png" /></a></span>
+                </p>
+            </div>
        </div>
        <div class="inner-header">
            <h2>Read our Blog</h2>
--- a/themes/navy/layout/partial/footer.swig
+++ b/themes/navy/layout/partial/footer.swig
@ -7,9 +7,9 @@
                  <p class="footer-header">Social links</p>
                  <ul class="footer-list">
                    <li class="footer-link footer-link--fb"><a href="https://www.facebook.com/ethstatus" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Facebook</span></a></li>
-                    <li class="footer-link footer-link--tw"><a href="https://twitter.com/ethstatus" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Twitter</span></a></li>
+                    <li class="footer-link footer-link--tw"><a href="https://twitter.com/ethnimbus" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Twitter</span></a></li>
                    <li class="footer-link footer-link--ri"><a href="https://chat.status.im/#/register" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Riot</span></a></li>
-                    <li class="footer-link footer-link--gh"><a href="https://github.com/status-im" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Github</span></a></li>
+                    <li class="footer-link footer-link--gh"><a href="https://github.com/status-im/nimbus" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Github</span></a></li>
                    <li class="footer-link footer-link--rd"><a href="https://www.reddit.com/r/statusim/" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">Reddit</span></a></li>
                    <li class="footer-link footer-link--yt"><a href="https://www.youtube.com/statusim" target="_blank"><span class="footer-icon"></span><span class="footer-link-label">YouTube</span></a></li>
                  </ul>
@ -18,7 +18,7 @@
                <div class="footer-table__column">
                  <p class="footer-header">More</p>
                  <ul class="footer-list">
-                    <li class="footer-link"><a href="/docs/" target="_blank">Status Docs</a></li>
+                    <li class="footer-link"><a href="https://status.im/docs/" target="_blank">Status Docs</a></li>
                    <li class="footer-link"><a href="https://our.status.im/" target="_blank">Status Blog</a></li>
                    <li class="footer-link"><a href="/contribute/" target="_blank">Jobs</a></li>
                    <li class="footer-link"><a href="/privacy-policy.html" target="_blank">Privacy Policy</a></li>
@ -31,7 +31,7 @@
                    <li class="footer-link"><a href="https://embark.status.im" target="_blank">Embark</a></li>
                    <li class="footer-link"><a href="https://incubate.status.im/" target="_blank">Incubate</a></li>
                    <li class="footer-link"><a href="https://nimbus.status.im/" target="_blank">Nimbus</a></li>
-                    <li class="footer-link"><a href="https://studio.status.im/" target="_blank">Studio</a></li>
+                    <li class="footer-link"><a href="https://keycard.status.im/" target="_blank">Keycard</a></li>
                  </ul>
                </div>

--- a/themes/navy/layout/partial/header-nav.swig
+++ b/themes/navy/layout/partial/header-nav.swig
@ -1,9 +1,9 @@
 <ul class="main-nav">
    <li class="item--to-show"><a href="https://status.im/get" class="">App</a></li>
-    <li class="item--to-show"> <a href="https://our.status.im/">Blog</a> </li>
-    <li class="item--to-show"> <a href="https://status.im/docs">Docs</a></li>
+    <li class="item--to-show"> <a href="https://our.status.im/tag/nimbus">Blog</a> </li>
+    <li class="item--to-show"> <a href="/docs">Docs</a></li>
    <li class="item--dropdown item--dropdown-projects"> <a href="#" class="">Projects</a></li>
-    <li><a href="https://status.im/contribute">Contribute</a></li>
+    <li><a href="/docs/contributor_guide.html">Contribute</a></li>
    <li class="item--dropdown"><a href="#" class="item--dropdown-community">Community</a></li>
    <li class="item--more"><a href="#" class="item--more">More</a></li>
 </ul>
--- a/themes/navy/layout/partial/header.swig
+++ b/themes/navy/layout/partial/header.swig
@ -1,6 +1,6 @@
 <div class="header">
    <div class="header-left">
-        <a class="logo" href={{url_for_lang('/')}}></a>
+        <a class="logo" href="/"></a>
        {{ partial('partial/header-nav') }}
    </div>
    <div class="header-right">
@ -10,11 +10,11 @@

 <div class="mobile-nav-wrap">
    <div class="mobile-nav-inner">
-        <a class="logo" href={{url_for_lang('/')}}></a>
+        <a class="logo" href="/"></a>
        <a class="icon-close mobile-nav-close" href="#"></a>
        <ul class="mobile-nav">
            <li><a href="https://our.status.im/tag/nimbus/">Blog</a></li>
-            <li><a href={{url_for_lang('docs')}}>Docs</a></li>
+            <li><a href="/docs">Docs</a></li>
            <li class="item--dropdown item--to-show">
              <span>Projects</span>
              <ul class="mobile-sub-nav">
--- a/themes/navy/source/img/kdeme_moot.png
+++ b/themes/navy/source/img/kdeme_moot.png
--- a/themes/navy/source/img/tersec_moot.png
+++ b/themes/navy/source/img/tersec_moot.png
--- a/themes/navy/source/scss/sidebar.scss
+++ b/themes/navy/source/scss/sidebar.scss
@ -9,7 +9,7 @@ $sidebar-width: 30%;
      display: none;
    }
    strong {
-      display: none;
+      // display: none;
    }
  }
 }
@ -17,7 +17,7 @@ $sidebar-width: 30%;
 .sidebar-title {
  margin-top: 40px;
  padding: 10px 0;
-  font-family: font-title;
+  // font-family: font-title;
  font-weight: bold;
  color: color-title;
  display: inline-block;
@ -25,6 +25,10 @@ $sidebar-width: 30%;
  line-height: 1;
 }

+.sidebar-title:first-child {
+  margin-top: 0;
+}
+
 .sidebar-link {
  border-radius: 23.5px;
  font-size: 15px;