Git-Mirrors/haveno-ts
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno-ts.git synced 2025-11-24 00:13:43 -05:00
Code Issues Projects Releases Packages Wiki Activity
TypeScript library for using Haveno
434 commits 1 branch 38 tags 76 MiB
Find a file
woodser b55e06be43 update divide and multiply utils for bigints
2025-01-18 07:52:03 -05:00
.github update protobuf and grpc dependencies 2025-01-14 18:22:37 -05:00
config Update guide for local development with local envoy proxy 2024-09-06 13:41:21 -04:00
dist bump version to v0.0.32 and update dist 2024-12-29 08:13:33 -05:00
docker Update docker images to java 21 (#269) 2024-03-11 13:37:41 -04:00
docs update typedocs 2024-12-20 18:21:30 -05:00
scripts add dockerize and add project on Github CI/CD 2022-12-16 15:02:10 +00:00
src update divide and multiply utils for bigints 2025-01-18 07:52:03 -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
jest.config.cjs fix ts errors in tests 2024-08-29 12:40:52 -04:00
LICENSE change license to apache 2.0 (#6) 2021-09-10 06:43:06 -04:00
package-lock.json update protobuf and grpc dependencies 2025-01-14 18:22:37 -05:00
package.json update protobuf and grpc dependencies 2025-01-14 18:22:37 -05:00
README.md update link to protoc v29.3 2025-01-14 19:23:16 -05:00
tsconfig.json do not emit tests to dist folder 2024-09-20 21:30:40 -04:00

README.md

Haveno TypeScript Library

GitHub Workflow Status Twitter Follow Matrix rooms

TypeScript library for using Haveno.

Install

  1. Start a Haveno daemon (see installing.md).
  2. 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

This workflow is useful for local development of haveno and haveno-ts

  1. 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.
  2. Clone this project to the same parent directory as the haveno project: git clone https://github.com/haveno-dex/haveno-ts
  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.
    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

  1. Install protobuf compiler v29.3 for your system.
  2. Download protoc-gen-js and protoc-gen-grpc-web plugins and make executable as shown here.
  3. cd haveno-ts
  4. npm install
  5. 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.