TypeScript library for using Haveno.
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();See the sample application to start a Haveno daemon and connect to it from haveno-ts.
See TypeDocs.
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.
This workflow is useful for local development of haveno and haveno-ts
- 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 - Install
envoyproxy from your package manager of choice, for examplebrew install envoy. - In a new terminal, start envoy with the config in haveno-ts/config/envoy.local.yaml:
envoy -c config/envoy.local.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.
Alternatively use this wokflow to develop haveno-ts or run tests with dockerized setup:
Start a local Haveno network with docker:
cd ~/git/haveno-ts/dockersudo 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
- Install protobuf compiler v29.3 for your system.
- Download
protoc-gen-jsandprotoc-gen-grpc-webplugins and make executable as shown here. cd haveno-tsnpm installnpm run test -- --baseCurrencyNetwork=XMR_LOCALto run all tests ornpm run test -- --baseCurrencyNetwork=XMR_LOCAL -t "Can get the version"to run tests by name.