diff --git a/README.md b/README.md index 0cc399b8..eee7860e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Haveno is currently being developed, but it's already possible to test XMR <->fi The project is divided between multiple repositories: - **[haveno](https://github.com/haveno-dex/haveno)** - This repository. The heart of Haveno. -- **[haveno-ui-poc](https://github.com/haveno-dex/haveno-ui-poc)** - The PoC of the future user interface. Uses gRPC APIs to serve the UI in React. +- **[haveno-ts](https://github.com/haveno-dex/haveno-ts)** - The PoC of the future user interface. Uses gRPC APIs to serve the UI in React. - **[haveno-meta](https://github.com/haveno-dex/haveno-meta)** - For project-wide discussions and proposals. - **[haveno-site](https://github.com/haveno-dex/haveno-site)** - The repository of the website. diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 090f99b0..e6d44796 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -8,7 +8,7 @@ In order to develop for Haveno, first [install and run a local Haveno test netwo ## Running the UI proof of concept -Follow [instructions](https://github.com/haveno-dex/haveno-ui-poc#run-in-a-browser) to run Haveno's UI proof of concept in a browser. +Follow [instructions](https://github.com/haveno-dex/haveno-ts#run-in-a-browser) to run Haveno's UI proof of concept in a browser. This proof of concept demonstrates using Haveno's gRPC server with a web frontend (react and typescript) instead of Bisq's JFX application. @@ -18,21 +18,21 @@ Follow [instructions](import-haveno.md) to import Haveno into a development envi ## Running end-to-end API tests -Follow [instructions](https://github.com/haveno-dex/haveno-ui-poc#run-tests) to run end-to-end API tests in the UI project. +Follow [instructions](https://github.com/haveno-dex/haveno-ts#run-tests) to run end-to-end API tests in the UI project. ## Adding new API functions and tests -1. Follow [instructions](https://github.com/haveno-dex/haveno-ui-poc#run-tests) to run Haveno's existing API tests successfully. +1. Follow [instructions](https://github.com/haveno-dex/haveno-ts#run-tests) to run Haveno's existing API tests successfully. 2. Define the new service or message in Haveno's [protobuf definition](../proto/src/main/proto/grpc.proto). 3. Clean and build Haveno after modifying the protobuf definition: `make clean && make` 4. Implement the new service in Haveno's backend, following existing patterns.
For example, the gRPC function to get offers is implemented by [`GrpcServer`](https://github.com/haveno-dex/haveno/blob/master/daemon/src/main/java/bisq/daemon/grpc/GrpcServer.java) > [`GrpcOffersService.getOffers(...)`](https://github.com/haveno-dex/haveno/blob/b761dbfd378faf49d95090c126318b419af7926b/daemon/src/main/java/bisq/daemon/grpc/GrpcOffersService.java#L104) > [`CoreApi.getOffers(...)`](https://github.com/haveno-dex/haveno/blob/b761dbfd378faf49d95090c126318b419af7926b/core/src/main/java/bisq/core/api/CoreApi.java#L128) > [`CoreOffersService.getOffers(...)`](https://github.com/haveno-dex/haveno/blob/b761dbfd378faf49d95090c126318b419af7926b/core/src/main/java/bisq/core/api/CoreOffersService.java#L126) > [`OfferBookService.getOffers()`](https://github.com/haveno-dex/haveno/blob/b761dbfd378faf49d95090c126318b419af7926b/core/src/main/java/bisq/core/offer/OfferBookService.java#L193). 5. Build Haveno: `make` -6. Update the gRPC client in haveno-ui-poc: `npm install` -7. Add the corresponding typescript method(s) to [haveno.ts](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/haveno.ts) with clear and concise documentation. -8. Add clean and comprehensive tests to [haveno.test.ts](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/haveno.test.ts), following existing patterns. +6. Update the gRPC client in haveno-ts: `npm install` +7. Add the corresponding typescript method(s) to [haveno.ts](https://github.com/haveno-dex/haveno-ts/blob/master/src/haveno.ts) with clear and concise documentation. +8. Add clean and comprehensive tests to [haveno.test.ts](https://github.com/haveno-dex/haveno-ts/blob/master/src/haveno.test.ts), following existing patterns. 9. Run the tests with `npm run test -- -t 'my test'` to run tests by name and `npm test` to run all tests together. Ensure all tests pass and there are no exception stacktraces in the terminals of Alice, Bob, or the arbitrator. -10. Open pull requests to the haveno and haveno-ui-poc projects for the backend and frontend implementations. +10. Open pull requests to the haveno and haveno-ts projects for the backend and frontend implementations. ## How to rebase and squash your commits diff --git a/docs/import-haveno.md b/docs/import-haveno.md index d5119abb..6b8b0cf9 100644 --- a/docs/import-haveno.md +++ b/docs/import-haveno.md @@ -21,8 +21,8 @@ These steps describe how to import Haveno into Eclipse IDE for development. You 11. Advance to finish importing haveno project. 12. Right click haveno project > Gradle > Refresh Gradle Project. 13. File > Import... > Existing Projects into Workspace. -14. Select the location of "haveno-ui-poc" project, e.g. ~/git/haveno-ui-poc. -15. Advance to finish importing haveno-ui-poc project. +14. Select the location of "haveno-ts" project, e.g. ~/git/haveno-ts. +15. Advance to finish importing haveno-ts project. You are now ready to make, run, and test changes to the Haveno project!