Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamISZ committed Aug 17, 2020
1 parent 1d68ccc commit 29b55a3
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
# Jmcontrolcenter

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5.
Currently a very bare bones prototype demonstrating the following functionality:

* Run a daemon for joinmarket in python, and connect to it via this Angular app.
* Unlock a wallet and display its contents.

This is one of the initial steps in trying to realise something like what is described [here](https://gist.github.com/AdamISZ/f062c7453c6973a8287897fe506b9d19).

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
Required steps to test this demo:

## Code scaffolding
Check out the `rpc-api-1` branch on [Joinmarket-clientserver](https://github.com/Joinmarket-Org/joinmarket-clientserver).
Go into the virtualenv as for any Joinmarket script.
Get a backend regtest instance running; use (from the root directory of Joinmarket):

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
```
pytest --btcconf=/some/dir/bitcoin.conf --btcroot=/some/dir/bitcoin-0.19.0.1/bin/ --btcpwd=123456abcdef --nirc=2 test/ygrunner.py -s -p no:warnings
```

## Build
Generate a test key and certificate named `key.pem` and `cert.pem` respectively and drop them in the `scripts/` folder of Joinmarket.
Run the new daemon with : `python jmwalletd.py` in that `scripts/` folder and in the Joinmarket `jmvenv` as usual.

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
Then run the Angular project as described below:

## Running unit tests
===============

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5.

## Development server

## Running end-to-end tests
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`.

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
From here you can click "Unlock wallet", fill in wallet file name and password, and the wallet contents will be displayed automatically.

## Further help
You will probably want to first generate a regtest wallet with a filename and then fund it from the test wallets provided by `ygrunner.py` (but an empty wallet will be a start).

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

0 comments on commit 29b55a3

Please sign in to comment.