Commit 81bdce5a3ac4141e1dd49f6108ed775aa417e9be
Emojify architecture explanation
Joran committed on 11/24/2016, 9:07:59 PMParent: 500293380ce00f0ae704474343e9b0b5e4edcce4
Files changed
README.md | changed |
README.md | ||
---|---|---|
@@ -15,50 +15,54 @@ | ||
15 | 15 … | [![Throughput Graph](https://graphs.waffle.io/ProjectEntropy/contracts/throughput.svg)](https://waffle.io/ProjectEntropy/contracts/metrics/throughput) |
16 | 16 … | |
17 | 17 … | ## Architecture |
18 | 18 … | |
19 … | +[![Architecture Diagram](https://s3-ap-southeast-2.amazonaws.com/bitboatassets/bitboat/assets/entropyDappDesc-7bbe05db5bc36c1a80ee3c13e24aaf22350c948b788b7cf8e29fb97c6bb3cce7.png?X-Amz-Date=20161124T210606Z&X-Amz-Expires=300&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Signature=9a7ce268a93cbb5afe46b1b6b82e6f026e095b249dfa454171205ee39607ac22&X-Amz-Credential=ASIAIS2OVHQA6275XHVQ/20161124/ap-southeast-2/s3/aws4_request&X-Amz-SignedHeaders=Host&x-amz-security-token=FQoDYXdzEMb//////////wEaDK7tRxxuqMSh9xXh1SL6AcXciOUgyOPB15/QnY19D9hWgNi7fVOsICzzBXYAxCEt5pVgMHTU5bhqtfwufhksc7SuOcF2Tc6bL3Prw%2BvCB8tD8BvlQfv3X7dkO41HB9NceaZlCZTXloLrCvL3sD56CWshq2GAQ1ie9VU3nux86G40SDLakQtBqVDlDr%2BdTj8%2ByCH9GCVV2IFPqfJdlcuq2oGTDhaANE9xyFnnpi%2Bm55D8DFb%2BQi0QTfiMGj1x8ydTsPM2L54ij2iAjpPqysqpzii%2B3SYIz7Y3ht%2BDByV3LEpSKY0bNBOEOzHyJqxgfVxuFl3PEwqyxTJmioUwLBUlhS/RIOteO%2B/1iFUo%2BavdwQU%3D)](https://s3-ap-southeast-2.amazonaws.com/bitboatassets/bitboat/assets/entropyDappDesc-7bbe05db5bc36c1a80ee3c13e24aaf22350c948b788b7cf8e29fb97c6bb3cce7.png?X-Amz-Date=20161124T210606Z&X-Amz-Expires=300&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Signature=9a7ce268a93cbb5afe46b1b6b82e6f026e095b249dfa454171205ee39607ac22&X-Amz-Credential=ASIAIS2OVHQA6275XHVQ/20161124/ap-southeast-2/s3/aws4_request&X-Amz-SignedHeaders=Host&x-amz-security-token=FQoDYXdzEMb//////////wEaDK7tRxxuqMSh9xXh1SL6AcXciOUgyOPB15/QnY19D9hWgNi7fVOsICzzBXYAxCEt5pVgMHTU5bhqtfwufhksc7SuOcF2Tc6bL3Prw%2BvCB8tD8BvlQfv3X7dkO41HB9NceaZlCZTXloLrCvL3sD56CWshq2GAQ1ie9VU3nux86G40SDLakQtBqVDlDr%2BdTj8%2ByCH9GCVV2IFPqfJdlcuq2oGTDhaANE9xyFnnpi%2Bm55D8DFb%2BQi0QTfiMGj1x8ydTsPM2L54ij2iAjpPqysqpzii%2B3SYIz7Y3ht%2BDByV3LEpSKY0bNBOEOzHyJqxgfVxuFl3PEwqyxTJmioUwLBUlhS/RIOteO%2B/1iFUo%2BavdwQU%3D) | |
20 … | + | |
21 … | + | |
19 | 22 … | Entropy is built with an experimental but simple DAO structure designed to balance a real world project with the benefits of crowd wisdom and blockchain transparency. |
20 | 23 … | |
21 | -### Community | |
22 | -**Citizens** hold the following rights: | |
24 … | +### Community :house_with_garden: | |
25 … | +**Citizens** :two_men_holding_hands: hold the following rights: | |
23 | 26 … | |
24 | -- A single vote on every created **Action** | |
25 | -- Creating **Actions** | |
26 | -- **Guardian** nomination | |
27 … | +- A single **Vote** :hand: on every created **Action** :bulb: | |
28 … | +- Creating **Actions** :bulb: | |
29 … | +- **Guardian** :guardsman: nomination | |
27 | 30 … | |
28 | -Anyone can become a **Citizen** by obtaining one or more **Entropy Tokens**. | |
31 … | +Anyone can become a **Citizen** :running: by obtaining one or more **Entropy Tokens** :cookie: | |
29 | 32 … | |
30 | -**Citizens** hold equal voting rights to everyone in the Entropy Community, they are able to suggest any **Action** for discussion and vote. These **Actions** can be anything at all, from destinations to sail to, events, changes to the mission itself and changes to the **Guardians**. | |
33 … | +**Citizens** :two_women_holding_hands: hold equal voting rights to everyone in the Entropy Community, they are able to suggest any **Action** :bulb: for discussion and vote. These **Actions** :bulb: can be anything at all, from destinations to sail to, events, changes to the mission itself and changes to the **Guardians** :guardsman: | |
31 | 34 … | |
32 | 35 … | |
33 | -A **Citizen** is anyone who holds one or more **Entropy Tokens**. Anyone with an Ethereum address can hold **Entropy Tokens**. | |
36 … | +A **Citizen** :running: is anyone who holds one or more **Entropy Tokens** :cookie: Anyone with an Ethereum address can hold **Entropy Tokens** :cookie: | |
34 | 37 … | |
35 | 38 … | |
36 | -### Guardians | |
37 | -Any **Citizen** can be elected to be a **Guardian** by an accepted **Action**. | |
39 … | +### Guardians :guardsman: | |
40 … | +Any **Citizen** :running: can be elected to be a **Guardian** :guardsman: by an accepted **Action** :bulb: | |
38 | 41 … | |
39 | 42 … | |
40 | -**Guardians** take on the responsibility to fulfil and document everything within the **Action Stream** as organised by and voted on by the wider community. | |
43 … | +**Guardians** :guardsman: take on the responsibility to fulfil and document everything within the **Action Stream** :clipboard: as organised by and voted on by the wider community. | |
41 | 44 … | |
42 | 45 … | |
43 | -**Guardians** have, in addition to the rights of all **Citizens** , access to any shared funds moved to the **Slush Pool** by the community voting as a whole. | |
46 … | +**Guardians** :guardsman: have, in addition to the rights of all **Citizens** :running:, access to any shared funds moved to the **Slush Pool** :moneybag: by the community voting as a whole. | |
44 | 47 … | |
45 | 48 … | |
46 | -### Actions and Funds | |
47 | -Any **Citizen** can propose a new **Action**. | |
49 … | +### Actions and Funds :bulb: :moneybag: | |
50 … | +Any **Citizen** :running: can propose a new **Action** :bulb: | |
48 | 51 … | |
49 | -All **Actions** can be voted on by the entire community for 5 days. | |
52 … | +All **Actions** :bulb: can be voted :hand: on by the entire community for 5 days. | |
50 | 53 … | |
51 | -For an **Action** to be accepted, it must have *more than 50% approval* and at least as many votes as there are **Guardian** members (although voting is open to all **Citizens**). | |
54 … | +For an **Action** :bulb: to be accepted, it must have *more than 50% approval* and at least as many votes :hand: as there are **Guardian** :guardsman: members (although voting is open to all **Citizens** :family:). | |
52 | 55 … | |
53 | -After this period accepted **Actions** will be added to the **Action Stream** until they are marked as complete by one of the **Guardians**. | |
56 … | +After this period accepted **Actions** :bolb: will be added to the **Action Stream** :clipboard: until they are marked as complete by one of the **Guardians** :guardsman: | |
54 | 57 … | |
55 | -Declined **Actions** will be dismissed to the **Archive**. | |
58 … | +Declined **Actions** :bulb: will be dismissed to the **Archive** :recycle: | |
56 | 59 … | |
57 | -The **Action Stream** represents what the community is currently aiming to achieve. | |
60 … | +The **Action Stream** :clipboard: represents what the community is currently aiming to achieve. | |
58 | 61 … | |
59 | -Any funds associated with **Actions** in the **Action Stream** become available in the **Slush Pool** for the **Guardians** to use towards making those **Actions** happen. | |
62 … | +Any funds associated with **Actions** :bulb: in the **Action Stream** :clipboard: become available in the **Slush Pool** :moneybag: for the **Guardians** :guardsman: to use towards making those **Actions** :bulb: happen. | |
60 | 63 … | |
64 … | +:rainbow: :sailboat: :fireworks: | |
61 | 65 … | |
62 | 66 … | ## Development |
63 | 67 … | |
64 | 68 … | The recommended workflow for developing and contributing to the contracts is using the `truffle console` for compiling, deploying and playing with contracts. In order to do that, just: |
Built with git-ssb-web