Robosats/taptrade-core
1
0
Fork 0
mirror of https://github.com/RoboSats/taptrade-core.git synced 2025-07-19 01:03:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

adding docs for communication api

Browse Source
This commit is contained in:
aaravm
2024-08-26 17:09:18 +05:30
parent 59faa52fe9
commit 05c56a3ae0
1 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
taptrade-cli-demo/coordinator/src/communication/api.rs
View File

@ -1,3 +1,77 @@
/// This module contains the API structures used for communication in the coordinator.
///
/// The `OfferRequest` struct represents a request to create an offer. It contains the following fields:
/// - `robohash_hex`: The identifier of the trader.
/// - `amount_satoshi`: The amount in satoshi to buy or sell.
/// - `is_buy_order`: A boolean indicating whether it is a buy order or a sell order.
/// - `bond_ratio`: The percentage of the trading amount to be used as a bond.
/// - `offer_duration_ts`: The unix timestamp indicating how long the offer should stay available.
///
/// The `BondRequirementResponse` struct represents the response containing bond requirements. It has the following fields:
/// - `bond_address`: The bond address.
/// - `locking_amount_sat`: The minimum amount of the bond output in satoshi.
///
/// The `BondSubmissionRequest` struct represents a request to submit a bond. It contains the following fields:
/// - `robohash_hex`: The identifier of the trader.
/// - `signed_bond_hex`: The signed bond transaction in hex format.
/// - `payout_address`: The payout address.
/// - `taproot_pubkey_hex`: The taproot public key in hex format.
/// - `musig_pub_nonce_hex`: The musig public nonce in hex format.
/// - `musig_pubkey_hex`: The musig public key in hex format.
/// - `bdk_psbt_inputs_hex_csv`: The bdk psbt inputs in hex format.
/// - `client_change_address`: The client change address.
///
/// The `OfferActivatedResponse` struct represents the response after successfully activating an offer. It has the following fields:
/// - `offer_id_hex`: The offer ID in hex format.
/// - `bond_locked_until_timestamp`: The unix timestamp until which the bond should not be touched unless the offer gets taken.
///
/// The `OffersRequest` struct represents a request to get offers. It contains the following fields:
/// - `buy_offers`: A boolean indicating whether to look for buy offers or sell offers.
/// - `amount_min_sat`: The minimum amount in satoshi.
/// - `amount_max_sat`: The maximum amount in satoshi.
///
/// The `PublicOffer` struct represents information about a public offer. It has the following fields:
/// - `amount_sat`: The amount in satoshi.
/// - `offer_id_hex`: The offer ID in hex format.
/// - `required_bond_amount_sat`: The required bond amount in satoshi.
/// - `bond_locking_address`: The bond locking address.
///
/// The `PublicOffers` struct represents a collection of public offers. It has the following field:
/// - `offers`: An optional vector of `PublicOffer` structs. This field is not included in the return JSON if no offers are available.
///
/// The `OfferTakenResponse` struct represents the response after taking an offer. It has the following fields:
/// - `escrow_psbt_hex`: The escrow PSBT in hex format.
/// - `escrow_output_descriptor`: The escrow output descriptor.
/// - `escrow_amount_maker_sat`: The escrow amount for the maker in satoshi.
/// - `escrow_amount_taker_sat`: The escrow amount for the taker in satoshi.
/// - `escrow_fee_sat_per_participant`: The escrow fee in satoshi per participant.
///
/// The `OfferPsbtRequest` struct represents a request to receive the escrow PSBT for a specified offer. It contains the following fields:
/// - `offer`: The `PublicOffer` struct representing the offer.
/// - `trade_data`: The `BondSubmissionRequest` struct representing the trade data.
///
/// The `OfferTakenRequest` struct represents a request to take an offer. It contains the following fields:
/// - `robohash_hex`: The identifier of the trader.
/// - `offer_id_hex`: The offer ID in hex format.
///
/// The `PsbtSubmissionRequest` struct represents a request to submit a PSBT. It contains the following fields:
/// - `signed_psbt_hex`: The signed PSBT in hex format.
/// - `offer_id_hex`: The offer ID in hex format.
/// - `robohash_hex`: The identifier of the trader.
///
/// The `PayoutResponse` struct represents the response after a payout. It has the following fields:
/// - `payout_psbt_hex`: The payout PSBT in hex format.
/// - `agg_musig_nonce_hex`: The aggregated musig nonce in hex format.
/// - `agg_musig_pubkey_ctx_hex`: The aggregated musig public key context in hex format.
///
/// The `TradeObligationsUnsatisfied` struct represents unsatisfied trade obligations. It has the following fields:
/// - `robohash_hex`: The identifier of the trader.
/// - `offer_id_hex`: The offer ID in hex format.
///
/// The `PayoutSignatureRequest` struct represents a request for a payout signature. It contains the following fields:
/// - `partial_sig_hex`: The partial signature in hex format.
/// - `offer_id_hex`: The offer ID in hex format.
/// - `robohash_hex`: The identifier of the trader.
use super::*;
#[derive(Deserialize, Serialize, Debug, Validate)]