Git-Mirrors/haveno-ts
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno-ts.git synced 2024-12-25 07:19:29 -05:00
Code Issues Packages Projects Releases Wiki Activity
TypeScript library for using Haveno
284 Commits 8 Branches 30 Tags 47 MiB
TypeScript 99.1%
Dockerfile 0.4%
JavaScript 0.3%
Shell 0.2%
02cc0faded
Go to file
woodser 02cc0faded refactor data model for test trade context 
use object-oriented context for tests
factor out trade peer context to TradePeer
test expected balances end-to-end
test split output fee if maker reserves exact amount
2023-10-30 17:10:16 -04:00
.github collect docker logs after running tests 2023-02-20 18:00:38 -05:00
config limit 1 client request per connection in envoy to fix linux tests 2023-02-20 18:00:38 -05:00
dist refactor data model for test trade context 2023-10-30 17:10:16 -04:00
docker document running local network with docker 2023-09-15 06:37:37 -04:00
docs update typedocs 2023-10-10 19:22:58 -04:00
scripts add dockerize and add project on Github CI/CD 2022-12-16 15:02:10 +00:00
src refactor data model for test trade context 2023-10-30 17:10:16 -04:00
_config.yml add _config.yml for github pages documentation 2022-05-02 16:43:42 -04: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
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 bump version to v0.0.17 supporting haveno v0.0.13 2023-10-13 12:05:38 -04:00
package.json bump version to v0.0.17 supporting haveno v0.0.13 2023-10-13 12:05:38 -04:00
README.md document running local network with docker 2023-09-15 06:37:37 -04:00
tsconfig.json update to monero-ts v0.9.2 with typescript 2023-10-02 11:29:43 -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

  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. 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
  4. 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:

  1. cd ~/git/haveno-ts/docker
  2. 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

  1. Install protobuf compiler v3.20.3 for your system.
  2. Download protoc-gen-grpc-web plugin 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.