User_Guide.md
1 1. User Guide 2 3 <!-- end list --> 4 5 1. 1. Setting It All Up 6 7 Special thanks to 8 \[@cryptowanderer\](https://twitter.com/cryptowanderer) for contributing 9 this fantastic guide\! 10 11 Welcome to Status\! This is Ethereum, anywhere. Ethereum everywhere. A 12 world computer in your pocket. It is so many cool and amazing things 13 that is difficult to know where to start. Being entirely too overwhelmed 14 with the awesomeness that is an Ethereum light client running on your 15 mobile phone, I suppose we’ll just begin at the beginning. 16 17 Once you have downloaded the app, installed it and opened it, it should 18 take you into a chat with Console: a dApp that lives inside status and 19 lets you set up your account and control all the important stuff (as 20 well as a bunch of other rad features, which we will get to in good 21 time). 22 23 <center> 24 25 <img src="../img/image_0.png" style="width:300px;" /> 26 27 </center> 28 29 As you can see, I have already been chatting a fair bit with Console 30 (friends, yay\!\!). The UI concept here is that when someone sends an 31 action message requesting (in this case) a password, or money, or a 32 confirmation code etc., you can tap the blue block and it will insert 33 the appropriate syntax to respond to that request, followed by your 34 input. 35 36 One other thing to note is the ‘Available’ beneath ‘Console’ in the top 37 left. This means that my phone has synced with the ropsten testnet 38 (unbelievable right?\!). I am running android 7.0 and am doing so over 39 wifi. It took just under 40mins for me to sync, though there are varying 40 reports coming in to our slack depending on phone, OS and network 41 differences. Still, ~40min sync time on a mobile is just insane. Thanks 42 Zsolt for the amazing 43 \[LES\](https://github.com/ethcore/parity/wiki/Light-Ethereum-Subprotocol-(LES))\! 44 45 <center> 46 47 <img src="../img/image_1.jpg" style="width:300px;" /> 48 49 </center> 50 51 You can see that you can optionally give your phone number to help 52 status sync with your existing contacts. This is not mandatory and the 53 app will work fine without it. If you do provide it, please make sure to 54 give your country code (so +27… for me) so that status can send you the 55 confirmation message. Note that if you run into any issues, you can just 56 shake your phone and this should bring up a screen that allows you to 57 submit an error report directly to the status team. You can select from 58 the options what you want to do, but generally it seems best to \`Report 59 a 60 Problem\`: 61 62 <center> 63 64 <img src="../img/image_2.png" style="width:300px;" /><img src="../img/image_3.png" style="width:300px;" /> 65 66 </center> 67 68 You should be able to select a colour to indicate the severity of the 69 issue on the second screen above. I really want to make sure that 70 Jarrad, Carl and the crew are on their toes, so I have gone for red 71 here. Hitting the forward button (top right) should take you to where 72 the magic really happens: 73 74 <center> 75 76 <img src="../img/image_4.png" style="width:300px;" /> 77 78 </center> 79 80 Please note the \`Take a screen recording\` button in the bottom left. 81 This is how the team prefers you to submit bug reports as it is 82 enormously helpful with seeing exactly what went wrong and so providing 83 insight into where to go to fix the issue. You can enter your email, 84 take a video and go ahead and submit. At which point we issue you a 85 massive thank you for being such a stellar alpha tester. Go you\! 86 87 1. 1. Actually Using the App 88 89 OK, now that we have the setup out the way, we can get into the really 90 fun stuff. Once you have generated your account with Console, you can 91 open both the ropsten testnet faucet and the status test faucet to get 92 some shweet test ether into your account so that you can go out and 93 convince actual people to be your friends too. Please do not open an 94 issue if this doesn’t happen - we can’t convince people to like you 95 (even if you do use the best tech around). 96 97 To open both faucets, tap the hamburger menu with the blue dot to the 98 left of the chat 99 box: 100 101 <center> 102 103 <img src="../img/image_5.png" style="width:300px;" /><img src="../img/image_6.png" style="width:300px;" /><img src="../img/image_7.png" style="width:300px;" /> 104 105 </center> 106 107 In words, we tap the menu on the left, scroll down and select the faucet 108 option and then select which testnet we want to get ether from. Repeat 109 this twice to open both faucets and you should get a bit more ether a 110 bit more quickly. Don’t worry about the web3 stuff in the first 111 screenshot - we’ll get to that (who said you can’t build suspense in a 112 technical user guide?). 113 114 Seeing as we’re now finished chatting to Console for the moment, we can 115 hit the back button and this will take us into the Chats page: 116 117 <center> 118 119 <img src="../img/image_8.png" style="width:300px;" /> 120 121 </center> 122 123 Here you can see all the lovely people that you have been chatting to. 124 It’s really straightforward and intuitive, so behave as you normally 125 would in WhatsApp or WeChat etc. Tapping a conversation will take you 126 into it, and you can use the bottom three tabs to navigate through the 127 Chats, Discover and Contacts screen. You can also just swipe right. Just 128 do you. 129 130 There is another important dApp that lives here as well - your wallet. 131 Selecting it should take you to a screen like 132 this: 133 134 <center> 135 136 <img src="../img/image_9.png" style="width:300px;" /><img src="../img/image_10.png" style="width:300px;" /> 137 138 </center> 139 140 The main screen opens what is essentially an in-app browser that will 141 show your main balance. You can scroll that screen down using the small 142 down arrow at the top in the centre to see the actual transactions in a 143 chat-like interface. As you can see, I am super rich - absolutely 144 rolling in that test ether - and have sent some to Jarrad as mad props 145 for building the app, and received some from Roland as a little test. 146 147 If you navigate back out of the wallet chat and swipe right, or select 148 the Discover tab at the bottom, you will get to the Discover page: 149 150 <center> 151 152 <img src="../img/image_11.png" style="width:300px;" /> 153 154 </center> 155 156 Here you can see hashtags people are using and discover all the 157 different conversations going on. Swipe right through the cards to see 158 the most popular categories, or scroll down to see the most recent 159 updates. If you want to make a message of your own appear here, you need 160 to open your profile page and edit your status with the hashtag you want 161 to see appear here. Start a meme or hop onto an existing one - it’s all 162 up to you. You can get to your profile page by tapping the little 163 hamburger menu in the very top left of the app: 164 165 <center> 166 167 <img src="../img/image_12.png" style="width:300px;" /> 168 169 </center> 170 171 Don’t stress about the \`Settings\` tab - that will be functional in a 172 later release. Your profile page should look like the below. To edit it, 173 hit the three dots in the top 174 right: 175 176 <center> 177 178 <img src="../img/image_13.jpg" style="width:300px;" /><img src="../img/image_14.jpg" style="width:300px;" /> 179 180 </center> 181 182 Tap next to your name to edit that, tap your status to edit that and hit 183 the pencil icon by the picture to upload your own. Remember to include 184 that hashtag if you want it to appear on the Discover page. 185 186 Once that is all done and you’ve broadcast a status for all the world to 187 see, swipe right once more (or use the tabs for navigation) and you will 188 get to the Contacts page. Here you will see the dApps that are currently 189 living in status as well as all the wonderful people you have connected 190 with: 191 192 <center> 193 194 <img src="../img/image_15.png" style="width:300px;" /> 195 196 </center> 197 198 These dApps all work in essentially the same way as the wallet - you can 199 open a chat with them, which will direct you to an in app browser that 200 displays whatever is appropriate for that app. There is a small down 201 arrow at the top which you can scroll down to see any transactions that 202 have occurred between you and the dApp. Directly from within status - 203 signed, sealed and delivered, it all just works. Mind-boggling, I 204 know. 205 206 <center> 207 208 <img src="../img/image_16.png" style="width:300px;" /><img src="../img/image_17.png" style="width:300px;" /> 209 210 </center> 211 212 If you close your app or otherwise have an issue, when you reopen it, 213 you should be directed to a screen which looks like the below. Select 214 the account that belongs to you (in the case where you set up more than 215 one) and then put in the appropriate password and you should get back to 216 the chat 217 screen: 218 219 <center> 220 221 <img src="../img/image_18.png" style="width:300px;" /><img src="../img/image_19.png" style="width:300px;" /> 222 223 </center> 224 225 If that doesn’t work for you or your account doesn’t appear like mine, 226 hit the \`Recover access\` button at the bottom of the first screen and 227 follow the prompts to input the 12 word passphrase console gave you when 228 you first set stuff up and your password. 229 230 Happy sailing\! 231 232 1. 1. For the Adventurous 233 234 We’ve covered all the basic functionality as it stands, but there is so 235 much more that you can do with status. Most of this stuff will only 236 become available in the beta release or after, but developers around the 237 world should be getting really excited to start building dApps to live 238 alongside Flight Delays and Maker etc. 239 240 Though it is by no means complete yet, you can do a lot more than just 241 set you account up using Console - it is, after all, a full dApp of its 242 own. Go back to that chat and type \`web3.\` (the fullstop is important) 243 and 244 \`web3.eth.\`: 245 246 <center> 247 248 <img src="../img/image_20.png" style="width:300px;" /><img src="../img/image_21.png" style="width:300px;" /> 249 250 </center> 251 252 You should be able to see a whole bunch of suggestions for the sorts of 253 things you can do directly from Console, the most basic of which is 254 \`web3.eth.blockNumber\` which will return the current block number on 255 the ropsten testnet. If this doesn’t blow your mind, I’m not sure what 256 will. There are, as I said, still improvements to be made here regarding 257 technical things like retaining state between messages, but it will get 258 there. 259 260 If you want to dive in even further and help develop the app, contribute 261 some code or otherwise get involved in the technical side of things, 262 here are the links you need: 263 264 How to build it: 265 [1](https://wiki.status.im/contributing/development/building-status/)(https://wiki.status.im/contributing/development/building-status/) 266 267 The latest nightlies: 268 [2](http://artifacts.status.im:8081/artifactory/nightlies-local/)(http://artifacts.status.im:8081/artifactory/nightlies-local/) 269 270 If you would like to help us with how to build for Linux and Windows, 271 please do feel free - that would be really awesome to get everyone up to 272 the same speed. 273 274 ''' All images for this guide can be found here 275 <https://github.com/status-im/wiki.status.im/tree/master/docs/contributing/img> 276 '''