0.0.23 • Published 1 month ago
haveno-ts v0.0.23
Haveno TypeScript Library
TypeScript library for using Haveno.
Install
- Start a Haveno daemon (see installing.md).
- Install haveno-ts in your project:
npm install haveno-ts
Sample code
import { HavenoClient } from "haveno-ts";
// create client connected to Haveno daemon
const alice = new HavenoClient("http://localhost:8080", "apitest");
// use Haveno daemon
const balances = await alice.getBalances();
const paymentAccounts = await alice.getPaymentAccounts();
const myOffers = await alice.getMyOffers("ETH");
const offers = await alice.getOffers("ETH", "BUY");
const trade = await alice.takeOffer(offers[0].getId(), paymentAccounts[0].getId());
// disconnect client
await alice.disconnect();
TypeDocs
See TypeDocs.
Run tests
Running the API tests is the best way to develop and test Haveno end-to-end. 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
- Run a local Haveno test network 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. - Clone this project to the same parent directory as the haveno project:
git clone https://github.com/haveno-dex/haveno-ts
- 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
- 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:
cd ~/git/haveno-ts/docker
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
- Install protobuf compiler v3.20.3 for your system.
- Download
protoc-gen-grpc-web
plugin and make executable as shown here. cd haveno-ts
npm install
npm run test -- --baseCurrencyNetwork=XMR_LOCAL
to run all tests ornpm run test -- --baseCurrencyNetwork=XMR_LOCAL -t "Can get the version"
to run tests by name.
0.0.23
1 month ago
0.0.22
2 months ago
0.0.21
3 months ago
0.0.20
5 months ago
0.0.18
6 months ago
0.0.19
6 months ago
0.0.15
8 months ago
0.0.16
7 months ago
0.0.17
7 months ago
0.0.14
9 months ago
0.0.10
12 months ago
0.0.11
11 months ago
0.0.12
10 months ago
0.0.13
9 months ago
0.0.9
1 year ago
0.0.8
1 year ago
0.0.7
2 years ago
0.0.5
2 years ago
0.0.6
2 years ago
0.0.4
2 years ago
0.0.3
2 years ago
0.0.2
2 years ago
0.0.1
2 years ago