Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mobilecoinofficial/full-service
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 858749fba876781d5e16df4881a36b308f638e40
Choose a base ref
..
head repository: mobilecoinofficial/full-service
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 19dc35e85e160a2b48fa32e5ef532718c3a4eb37
Choose a head ref
Showing with 5 additions and 9 deletions.
  1. +5 −9 full-service/src/config.rs
14 changes: 5 additions & 9 deletions full-service/src/config.rs
Original file line number Diff line number Diff line change
@@ -94,23 +94,19 @@ pub struct APIConfig {
/// Webhook configuration to notify an external server listening for
/// deposit notifications.
///
/// The format of the webhook is a POST request with the following query
/// The format of the webhook is a POST request with the following
/// parameters:
///
/// POST /webhook -H "Content-Type: application/json" \
/// -d '{"accounts": [A,B,C], "restart": false}'
///
/// The first time full-service is caught up with the network ledger,
/// it will send a webhook with {"restart": true, "accounts": [A,]}
/// where "accounts" may be empty.
///
/// Where the num_txos provided indicate how many txos were received
/// in the last scan period for any account in the wallet.
/// -d '{"accounts": [A,B,C]}'
///
/// The expected action to take in response to the webhook is to call
/// the `get_txos` API endpoint for the given accounts to retrieve more
/// details about the TXOs received.
///
/// It is also expected for the client to call get_txos on startup and
/// periodically to ensure that no TXOs are missed.
///
/// We expect a 200 response code to indicate that the webhook was
/// received, and we do not further inspect the response body. Even if
/// not a 200 response, we will continue to attempt to reach the webhook