git.iko.soy/bridge
on bc6935a help sign in
bridge/README.md
123 lines 4.3 kB history raw
1# Bridge
3An application for interacting with Azimuth.
5## Usage
7To run Bridge, follow the instructions on the [latest release][rele] page.
9## Development Notes
11### Install / Build
13Clone the repo, and use a simple `npm install`. You can then use a `npm run
14build` to create an optimised static build (serve it with e.g. [serve][serv]).
16### General notes
18For development, use `npm run pilot` to get going after a `npm install`. This
19will boot up a Ganache node in the background, deploy the Azimuth contracts to
20it, and fire up a local webserver. Bridge will be served on `localhost:3000`.
22Note that one of our dependencies itself depends on a library called
23`handle-thing` which breaks under the Ledger support requirements (see below)
24on node 11.1.0, so make sure you're using some other node version.
26You can use [nvm](https://github.com/creationix/nvm), for example, and do:
28```
29$ nvm install 11.0.0
30$ nvm use v11.0.0
31```
33before running `npm run pilot`.
35### Ledger support
37To authenticate and sign transactions with a Ledger, Bridge must be serving
38over HTTPS on localhost. This requires self-signed certificates. You can do
39this via the following:
41* Install [mkcert](https://github.com/FiloSottile/mkcert), and [nss](https://github.com/nss-dev/nss) if you're using Firefox
42* Install a local certificate authority via `mkcert -install`
43* In your `bridge` directory, generate a certificate valid for localhost via
44 `mkcert localhost`. This will produce two files: `localhost.pem`, the local
45 certificate, and `localhost-key.pem`, its corresponding private key.
46* Run `python bridge-https.py`
47* Navigate to https://localhost:4443 in a web browser
49### Useful Accounts
51The ecliptic owner is the only account that's able to create galaxies, so
52it's a good place to get started. On the testnet, it's the address:
54```
550x6DEfFb0caFDB11D175F123F6891AA64F01c24F7d
56```
58You can authenticate as it using the following mnemonic:
60```
61benefit crew supreme gesture quantum web media hazard theory mercy wing kitten
62```
64Under that mnemonic, Ganache will also auto-populate the following accounts
65with 100 ETH:
67```
680x6deffb0cafdb11d175f123f6891aa64f01c24f7d
690xd53208cf45fc9bd7938b200bff8814a26146688f
700x7b2a2d51e4d8fac602e20a5f6907ff9fbd88e1fd
710xf48062ae8bafd6ef19cd6cb89db93a0d0ca6ce26
720xf84a77aeb351c49dfa87e805a659d2daddff7606
730x167e357cf8b845370d0d408f9b389b66185b7b5b
740xcbecf3abc9878f07afc851aead2d8f1c436cc71d
750x0afc0c3f4eeea500871f464ca71eef5e54a9af36
760x6d654ef2489674d21aed428e8a4ad8ca4820f125
770x218f6f87683db546ad47a5dc8b480e5a9b694866
78```
80To play around with any of these, authenticate using the same mnemonic, but
81use a custom HD path of `m/44'/60'/0'/0/1`, `m/44'/60'/0'/0/2`, and so on.
83### Initial Development State
85You can also tweak a couple of things to change your development state
86somewhat (say, for example, you want to start on the points list screen, instead
87of having to re-authenticate whenever you make a change or refresh the page):
89* The `.env.development` file contains environment variables that you can
90 provide to the application when it's running in development. You can access
91 them via `process.env.REACT_APP_<whatever>`.
93* The `componentDidMount` method of the Bridge component in `src/Bridge.js`
94 can be tweaked for setting your initial state. You can provide a specific
95 wallet, network type, and so on.
97### HTTPS
99For development, you can enable HTTPS on localhost without a certificate for
100Chrome by pasting the following into the URL bar:
102```
103chrome://flags/#allow-insecure-localhost
104```
106In Firefox, you may need to allow connecting to the unsecured local node
107websocket. Do this by going to `about:config` and setting the
108`network.websocket.allowInsecureFromHTTPS` flag to `true`.
110Additionally you need to run with the `HTTPS` environment variable set to
111`true`. Note that `npm run pilot` will handle this automatically.
113### Releases
115To generate a release `bridge-$VERSION.zip` file, use a simple `npm run
116release`.
118This will pack the build directory together with the README, `bridge-https.py`
119script, and also generate a set of checksums for the build directory. You can
120verify the checksums on e.g. OS X via `shasum -c checksums.txt`.
122[rele]: https://github.com/urbit/bridge/releases/latest
123[serv]: http://npmjs.com/package/serve