git.iko.soy/bridge
on bc552c8 help sign in
bridge/README.md
152 lines 5.6 kB history raw
1# Bridge
3[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
5An application for interacting with Azimuth.
7## Usage
9### Requirements
11Python 3.7.2
13### Instructions
15#### Install
171. [Download a release](https://github.com/urbit/bridge/releases)
182. Unzip it (`bridge-$version.zip`)
193. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)
204. `cd` into the `bridge-$version` directory
22Follow the instructions below to run Bridge.
24#### Run Bridge
26If you plan to authenticate and sign transactions with a Master Ticket, BIP39 mnemonic, Ethereum private key, or keystore file:
281. `cd` into the `bridge-$version` directory
292. Run `python3 -m http.server 5000 --bind 127.0.0.1`
303. Navigate to http://localhost:5000 using a web browser to access Bridge (we recommend using Firefox or Chrome)
32#### Run Bridge with Ledger support
34If you plan to authenticate and sign transactions with a [Ledger](https://www.ledger.com/), Bridge must be serving over HTTPS on localhost. This requires self-signed certificates. To do this:
361. Install [mkcert](https://github.com/FiloSottile/mkcert)
372. If you're using Firefox, additionally install [nss](https://github.com/nss-dev/nss)
383. Install a local certificate authority via `mkcert -install`
394. From the `bridge-$version` directory, run `mkcert localhost` to generate a certificate valid for localhost. This will produce two files: `localhost.pem`, the local certificate, and `localhost-key.pem`, its corresponding private key
405. Run `python bridge-https.py`
416. Navigate to https://localhost:4443 in a web browser to access Bridge
43### Verify checksums
45To validate your downloaded file's integrity, compare the lines in checksum.txt to SHA-256 hashes of the `bridge-$version` directory's contents.
47- On MacOS: `shasum -a 256 -c checksums.txt .`
48- On Linux: `sha256sum -c checksums.txt .`
49- On Windows: Go into the `build` directory and verify files individually with `CertUtil -hashFile [file_name] SHA256`
51## Development notes
53### Install / Build
55Clone 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][serv]).
57### General notes
59For development, use `npm run pilot` to get going after a `npm install`. This
60will boot up a Ganache node in the background, deploy the Azimuth contracts to
61it, and fire up a local webserver. Bridge will be served on `localhost:3000`.
63Note that one of our dependencies itself depends on a library called
64`handle-thing` which breaks under the Ledger support requirements (see below)
65on node 11.1.0, so make sure you're using some other node version.
67You can use [nvm](https://github.com/creationix/nvm), for example, and do:
69```
70$ nvm install 11.0.0
71$ nvm use v11.0.0
72```
74before running `npm run pilot`.
76### Useful accounts
78The ecliptic owner is the only account that's able to create galaxies, so
79it's a good place to get started. On the testnet, it's the address:
81```
820x6DEfFb0caFDB11D175F123F6891AA64F01c24F7d
83```
85You can authenticate as it using the following mnemonic:
87```
88benefit crew supreme gesture quantum web media hazard theory mercy wing kitten
89```
91Under that mnemonic, Ganache will also auto-populate the following accounts
92with 100 ETH:
94```
950x6deffb0cafdb11d175f123f6891aa64f01c24f7d
960xd53208cf45fc9bd7938b200bff8814a26146688f
970x7b2a2d51e4d8fac602e20a5f6907ff9fbd88e1fd
980xf48062ae8bafd6ef19cd6cb89db93a0d0ca6ce26
990xf84a77aeb351c49dfa87e805a659d2daddff7606
1000x167e357cf8b845370d0d408f9b389b66185b7b5b
1010xcbecf3abc9878f07afc851aead2d8f1c436cc71d
1020x0afc0c3f4eeea500871f464ca71eef5e54a9af36
1030x6d654ef2489674d21aed428e8a4ad8ca4820f125
1040x218f6f87683db546ad47a5dc8b480e5a9b694866
105```
107To play around with any of these, authenticate using the same mnemonic, but
108use a custom HD path of `m/44'/60'/0'/0/1`, `m/44'/60'/0'/0/2`, and so on.
110### Initial development state
112You can also tweak a couple of things to change your development state
113somewhat (say, for example, you want to start on the points list screen, instead
114of having to re-authenticate whenever you make a change or refresh the page):
116- The `.env.development` file contains environment variables that you can
117 provide to the application when it's running in development. You can access
118 them via `process.env.REACT_APP_<whatever>`.
120- Set `REACT_APP_STUB_LOCAL='true'` in `.env.development` to enabled stubbing of
121 certain methods throughout the app.
123- The top of the Bridge component in `src/Bridge.js` can be tweaked for setting
124 your initial state. You can provide a specific wallet,
125 network type, and so on.
127### HTTPS
129For development, you can enable HTTPS on localhost without a certificate for
130Chrome by pasting the following into the URL bar:
132```
133chrome://flags/#allow-insecure-localhost
134```
136In Firefox, you may need to allow connecting to the unsecured local node
137websocket. Do this by going to `about:config` and setting the
138`network.websocket.allowInsecureFromHTTPS` flag to `true`.
140Additionally you need to run with the `HTTPS` environment variable set to
141`true`. Note that `npm run pilot` will handle this automatically.
143### Releases
145To generate a release `bridge-$VERSION.zip` file, use a simple `npm run release`.
147This will pack the build directory together with the README, `bridge-https.py`
148script, and also generate a set of checksums for the build directory. You can
149verify the checksums on e.g. OS X via `shasum -c checksums.txt`.
151[rele]: https://github.com/urbit/bridge/releases/latest
152[serv]: http://npmjs.com/package/serve