From 5e3c50431cdde427d38d7837a04f18a629ad5452 Mon Sep 17 00:00:00 2001 From: alok Date: Fri, 4 Jan 2019 21:09:42 -0800 Subject: [PATCH] adding readme --- internal/beaconchain/README.md | 3 +++ internal/newnode/README.md | 1 + 2 files changed, 4 insertions(+) diff --git a/internal/beaconchain/README.md b/internal/beaconchain/README.md index e69de29bb..bb5016f53 100644 --- a/internal/beaconchain/README.md +++ b/internal/beaconchain/README.md @@ -0,0 +1,3 @@ +The beaconchain package currently is a centralized service that allocates every potential new node (uses newnode package) a specific shard. +If N is the number of shards, supplied as a parameter at bootup, then first N joining nodes are assigned to be the leaders of those N shards. The nodes that come after that are then assigned shards based on their order of entry. +In the future, the generation of randomness would be decentralized. Such randomness would be provided to a new node once its PoS has been verified and then the node would be able to calculate its own shard automatically. \ No newline at end of file diff --git a/internal/newnode/README.md b/internal/newnode/README.md index e69de29bb..e1b7061ea 100644 --- a/internal/newnode/README.md +++ b/internal/newnode/README.md @@ -0,0 +1 @@ +Newnode package is for handling the interactions of a new candidate node that wants to join the network. Such interaction at the moment is about contacting the beaconchain and getting assigned a shard and findingout the shardleader. In future this package will be merged into the node package. \ No newline at end of file