Git-Mirrors/haveno-ts
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno-ts.git synced 2024-12-24 14:59:31 -05:00
Code Issues Packages Projects Releases Wiki Activity
TypeScript library for using Haveno
83 Commits 8 Branches 30 Tags 47 MiB
TypeScript 99.1%
Dockerfile 0.4%
JavaScript 0.3%
Shell 0.2%
28a2f3dc5f
Go to file
woodser 28a2f3dc5f add _config.yml for github pages documentation
2022-05-02 16:43:42 -04:00
.github add .github/CODEOWNERS (#24) 2021-11-09 07:57:57 -05:00
bin Add market depth API call (#47) 2022-02-11 18:13:56 -05:00
config support auto starting and stopping arbitrator, alice, and bob 2021-12-19 11:49:43 -05:00
docs enable github pages jekyll 2022-05-02 16:29:36 -04:00
public update logo (#5) 2021-09-09 04:54:14 -04:00
src add typedocs 2022-05-02 15:21:48 -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 enable and apply eslint rules 2022-05-02 15:21:48 -04:00
.gitignore chore(typedocs): add Typedocs to automate docs generating. 2022-05-01 11:44:47 -04:00
.project fetch and display haveno daemon version in react 2021-04-25 19:58:26 -04:00
haveno-ui-poc.png update poc image and test (#7) 2021-09-10 06:43:16 -04:00
LICENSE change license to apache 2.0 (#6) 2021-09-10 06:43:06 -04:00
package-lock.json add typedocs 2022-05-02 15:21:48 -04:00
package.json enable github pages jekyll 2022-05-02 16:29:36 -04:00
README.md rename to haveno.ts, haveno.test.ts 2022-04-06 11:37:11 -04:00
tsconfig.json enable and apply eslint rules 2022-05-02 15:21:48 -04:00

README.md

Haveno UI Proof of Concept

A proof of concept to fetch and render data from Haveno's daemon in ReactJS.

This application is a lightly modified create-react-app with typescript using envoy proxy and grpc-web to use Haveno's gRPC API.

Run in a Browser

  1. Run a local Haveno test network, running Alice as a daemon with make alice-daemon.
  2. Clone this project to the same parent directory as the haveno project: git clone https://github.com/haveno-dex/haveno-ui-poc
  3. In a new terminal, start envoy with the config in haveno-ui-poc/config/envoy.yaml (change absolute path for your system): docker run --rm --add-host host.docker.internal:host-gateway -it -v ~/git/haveno-ui-poc/config/envoy.yaml:/envoy.yaml -p 8080:8080 envoyproxy/envoy-dev:8a2143613d43d17d1eb35a24b4a4a4c432215606 -c /envoy.yaml
  4. 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.
  5. Download protoc-gen-grpc-web plugin and make executable as shown here.
  6. cd haveno-ui-poc
  7. npm install
  8. npm start to open http://localhost:3000 in a browser
  9. Confirm that the Haveno daemon version is displayed (1.6.2).


Run Tests

Running the API tests is the best way to develop and test Haveno end-to-end.

haveno.ts provides the interface to Haveno's backend daemon.

  1. Run a local Haveno test network and then shut down the arbitrator, Alice, and Bob or run them as daemons, e.g. make alice-daemon. You may omit the arbitrator registration steps since it is 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-ui-poc
  3. In a new terminal, start envoy with the config in haveno-ui-poc/config/envoy.test.yaml (change absolute path for your system): docker run --rm --add-host host.docker.internal:host-gateway -it -v ~/git/haveno-ui-poc/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:8a2143613d43d17d1eb35a24b4a4a4c432215606 -c /envoy.test.yaml
  4. In a new terminal, start the funding wallet. This wallet will be automatically funded in order to fund Alice and Bob during the tests.
    For example: cd ~/git/haveno && make funding-wallet.
  5. 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.
  6. Download protoc-gen-grpc-web plugin and make executable as shown here.
  7. cd haveno-ui-poc
  8. npm install
  9. npm test to run all tests or npm run test -- -t 'my test' to run tests by name.