mirror of https://github.com/haveno-dex/haveno-ts.git synced 2025-11-24 16:33:45 -05:00

TypeScript library for using Haveno

Find a file

woodser aa0f2c69bf use usd as default trade asset wait to process network notifications after opening haveno app		2023-01-11 08:55:08 -05:00
.github	fix resolve disputes test so it completes	2022-12-21 08:37:06 +00:00
config	add dockerize and add project on Github CI/CD	2022-12-16 15:02:10 +00:00
dist	update dist	2022-12-17 10:58:54 +00:00
docker	start seednode with monerod address	2022-12-24 18:32:10 +00:00
docs	update typedocs with private members removed	2022-11-07 08:26:57 -05:00
scripts	add dockerize and add project on Github CI/CD	2022-12-16 15:02:10 +00:00
src	use usd as default trade asset	2023-01-11 08:55:08 -05:00
.editorconfig	enable and apply eslint rules	2022-05-02 15:21:48 -04:00
.eslintignore	enable and apply eslint rules	2022-05-02 15:21:48 -04:00
.eslintrc.json	support local, stagenet, and mainnet xmr network configurations (#122 )	2022-07-07 09:11:50 -04:00
.gitignore	add dockerize and add project on Github CI/CD	2022-12-16 15:02:10 +00:00
.project	rename haveno-ui-poc project to haveno-ts	2022-05-03 08:06:56 -04:00
_config.yml	add _config.yml for github pages documentation	2022-05-02 16:43:42 -04:00
babel.config.js	convert to typescript library	2022-05-05 22:25:08 -04:00
LICENSE	change license to apache 2.0 (#6 )	2021-09-10 06:43:06 -04:00
package-lock.json	update to monero-javascript v0.7.6	2023-01-05 10:01:46 -05:00
package.json	update to monero-javascript v0.7.6	2023-01-05 10:01:46 -05:00
README.md	add dockerize and add project on Github CI/CD	2022-12-16 15:02:10 +00:00
tsconfig.json	change module to commonjs	2022-05-12 17:32:05 -04:00

README.md

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.

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 (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.
Install protobuf compiler v3.19.1 or later for your system:
mac: brew install protobuf
linux: apt install protobuf-compiler NOTE: You may need to upgrade to v3.19.1 manually if your package manager installs an older version.
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 or npm run test -- --baseCurrencyNetwork=XMR_LOCAL -t "my test" to run tests by name.