git.iko.soy/bridge
on 5cfbbff help sign in
bridge/README.md
149 lines 5.4 kB history raw
1# Bridge
3An application for interacting with Azimuth.
5## Usage
7### Requirements
9Python 3.7.2
11### Instructions
13#### Install
151. [Download a release](https://github.com/urbit/bridge/releases)
162. Unzip it (`bridge-$version.zip`)
173. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)
184. `cd` into the `bridge-$version` directory
20Follow the instructions below to run Bridge.
22#### Run Bridge
24If you plan to authenticate and sign transactions with a Master Ticket, BIP39 mnemonic, Ethereum private key, or keystore file:
261. `cd` into the `bridge-$version` directory
272. Run `python3 -m http.server 5000 --bind 127.0.0.1`
283. Navigate to http://localhost:5000 using a web browser to access Bridge (we recommend using Firefox or Chrome)
30#### Run Bridge with Ledger support
32If 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:
341. Install [mkcert](https://github.com/FiloSottile/mkcert)
352. If you're using Firefox, additionally install [nss](https://github.com/nss-dev/nss)
363. Install a local certificate authority via `mkcert -install`
374. 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
385. Run `python bridge-https.py`
396. Navigate to https://localhost:4443 in a web browser to access Bridge
41### Verify checksums
43To validate your downloaded file's integrity, compare the lines in checksum.txt to SHA-256 hashes of the `bridge-$version` directory's contents.
45- On MacOS: `shasum -a 256 -c checksums.txt .`
46- On Linux: `sha256sum -c checksums.txt .`
47- On Windows: Go into the `build` directory and verify files individually with `CertUtil -hashFile [file_name] SHA256`
49## Development notes
51### Install / Build
53Clone the repo, and use a simple `npm install`. You can then use a `npm run
54build` to create an optimised static build (serve it with e.g. [serve][serv]).
56### General notes
58For development, use `npm run pilot` to get going after a `npm install`. This
59will boot up a Ganache node in the background, deploy the Azimuth contracts to
60it, and fire up a local webserver. Bridge will be served on `localhost:3000`.
62Note that one of our dependencies itself depends on a library called
63`handle-thing` which breaks under the Ledger support requirements (see below)
64on node 11.1.0, so make sure you're using some other node version.
66You can use [nvm](https://github.com/creationix/nvm), for example, and do:
68```
69$ nvm install 11.0.0
70$ nvm use v11.0.0
71```
73before running `npm run pilot`.
75### Useful accounts
77The ecliptic owner is the only account that's able to create galaxies, so
78it's a good place to get started. On the testnet, it's the address:
80```
810x6DEfFb0caFDB11D175F123F6891AA64F01c24F7d
82```
84You can authenticate as it using the following mnemonic:
86```
87benefit crew supreme gesture quantum web media hazard theory mercy wing kitten
88```
90Under that mnemonic, Ganache will also auto-populate the following accounts
91with 100 ETH:
93```
940x6deffb0cafdb11d175f123f6891aa64f01c24f7d
950xd53208cf45fc9bd7938b200bff8814a26146688f
960x7b2a2d51e4d8fac602e20a5f6907ff9fbd88e1fd
970xf48062ae8bafd6ef19cd6cb89db93a0d0ca6ce26
980xf84a77aeb351c49dfa87e805a659d2daddff7606
990x167e357cf8b845370d0d408f9b389b66185b7b5b
1000xcbecf3abc9878f07afc851aead2d8f1c436cc71d
1010x0afc0c3f4eeea500871f464ca71eef5e54a9af36
1020x6d654ef2489674d21aed428e8a4ad8ca4820f125
1030x218f6f87683db546ad47a5dc8b480e5a9b694866
104```
106To play around with any of these, authenticate using the same mnemonic, but
107use a custom HD path of `m/44'/60'/0'/0/1`, `m/44'/60'/0'/0/2`, and so on.
109### Initial development state
111You can also tweak a couple of things to change your development state
112somewhat (say, for example, you want to start on the points list screen, instead
113of having to re-authenticate whenever you make a change or refresh the page):
115* The `.env.development` file contains environment variables that you can
116 provide to the application when it's running in development. You can access
117 them via `process.env.REACT_APP_<whatever>`.
119* The `componentDidMount` method of the Bridge component in `src/Bridge.js`
120 can be tweaked for setting your initial state. You can provide a specific
121 wallet, network type, and so on.
123### HTTPS
125For development, you can enable HTTPS on localhost without a certificate for
126Chrome by pasting the following into the URL bar:
128```
129chrome://flags/#allow-insecure-localhost
130```
132In Firefox, you may need to allow connecting to the unsecured local node
133websocket. Do this by going to `about:config` and setting the
134`network.websocket.allowInsecureFromHTTPS` flag to `true`.
136Additionally you need to run with the `HTTPS` environment variable set to
137`true`. Note that `npm run pilot` will handle this automatically.
139### Releases
141To generate a release `bridge-$VERSION.zip` file, use a simple `npm run
142release`.
144This will pack the build directory together with the README, `bridge-https.py`
145script, and also generate a set of checksums for the build directory. You can
146verify the checksums on e.g. OS X via `shasum -c checksums.txt`.
148[rele]: https://github.com/urbit/bridge/releases/latest
149[serv]: http://npmjs.com/package/serve