DEVELOPMENT.md · bridge

git.iko.soy/bridge

bridge/DEVELOPMENT.md

99 lines 3.6 kB history raw

1# Development notes

3## Install / Build

5Clone the repo, and use a simple `npm install`. You can then use a `npm run build` to create an optimised static build (serve it with e.g. [serve](http://npmjs.com/package/serve), or with python as described above).

7## General notes

9For development, use `npm run pilot` to get going after a `npm install`. This

10will boot up a [Ganache](https://github.com/trufflesuite/ganache-cli) node in the background, deploy the Azimuth contracts to

11it, and fire up a local webserver. Bridge will be served on `localhost:3000`.

13Note that one of our dependencies itself depends on a library called

14`handle-thing` which breaks under the Ledger support requirements (see below)

15on node 11.1.0, so make sure you're using some other node version.

17You can use [nvm](https://github.com/creationix/nvm), for example, and do:

19```

20$ nvm install 11.0.0

21$ nvm use v11.0.0

22```

24before running `npm run pilot`.

26## Useful accounts

28The ecliptic owner is the only account that's able to create galaxies, so

29it's a good place to get started. On the testnet, it's the address:

31```

320x6DEfFb0caFDB11D175F123F6891AA64F01c24F7d

33```

35You can authenticate as it using the following mnemonic:

37```

38benefit crew supreme gesture quantum web media hazard theory mercy wing kitten

39```

41Under that mnemonic, Ganache will also auto-populate the following accounts

42with 100 ETH:

44```

450x6deffb0cafdb11d175f123f6891aa64f01c24f7d

460xd53208cf45fc9bd7938b200bff8814a26146688f

470x7b2a2d51e4d8fac602e20a5f6907ff9fbd88e1fd

480xf48062ae8bafd6ef19cd6cb89db93a0d0ca6ce26

490xf84a77aeb351c49dfa87e805a659d2daddff7606

500x167e357cf8b845370d0d408f9b389b66185b7b5b

510xcbecf3abc9878f07afc851aead2d8f1c436cc71d

520x0afc0c3f4eeea500871f464ca71eef5e54a9af36

530x6d654ef2489674d21aed428e8a4ad8ca4820f125

540x218f6f87683db546ad47a5dc8b480e5a9b694866

55```

57To play around with any of these, authenticate using the same mnemonic, but

58use a custom HD path of `m/44'/60'/0'/0/1`, `m/44'/60'/0'/0/2`, and so on.

60## Initial development state

62You can also tweak a couple of things to change your development state

63somewhat (say, for example, you want to start on the points list screen, instead

64of having to re-authenticate whenever you make a change or refresh the page):

66- The `.env.development` file contains environment variables that you can

67 provide to the application when it's running in development. You can access

68 them via `process.env.REACT_APP_<whatever>`.

70- Set `REACT_APP_STUB_LOCAL='true'` in `.env.development` to enabled stubbing of

71 certain methods throughout the app.

73- The top of the Bridge component in `src/Bridge.js` can be tweaked for setting

74 your initial state. You can provide a specific wallet,

75 network type, and so on.

77## HTTPS

79For development, you can enable HTTPS on localhost without a certificate for

80Chrome by pasting the following into the URL bar:

82```

83chrome://flags/#allow-insecure-localhost

84```

86In Firefox, you may need to allow connecting to the unsecured local node

87websocket. Do this by going to `about:config` and setting the

88`network.websocket.allowInsecureFromHTTPS` flag to `true`.

90Additionally you need to run with the `HTTPS` environment variable set to

91`true`. Note that `npm run pilot` will handle this automatically.

93## Releases

95To generate a release `bridge-$VERSION.zip` file, use a simple `npm run release`.

97This will pack the build directory together with the README, `bridge-https.py`

98script, and also generate a set of checksums for the build directory. You can

99verify the checksums on e.g. MacOS via `shasum -c checksums.txt`.