diff --git a/README.md b/README.md index a984c3d7..4b5949e7 100644 --- a/README.md +++ b/README.md @@ -32,20 +32,37 @@ await alice.disconnect(); ## TypeDocs -See [typedocs](https://haveno-dex.github.io/haveno-ts/classes/HavenoClient.HavenoClient.html). +See [TypeDocs](https://haveno-dex.github.io/haveno-ts/classes/HavenoClient.HavenoClient.html). ## Run tests -Running the [API tests](./src/HavenoClient.test.ts) is the best way to develop and test Haveno end-to-end. +Running the [API tests](./src/HavenoClient.test.ts) is the best way to develop and test Haveno end-to-end. [`HavenoClient.ts`](./src/HavenoClient.ts) provides the client interface to Haveno's backend daemon. -[`HavenoClient.ts`](./src/HavenoClient.ts) provides the client interface to Haveno's backend daemon. +You first need to start a local Haveno network which can be done manually or using docker. + +### Start local Haveno network manually 1. [Run a local Haveno test network](https://github.com/haveno-dex/haveno/blob/master/docs/installing.md) and then shut down the arbitrator, user1, and user2 or run them as daemons, e.g. `make user1-daemon-local`. You may omit the arbitrator registration steps since it's done automatically in the tests. 2. Clone this project to the same parent directory as the haveno project: `git clone https://github.com/haveno-dex/haveno-ts` 3. In a new terminal, start envoy with the config in haveno-ts/config/envoy.test.yaml.
For example (change absolute path for your system): `docker run --rm --add-host host.docker.internal:host-gateway -it -v ~/git/haveno-ts/config/envoy.test.yaml:/envoy.test.yaml -p 8079:8079 -p 8080:8080 -p 8081:8081 -p 8082:8082 -p 8083:8083 -p 8084:8084 -p 8085:8085 -p 8086:8086 envoyproxy/envoy-dev:latest -c /envoy.test.yaml` 4. In a new terminal, start the funding wallet. This wallet will be funded automatically in order to fund the tests.
For example: `cd ~/git/haveno && make funding-wallet-local`. + +### Start local Haveno network with docker + +Alternatively, start a local Haveno network with docker: + +1. `cd ~/git/haveno-ts/docker` +2. `sudo docker-compose up`. This will start docker and initialize the network. + +> **Docker Tips** +> * Stop: `studo docker-compose stop` +> * Rebuild: `sudo docker-compose build` +> * Stop and delete contains: `studo docker-compose stop` + +### Run client tests + 5. Install protobuf compiler [v3.20.3](https://github.com/protocolbuffers/protobuf/releases/tag/v3.20.3) for your system. 6. Download `protoc-gen-grpc-web` plugin and make executable as [shown here](https://github.com/grpc/grpc-web#code-generator-plugin). 7. `cd haveno-ts` 8. `npm install` -9. `npm run test -- --baseCurrencyNetwork=XMR_LOCAL` to run all tests or `npm run test -- --baseCurrencyNetwork=XMR_LOCAL -t "my test"` to run tests by name. +9. `npm run test -- --baseCurrencyNetwork=XMR_LOCAL` to run all tests or `npm run test -- --baseCurrencyNetwork=XMR_LOCAL -t "Can get the version"` to run tests by name. diff --git a/docker/haveno/Dockerfile b/docker/haveno/Dockerfile index 87b46b71..af93cb65 100644 --- a/docker/haveno/Dockerfile +++ b/docker/haveno/Dockerfile @@ -16,6 +16,8 @@ RUN set -ex && git clone https://github.com/haveno-dex/haveno.git /home/haveno/h WORKDIR /home/haveno/haveno +RUN set -ex && git fetch origin && git checkout origin/master + RUN set -ex && make skip-tests ENTRYPOINT [ "./haveno-daemon" ] diff --git a/docker/pricenode/Dockerfile b/docker/pricenode/Dockerfile index 745011c1..7ff0a500 100644 --- a/docker/pricenode/Dockerfile +++ b/docker/pricenode/Dockerfile @@ -16,6 +16,8 @@ RUN set -ex && git clone --recursive https://github.com/haveno-dex/haveno-pricen WORKDIR /home/pricenode +RUN set -ex && git fetch origin && git checkout origin/main + RUN ./gradlew clean build -x test ENTRYPOINT [ "./haveno-pricenode" ]