update instructions to update grpc client

This commit is contained in:
woodser 2021-11-21 14:15:58 -05:00
parent f1b22a16b3
commit 1f7daac389

View file

@ -28,7 +28,7 @@ Follow [instructions](https://github.com/haveno-dex/haveno-ui-poc#run-tests) to
4. Implement the new service in Haveno's backend, following existing patterns.<br> 4. Implement the new service in Haveno's backend, following existing patterns.<br>
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). 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` 5. Build Haveno: `make`
6. Follow [instructions](https://github.com/haveno-dex/haveno-ui-poc#how-to-update-the-protobuf-client) to update the protobuf client in haveno-ui-poc. 6. Update the gRPC client in haveno-ui-poc: `npm install`
7. Add the corresponding typescript method(s) to [HavenoDaemon.ts](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/HavenoDaemon.ts) with clear and concise documentation. 7. Add the corresponding typescript method(s) to [HavenoDaemon.ts](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/HavenoDaemon.ts) with clear and concise documentation.
8. Add clean and comprehensive tests to [HavenoDaemon.test.ts](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/HavenoDaemon.test.ts), following existing patterns. 8. Add clean and comprehensive tests to [HavenoDaemon.test.ts](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/HavenoDaemon.test.ts), following existing patterns.
9. Verify the tests with `npm run test -- -t 'my test'` to run tests by name and `npm test` to run all tests together. 9. Verify the tests with `npm run test -- -t 'my test'` to run tests by name and `npm test` to run all tests together.