Skip to content

Commit a2818cb

Browse files
streamerdstreamerd
committed
add existing md files
1 parent f1d83c4 commit a2818cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1437
-0
lines changed

‎.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nodejs 14.15.0

‎docs/Rollup/Contracts.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# **Contracts v1** 📋
2+
3+
#### **MultiCallHelper**
4+
https://etherscan.io/address/0xBBb3d2Ea97D2859eA391aBEb691DfD23192B1ded
5+
6+
#### **ExecutionProxy**
7+
https://etherscan.io/address/0x32bbDEf16B4e0404191a8B879956280539036DEA
8+
9+
#### **HabitatV1**
10+
**v1.0.1**
11+
https://etherscan.io/address/0x1ee6fda8ce6c4e32e48005e98d9ccdc2f2b4f346/advanced
12+
13+
**v1.0.0**
14+
https://etherscan.io/address/0x1F2878d778F7619Aa786EbbaE6cf66C56632399c
15+
16+
#### **RollupProxy**
17+
https://etherscan.io/address/0x96E471B5945373dE238963B4E032D3574be4d195
18+
19+
## **🗳️ Voting Modules**
20+
#### **OneThirdParticipationThreshold**
21+
https://etherscan.io/address/0xc4Fe1867099F1fB6a15491d7E2AF2280E35C0105
22+
23+
#### **SevenDayVoting**
24+
https://etherscan.io/address/0x4de7f3c0aD9EF9E8dDa5A7D19378C11B16d655af
25+
26+
#### **FeatureFarmSignaling**
27+
https://etherscan.io/address/0x63818D74A71DC141b605204cf83FE51EE7267612

‎docs/Rollup/Deposit.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# **Enter the Habitat Rollup** 🛬
2+
3+
#### **Deposit**
4+
Choose the option "Deposit" from the dropdown menu and select the token you want to deposit. Start with HBT to top-up the Gas Tank.
5+
6+
![img](/deposit.png)

