Merge branch 'master' into wowario-patch-1

.github/workflows/build.yml

@@ -8,23 +8,29 @@ on:
 
 jobs:
   haveno-ts-e2e:
-    timeout-minutes: 60
+    timeout-minutes: 90
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Setup Java 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
 
       - name: Stop Mono service
         run: sudo killall mono
 
       - name: Start containers
-        run: docker-compose -f "./docker/docker-compose.yml" up -d --build
+        run: docker compose -f "./docker/docker-compose.yml" up -d --build
 
       - name: Install node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install protoc-gen-grpc-web
         run: |
@@ -58,4 +64,4 @@ jobs:
 
       - name: Stop containers
         if: always()
-        run: docker-compose -f "./docker/docker-compose.yml" down
+        run: docker compose -f "./docker/docker-compose.yml" down

README.md

@@ -32,20 +32,42 @@ 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
+
+This workflow is useful for local development of `haveno` and `haveno-ts`
 
 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.<br>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.<br>For example: `cd ~/git/haveno && make funding-wallet-local`.
+3. Install `envoy` proxy from your package manager of choice, for example `brew install envoy`.
+4. In a new terminal, start envoy with the config in haveno-ts/config/envoy.local.yaml: `envoy -c config/envoy.local.yaml`
+5. In a new terminal, start the funding wallet. This wallet will be funded automatically in order to fund the tests.<br>For example: `cd ~/git/haveno && make funding-wallet-local`.
+
+### Start local Haveno network with docker
+
+Alternatively use this wokflow to develop `haveno-ts` or run tests with dockerized setup:
+
+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: `sudo docker-compose stop`
+> * Rebuild: `sudo docker-compose build`
+> * Stop and delete contains: `sudo 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.