From ebee442341feb85abb32af294e39709b7df426fe Mon Sep 17 00:00:00 2001 From: woodser Date: Tue, 9 Nov 2021 07:58:09 -0500 Subject: [PATCH] documentation to add api calls moved to haveno developer guide (#25) --- docs/adding_api_functions.md | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 docs/adding_api_functions.md diff --git a/docs/adding_api_functions.md b/docs/adding_api_functions.md deleted file mode 100644 index a6c7ae00..00000000 --- a/docs/adding_api_functions.md +++ /dev/null @@ -1,13 +0,0 @@ -# How to add and test new gRPC API functions in Haveno - -1. Follow [instructions](https://github.com/haveno-dex/haveno-ui-poc#run-tests) to run Haveno's existing API tests successfully. -2. Define the new service or message in Haveno's [protobuf definition](https://github.com/haveno-dex/haveno/blob/master/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. 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. -7. Add the corresponding typescript method(s) to [HavenoDaemon.tsx](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/HavenoDaemon.tsx) with clear and concise documentation. -8. Add clean and comprehensive tests to [HavenoDaemon.test.tsx](https://github.com/haveno-dex/haveno-ui-poc/blob/master/src/HavenoDaemon.test.tsx), 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. -10. Open a pull request for review. \ No newline at end of file