‎docs/Rollup/Epochs.md

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# **Habitat Epoch Reward Pool Addresses**
2+
3+
You can check the current epoch in your [account page](https://0xhabitat.org/app/#habitat-account) under "Rollup Rewards".
4+
<img src="https://user-images.githubusercontent.com/45236782/133755795-2b40a3e6-fb07-4d33-a971-82ea7776d196.png" alt="drawing" width="600"/>
5+
6+
**Epoch #: address**
7+
8+
- 1: 0x0000000000000000000000000000000000000001
9+
- 2: 0x0000000000000000000000000000000000000002
10+
- 3: 0x0000000000000000000000000000000000000003
11+
- 4: 0x0000000000000000000000000000000000000004
12+
- 5: 0x0000000000000000000000000000000000000005
13+
- 6: 0x0000000000000000000000000000000000000006
14+
- 7: 0x0000000000000000000000000000000000000007
15+
- 8: 0x0000000000000000000000000000000000000008
16+
- 9: 0x0000000000000000000000000000000000000009
17+
- 10: 0x000000000000000000000000000000000000000a
18+
- 11: 0x000000000000000000000000000000000000000b
19+
- 12: 0x000000000000000000000000000000000000000c
20+
- 13: 0x000000000000000000000000000000000000000d
21+
- 14: 0x000000000000000000000000000000000000000e
22+
- 15: 0x000000000000000000000000000000000000000f
23+
- 16: 0x0000000000000000000000000000000000000010
24+
- 17: 0x0000000000000000000000000000000000000011
25+
- 18: 0x0000000000000000000000000000000000000012
26+
- 19: 0x0000000000000000000000000000000000000013
27+
- 20: 0x0000000000000000000000000000000000000014
28+
- 21: 0x0000000000000000000000000000000000000015
29+
- 22: 0x0000000000000000000000000000000000000016
30+
- 23: 0x0000000000000000000000000000000000000017
31+
- 24: 0x0000000000000000000000000000000000000018
32+
- 25: 0x0000000000000000000000000000000000000019
33+
- 26: 0x000000000000000000000000000000000000001a
34+
- 27: 0x000000000000000000000000000000000000001b
35+
- 28: 0x000000000000000000000000000000000000001c
36+
- 29: 0x000000000000000000000000000000000000001d
37+
- 30: 0x000000000000000000000000000000000000001e
38+
- 31: 0x000000000000000000000000000000000000001f
39+
- 32: 0x0000000000000000000000000000000000000020
40+
- 33: 0x0000000000000000000000000000000000000021
41+
- 34: 0x0000000000000000000000000000000000000022
42+
- 35: 0x0000000000000000000000000000000000000023
43+
- 36: 0x0000000000000000000000000000000000000024
44+
- 37: 0x0000000000000000000000000000000000000025
45+
- 38: 0x0000000000000000000000000000000000000026
46+
- 39: 0x0000000000000000000000000000000000000027
47+
- 40: 0x0000000000000000000000000000000000000028
48+
- 41: 0x0000000000000000000000000000000000000029
49+
- 42: 0x000000000000000000000000000000000000002a
50+
- 43: 0x000000000000000000000000000000000000002b
51+
- 44: 0x000000000000000000000000000000000000002c
52+
- 45: 0x000000000000000000000000000000000000002d
53+
- 46: 0x000000000000000000000000000000000000002e
54+
- 47: 0x000000000000000000000000000000000000002f
55+
- 48: 0x0000000000000000000000000000000000000030
56+
- 49: 0x0000000000000000000000000000000000000031
57+
- 50: 0x0000000000000000000000000000000000000032
58+
- 51: 0x0000000000000000000000000000000000000033
59+
- 52: 0x0000000000000000000000000000000000000034
60+
- 53: 0x0000000000000000000000000000000000000035
61+
- 54: 0x0000000000000000000000000000000000000036
62+
- 55: 0x0000000000000000000000000000000000000037
63+
- 56: 0x0000000000000000000000000000000000000038
64+
- 57: 0x0000000000000000000000000000000000000039
65+
- 58: 0x000000000000000000000000000000000000003a
66+
- 59: 0x000000000000000000000000000000000000003b
67+
- 60: 0x000000000000000000000000000000000000003c
68+
- 61: 0x000000000000000000000000000000000000003d
69+
- 62: 0x000000000000000000000000000000000000003e
70+
- 63: 0x000000000000000000000000000000000000003f
71+
- 64: 0x0000000000000000000000000000000000000040
72+
- 65: 0x0000000000000000000000000000000000000041
73+
- 66: 0x0000000000000000000000000000000000000042
74+
- 67: 0x0000000000000000000000000000000000000043
75+
- 68: 0x0000000000000000000000000000000000000044
76+
- 69: 0x0000000000000000000000000000000000000045
77+
- 70: 0x0000000000000000000000000000000000000046
78+
- 71: 0x0000000000000000000000000000000000000047
79+
- 72: 0x0000000000000000000000000000000000000048
80+
- 73: 0x0000000000000000000000000000000000000049
81+
- 74: 0x000000000000000000000000000000000000004a
82+
- 75: 0x000000000000000000000000000000000000004b
83+
- 76: 0x000000000000000000000000000000000000004c
84+
- 77: 0x000000000000000000000000000000000000004d
85+
- 78: 0x000000000000000000000000000000000000004e
86+
- 79: 0x000000000000000000000000000000000000004f
87+
- 80: 0x0000000000000000000000000000000000000050
88+
- 81: 0x0000000000000000000000000000000000000051
89+
- 82: 0x0000000000000000000000000000000000000052
90+
- 83: 0x0000000000000000000000000000000000000053
91+
- 84: 0x0000000000000000000000000000000000000054
92+
- 85: 0x0000000000000000000000000000000000000055
93+
- 86: 0x0000000000000000000000000000000000000056
94+
- 87: 0x0000000000000000000000000000000000000057
95+
- 88: 0x0000000000000000000000000000000000000058
96+
- 89: 0x0000000000000000000000000000000000000059
97+
- 90: 0x000000000000000000000000000000000000005a
98+
- 91: 0x000000000000000000000000000000000000005b
99+
- 92: 0x000000000000000000000000000000000000005c
100+
- 93: 0x000000000000000000000000000000000000005d
101+
- 94: 0x000000000000000000000000000000000000005e
102+
- 95: 0x000000000000000000000000000000000000005f
103+
- 96: 0x0000000000000000000000000000000000000060
104+
- 97: 0x0000000000000000000000000000000000000061
105+
- 98: 0x0000000000000000000000000000000000000062
106+
- 99: 0x0000000000000000000000000000000000000063
107+
- 100: 0x0000000000000000000000000000000000000064
108+
- 101: 0x0000000000000000000000000000000000000065
109+
- 102: 0x0000000000000000000000000000000000000066
110+
- 103: 0x0000000000000000000000000000000000000067
111+
- 104: 0x0000000000000000000000000000000000000068
112+
- 105: 0x0000000000000000000000000000000000000069
113+
- 106: 0x000000000000000000000000000000000000006a
114+
- 107: 0x000000000000000000000000000000000000006b
115+
- 108: 0x000000000000000000000000000000000000006c
116+
- 109: 0x000000000000000000000000000000000000006d
117+
- 110: 0x000000000000000000000000000000000000006e
118+
- 111: 0x000000000000000000000000000000000000006f
119+
- 112: 0x0000000000000000000000000000000000000070
120+
- 113: 0x0000000000000000000000000000000000000071
121+
- 114: 0x0000000000000000000000000000000000000072
122+
- 115: 0x0000000000000000000000000000000000000073
123+
- 116: 0x0000000000000000000000000000000000000074
124+
- 117: 0x0000000000000000000000000000000000000075
125+
- 118: 0x0000000000000000000000000000000000000076
126+
- 119: 0x0000000000000000000000000000000000000077
127+
- 120: 0x0000000000000000000000000000000000000078
128+
- 121: 0x0000000000000000000000000000000000000079
129+
- 122: 0x000000000000000000000000000000000000007a
130+
- 123: 0x000000000000000000000000000000000000007b
131+
- 124: 0x000000000000000000000000000000000000007c
132+
- 125: 0x000000000000000000000000000000000000007d
133+
- 126: 0x000000000000000000000000000000000000007e
134+
- 127: 0x000000000000000000000000000000000000007f
135+
- 128: 0x0000000000000000000000000000000000000080
136+
- 129: 0x0000000000000000000000000000000000000081
137+
- 130: 0x0000000000000000000000000000000000000082
138+
- 131: 0x0000000000000000000000000000000000000083
139+
- 132: 0x0000000000000000000000000000000000000084
140+
- 133: 0x0000000000000000000000000000000000000085
141+
- 134: 0x0000000000000000000000000000000000000086
142+
- 135: 0x0000000000000000000000000000000000000087
143+
- 136: 0x0000000000000000000000000000000000000088
144+
- 137: 0x0000000000000000000000000000000000000089
145+
- 138: 0x000000000000000000000000000000000000008a
146+
- 139: 0x000000000000000000000000000000000000008b
147+
- 140: 0x000000000000000000000000000000000000008c
148+
- 141: 0x000000000000000000000000000000000000008d
149+
- 142: 0x000000000000000000000000000000000000008e
150+
- 143: 0x000000000000000000000000000000000000008f
151+
- 144: 0x0000000000000000000000000000000000000090
152+
- 145: 0x0000000000000000000000000000000000000091
153+
- 146: 0x0000000000000000000000000000000000000092
154+
- 147: 0x0000000000000000000000000000000000000093
155+
- 148: 0x0000000000000000000000000000000000000094
156+
- 149: 0x0000000000000000000000000000000000000095
157+
- 150: 0x0000000000000000000000000000000000000096
158+
- 151: 0x0000000000000000000000000000000000000097
159+
- 152: 0x0000000000000000000000000000000000000098
160+
- 153: 0x0000000000000000000000000000000000000099
161+
- 154: 0x000000000000000000000000000000000000009a
162+
- 155: 0x000000000000000000000000000000000000009b
163+
- 156: 0x000000000000000000000000000000000000009c
164+
- 157: 0x000000000000000000000000000000000000009d
165+
- 158: 0x000000000000000000000000000000000000009e
166+
- 159: 0x000000000000000000000000000000000000009f
167+
- 160: 0x00000000000000000000000000000000000000a0
168+
- 161: 0x00000000000000000000000000000000000000a1
169+
- 162: 0x00000000000000000000000000000000000000a2
170+
- 163: 0x00000000000000000000000000000000000000a3
171+
- 164: 0x00000000000000000000000000000000000000a4
172+
- 165: 0x00000000000000000000000000000000000000a5
173+
- 166: 0x00000000000000000000000000000000000000a6
174+
- 167: 0x00000000000000000000000000000000000000a7
175+
- 168: 0x00000000000000000000000000000000000000a8
176+
- 169: 0x00000000000000000000000000000000000000a9
177+
- 170: 0x00000000000000000000000000000000000000aa
178+
- 171: 0x00000000000000000000000000000000000000ab
179+
- 172: 0x00000000000000000000000000000000000000ac
180+
- 173: 0x00000000000000000000000000000000000000ad
181+
- 174: 0x00000000000000000000000000000000000000ae
182+
- 175: 0x00000000000000000000000000000000000000af
183+
- 176: 0x00000000000000000000000000000000000000b0
184+
- 177: 0x00000000000000000000000000000000000000b1
185+
- 178: 0x00000000000000000000000000000000000000b2
186+
- 179: 0x00000000000000000000000000000000000000b3
187+
- 180: 0x00000000000000000000000000000000000000b4
188+
- 181: 0x00000000000000000000000000000000000000b5
189+
- 182: 0x00000000000000000000000000000000000000b6
190+
- 183: 0x00000000000000000000000000000000000000b7
191+
- 184: 0x00000000000000000000000000000000000000b8
192+
- 185: 0x00000000000000000000000000000000000000b9
193+
- 186: 0x00000000000000000000000000000000000000ba
194+
- 187: 0x00000000000000000000000000000000000000bb
195+
- 188: 0x00000000000000000000000000000000000000bc
196+
- 189: 0x00000000000000000000000000000000000000bd
197+
- 190: 0x00000000000000000000000000000000000000be
198+
- 191: 0x00000000000000000000000000000000000000bf
199+
- 192: 0x00000000000000000000000000000000000000c0
200+
- 193: 0x00000000000000000000000000000000000000c1
201+
- 194: 0x00000000000000000000000000000000000000c2
202+
- 195: 0x00000000000000000000000000000000000000c3
203+
- 196: 0x00000000000000000000000000000000000000c4
204+
- 197: 0x00000000000000000000000000000000000000c5
205+
- 198: 0x00000000000000000000000000000000000000c6
206+
- 199: 0x00000000000000000000000000000000000000c7
207+
- 200: 0x00000000000000000000000000000000000000c8
208+

‎docs/Rollup/Exit.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# **Leave the Habitat Rollup** 🛫
2+
3+
#### **Request Withdrawal**
4+
Users can request to leave the rollup when choosing the option "Withdraw":
5+
6+
![img](/withdraw.png)
7+
8+
> Withdrawals are requested for each token individually.
9+
10+
#### **Please Remember:**
11+
When leaving the rollup, some necessary security measures are taken. Withdrawals are subject to a 7 day inspection period before users can exit.
12+
13+
A minimum of 7 days is recommended at the moment, so anyone can challenge the recorded history of transactions on the rollup and dispute the outcomes if necessary. In case of disputes, up to 3 weeks apply for full resolution of the challenge.
14+
15+
![img](/pending.png)
16+
17+
#### **Perform the Exit**
18+
Once the 7 days passed, the user can exit the funds to Ethereum Mainnet:
19+
20+
![img](/exit.png)

‎docs/Rollup/GasTank.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# **Gas Tank** ⛽
2+
To secure the network and all the user and community funds the Habitat rollup needs Gas to operate. Like a pre-paid phone the user tops up its balance to interact with all features, modules and functionalities. A 1% top-up fee is taken and distributed among all HBT stakers/deposits.
3+
4+
> Rollup Balance and Gas Balance are two different components/metrics.
5+
6+
![img](/gastank.png)
7+
8+
After depositing HBT on the rollup, users need to deposit a small amount of HBT into the “Gas Tank”. This extra balance is responsible to pay the gas cost for users in HBT. Currently 1 HBT pays ≈ 10 transactions.
9+
10+
![img](/topup.png)
11+
12+
#### **Please Remember:**
13+
**The Gas Tank Balance is a tribute/payment to the Operator, you can't withdraw the deposited funds once they are on your balance, please top-up carefully!**

‎docs/Rollup/Transfer.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# **Transfer** 📡
2+
3+
When Users choose the option "Transfer", they cans end funds across the rollup to other users, communities or vaults.
4+
5+
1. Choose "Transfer" in dropdown menu
6+
2. Select the token you want to transfer
7+
3. Enter the address or username in the input field "To"
8+
9+
![img](/transfer.png)

‎docs/Rollup/Yield.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# **Rollup Yield** ✨
2+
![img](/yield.png)
3+
4+
The Habitat rollup is generating profits based on the **activity and usage of the network**. These profits are fairly distributed among all users and their individual amount of deposited HBT tokens on the rollup.
5+
6+
The exact yield is depending on the fees earned during one epoch. An epoch is **7 days long**. When you withdraw HBT before the epoch ends you won’t get any yield!
7+
8+
You can claim when visiting the Account Page and checking the tab: **"Rewards"**

‎docs/Rollup/meta.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"Epochs": "Reward Pool Addresses",
3+
"GasTank": "Gas Tank"
4+
}

0 commit comments

Comments
 (0)