API Reference

message GetNetworksResponse { repeated Network networks = 1; }

message GetPublicKeyRequest {}

message GetPublicKeyResponse { bytes public_key = 1; }

message GetNetworksResponse { repeated Network networks = 1; }

message GetPublicKeyRequest {}

message GetPublicKeyResponse { bytes public_key = 1; }

message GetPublicKeyResponse { bytes public_key = 1; }

message GetPublicKeyResponse { bytes public_key = 1; }

message GetAssetsResponse { repeated Asset assets = 1; }

message GetAssetRequest {
  Network network = 1;
  string asset_id = 2;
}

message GetAssetsResponse { repeated Asset assets = 1; }

message GetAssetRequest {
  Network network = 1;
  string asset_id = 2;
}

message GetAssetResponse { Asset asset = 1; }

message GetNativeAssetRequest { Network network = 1; }

message AddTokenRequest {
  Network network = 1;
  string token_id = 2;
}

message GetAssetResponse { Asset asset = 1; }

message GetNativeAssetRequest { Network network = 1; }

message AddTokenRequest {
  Network network = 1;
  string token_id = 2;
}

message GetAssetResponse { Asset asset = 1; }

message GetNativeAssetRequest { Network network = 1; }

message AddTokenRequest {
  Network network = 1;
  string token_id = 2;
}

message GetAssetResponse { Asset asset = 1; }

message GetNativeAssetRequest { Network network = 1; }

message AddTokenRequest {
  Network network = 1;
  string token_id = 2;
}

message AddTokenResponse { Asset asset = 1; }

message AddTokenResponse { Asset asset = 1; }

message GetBlockNumberResponse { uint64 block_number = 1; }

message GetBlockHeaderRequest {
  Network network = 1;
  uint64 block_number = 2;
}

message GetBlockNumberResponse { uint64 block_number = 1; }

message GetBlockHeaderRequest {
  Network network = 1;
  uint64 block_number = 2;
}

message GetBlockHeaderResponse { BlockHeader block_header = 1; }

message GetFeeEstimatesRequest { Network network = 1; }

message GetFeeEstimatesResponse { FeeEstimate fee_estimate = 1; }

message GetTokenAllowanceRequest {
  Network network = 1;
  string token_id = 2;
  string owner = 3;
  string spender = 4;
}

message GetBlockHeaderResponse { BlockHeader block_header = 1; }

message GetFeeEstimatesRequest { Network network = 1; }

message GetFeeEstimatesResponse { FeeEstimate fee_estimate = 1; }

message GetTokenAllowanceRequest {
  Network network = 1;
  string token_id = 2;
  string owner = 3;
  string spender = 4;
}

message GetFeeEstimatesRequest { Network network = 1; }

message GetFeeEstimatesResponse { FeeEstimate fee_estimate = 1; }

message GetTokenAllowanceRequest {
  Network network = 1;
  string token_id = 2;
  string owner = 3;
  string spender = 4;
}

message GetTokenAllowanceRequest {
  Network network = 1;
  string token_id = 2;
  string owner = 3;
  string spender = 4;
}

message GetDepositAddressRequest { Network network = 1; }

message GetDepositAddressResponse { string address = 1; }

message SendTransactionRequest {
  Network network = 1;
  string to_address = 2;
  SendAmount amount = 3;
  FeeOption fee_option = 4;
}

message SendTransactionRequest {
  Network network = 1;
  string to_address = 2;
  SendAmount amount = 3;
  FeeOption fee_option = 4;
}

message BumpTransactionRequest {
  Network network = 1;
  string txid = 2;
  FeeOption fee_option = 3;
}

message SendTokenTransactionRequest {
  Network network = 1;
  string to_address = 2;
  string token_id = 3;
  SendAmount amount = 4;
  FeeOption fee_option = 5;
}

message SetTokenAllowanceRequest {
  Network network = 1;
  string spender = 2;
  SetAllowance allowance = 3;
  FeeOption fee_option = 5;
}

message SubscribeClientEventsRequest { Network network = 1; }

message SubscribeNodeEventsRequest { Network network = 1; }

message SubscribeNodeEventsRequest { Network network = 1; }

message ConnectToPeerResponse {}

message GetConnectedPeersRequest { Network network = 1; }

message GetConnectedPeersResponse { repeated string node_ids = 1; }

message EstimateOpenChannelFeeRequest {
  Network network = 1;
  string node_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message ConnectToPeerResponse {}

message GetConnectedPeersRequest { Network network = 1; }

message GetConnectedPeersResponse { repeated string node_ids = 1; }

message EstimateOpenChannelFeeRequest {
  Network network = 1;
  string node_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message GetConnectedPeersRequest { Network network = 1; }

message GetConnectedPeersResponse { repeated string node_ids = 1; }

message EstimateOpenChannelFeeRequest {
  Network network = 1;
  string node_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message EstimateOpenChannelFeeRequest {
  Network network = 1;
  string node_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message OpenChannelResponse {
  string txid = 1;
  string channel_id = 2;
}

message OpenChannelResponse {
  string txid = 1;
  string channel_id = 2;
}

message EstimateDepositChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message DepositChannelResponse { string txid = 1; }

message WithdrawAmount {
  SendAmount self_withdrawal = 1;
  SendAmount counterparty_withdrawal = 2;
}

message DepositChannelResponse { string txid = 1; }

message WithdrawAmount {
  SendAmount self_withdrawal = 1;
  SendAmount counterparty_withdrawal = 2;
}

message EstimateWithdrawChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  map<string, WithdrawAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message WithdrawChannelRequest {
  Network network = 1;
  string channel_id = 2;
  map<string, WithdrawAmount> asset_amounts = 3; // key: asset_id
  FeeOption fee_option = 4;
}

message EstimateCloseChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message CloseChannelResponse { string txid = 1; }

message EstimateForceCloseChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message CloseChannelResponse { string txid = 1; }

message EstimateForceCloseChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message EstimateForceCloseChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message ForceCloseChannelRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message EstimateRedeemClosedChannelFeeRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message RedeemClosedChannelRequest {
  Network network = 1;
  string channel_id = 2;
  repeated string asset_ids = 3;
  FeeOption fee_option = 4;
}

message WaitForActiveAssetChannelRequest {
  Network network = 1;
  string channel_id = 2;
  string asset_id = 3;
  bool active_sending = 4;
  bool active_receiving = 5;
  bool updatable = 6;
}

message SendChannelPaymentRequest {
  Network network = 1;
  string channel_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  optional Hashlock hashlock = 4;
  optional uint64 expiry_timeout_secs = 5;
}

message EstimateSendPaymentFeeRequest {
  Network network = 1;
  string recipient_node_id = 2;
  map<string, SendAmount> asset_amounts = 3; // key: asset_id
  optional Hashlock hashlock = 4;
  optional uint64 expiry_timeout_secs = 5;
}

message SendPaymentResponse { string payment_id = 1; }

message CreateInvoiceRequest {
  Network network = 1;
  string asset_id = 2;
  optional DecimalString amount = 3;
  optional Hashlock hashlock = 4;
  optional uint64 expiry_timeout_secs = 5;
}

message SendPaymentResponse { string payment_id = 1; }

message CreateInvoiceRequest {
  Network network = 1;
  string asset_id = 2;
  optional DecimalString amount = 3;
  optional Hashlock hashlock = 4;
  optional uint64 expiry_timeout_secs = 5;
}

message CreateInvoiceResponse { Invoice invoice = 1; }

message DecodeInvoiceRequest {
  Network network = 1;
  string payment_request = 2;
}

message CreateInvoiceResponse { Invoice invoice = 1; }

message DecodeInvoiceRequest {
  Network network = 1;
  string payment_request = 2;
}

message DecodeInvoiceResponse { Invoice invoice = 1; }

message EstimatePayInvoiceFeeRequest {
  Network network = 1;
  string payment_request = 2;
}

message DecodeInvoiceResponse { Invoice invoice = 1; }

message EstimatePayInvoiceFeeRequest {
  Network network = 1;
  string payment_request = 2;
}

message EstimatePayInvoiceFeeRequest {
  Network network = 1;
  string payment_request = 2;
}

message PayInvoiceResponse { string payment_id = 1; }

message ResolveHashlockPaymentRequest {
  Network network = 1;
  string payment_id = 2;
  string payment_preimage = 3;
}

message PayInvoiceResponse { string payment_id = 1; }

message ResolveHashlockPaymentRequest {
  Network network = 1;
  string payment_id = 2;
  string payment_preimage = 3;
}

message EstimatePayEmptyInvoiceFeeRequest {
  Network network = 1;
  string payment_request = 2;
  SendAmount amount = 3;
}

message PayEmptyInvoiceRequest {
  Network network = 1;
  string payment_request = 2;
  SendAmount amount = 3;
}

message ResolveHashlockPaymentRequest {
  Network network = 1;
  string payment_id = 2;
  string payment_preimage = 3;
}

message RejectPaymentResponse {}

message AllowDualFundedChannelRequest {
  Network network = 1;
  string node_id = 2;
  map<string, DualFundAmount> asset_amounts = 3; // key: asset_id
}

message RejectPaymentResponse {}

message AllowDualFundedChannelRequest {
  Network network = 1;
  string node_id = 2;
  map<string, DualFundAmount> asset_amounts = 3; // key: asset_id
}

message AllowDualFundedChannelRequest {
  Network network = 1;
  string node_id = 2;
  map<string, DualFundAmount> asset_amounts = 3; // key: asset_id
}

message InitMarketResponse { optional MarketInfo market_info = 1; }

message GetInitializedMarketsRequest {}

message GetInitializedMarketsResponse { repeated CurrencyInfoPair markets = 1; }

message GetMarketsInfoRequest {}

message GetMarketsInfoResponse { repeated MarketInfo markets = 1; }

message GetMarketInfoRequest {
  OrderbookCurrency first_currency = 1;
  OrderbookCurrency other_currency = 2;
}

message InitMarketResponse { optional MarketInfo market_info = 1; }

message GetInitializedMarketsRequest {}

message GetInitializedMarketsResponse { repeated CurrencyInfoPair markets = 1; }

message GetMarketsInfoRequest {}

message GetMarketsInfoResponse { repeated MarketInfo markets = 1; }

message GetMarketInfoRequest {
  OrderbookCurrency first_currency = 1;
  OrderbookCurrency other_currency = 2;
}

message GetInitializedMarketsRequest {}

message GetInitializedMarketsResponse { repeated CurrencyInfoPair markets = 1; }

message GetMarketsInfoRequest {}

message GetMarketsInfoResponse { repeated MarketInfo markets = 1; }

message GetMarketInfoRequest {
  OrderbookCurrency first_currency = 1;
  OrderbookCurrency other_currency = 2;
}

message GetMarketsInfoResponse { repeated MarketInfo markets = 1; }

message GetMarketInfoRequest {
  OrderbookCurrency first_currency = 1;
  OrderbookCurrency other_currency = 2;
}

message GetMarketsInfoResponse { repeated MarketInfo markets = 1; }

message GetMarketInfoRequest {
  OrderbookCurrency first_currency = 1;
  OrderbookCurrency other_currency = 2;
}

message GetMarketInfoResponse { optional MarketInfo market_info = 1; }

message GetOrderbookBalancesRequest {}

message GetOrderbookBalancesResponse { repeated OrderbookBalance balances = 1; }

message GetOrderbookRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetMarketInfoResponse { optional MarketInfo market_info = 1; }

message GetOrderbookBalancesRequest {}

message GetOrderbookBalancesResponse { repeated OrderbookBalance balances = 1; }

message GetOrderbookRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetOrderbookBalancesRequest {}

message GetOrderbookBalancesResponse { repeated OrderbookBalance balances = 1; }

message GetOrderbookRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetOrderbookResponse { optional Orderbook orderbook = 1; }

message EstimateOrderRequest { OrderVariant order_variant = 1; }

message EstimateOrderResponse { optional OrderMatch order_match = 1; }

message CreateOrderRequest { OrderVariant order_variant = 1; }

message CreateOrderResponse { string order_id = 1; }

message CancelOrderRequest { string order_id = 1; }

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetOrderbookResponse { optional Orderbook orderbook = 1; }

message EstimateOrderRequest { OrderVariant order_variant = 1; }

message EstimateOrderResponse { optional OrderMatch order_match = 1; }

message CreateOrderRequest { OrderVariant order_variant = 1; }

message CreateOrderResponse { string order_id = 1; }

message CancelOrderRequest { string order_id = 1; }

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message EstimateOrderResponse { optional OrderMatch order_match = 1; }

message CreateOrderRequest { OrderVariant order_variant = 1; }

message CreateOrderResponse { string order_id = 1; }

message CancelOrderRequest { string order_id = 1; }

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message EstimateOrderResponse { optional OrderMatch order_match = 1; }

message CreateOrderRequest { OrderVariant order_variant = 1; }

message CreateOrderResponse { string order_id = 1; }

message CancelOrderRequest { string order_id = 1; }

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message CreateOrderResponse { string order_id = 1; }

message CancelOrderRequest { string order_id = 1; }

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message CreateOrderResponse { string order_id = 1; }

message CancelOrderRequest { string order_id = 1; }

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message CancelOrderResponse { bool removed = 1; }

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message CancelAllOrdersRequest {}

message CancelAllOrdersResponse {}

message GetOwnOrdersRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetAllOwnOrdersRequest {}

message GetAllOwnOrdersResponse {
  map<string, Order> orders = 1; // key: order_id
}

message GetOwnOrdersResponse {
  map<string, Order> orders = 1; // key: order_id
}

message GetOwnOrdersResponse {
  map<string, Order> orders = 1; // key: order_id
}

message GetOrderResponse { Order order = 1; }

message GetTradeHistoryRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetOrderResponse { Order order = 1; }

message GetTradeHistoryRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetTradeHistoryRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetAllMarketTradesRequest {}

message GetAllMarketTradesResponse {
  message PairMarketTrades {
    OrderbookCurrency base = 1;
    OrderbookCurrency quote = 2;
    repeated ClientMarketTrade trades = 3;
  }

  repeated PairMarketTrades pair_market_trades = 1;
}

message GetPairMarketTradesRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message GetAllSwapTradesRequest {}

message GetAllSwapTradesResponse {
  message PairSwapTrades {
    OrderbookCurrency from_currency = 1;
    OrderbookCurrency to_currency = 2;
    repeated ClientSwapTrade trades = 3;
  }

  repeated PairSwapTrades pair_swap_trades = 1;
}

message GetPairSwapTradesRequest {
  OrderbookCurrency from_currency = 1;
  OrderbookCurrency to_currency = 2;
}

message SubscribeMarketEventsRequest {
  OrderbookCurrency base = 1;
  OrderbookCurrency quote = 2;
}

message SubscribeDexEventsRequest {}

message GetAssetFiatPriceRequest {
  Network network = 1;
  string asset_id = 2;
  FiatCurrency fiat_currency = 3;
}

message GetAssetFiatPriceBySymbolRequest {
  string asset_symbol = 1;
  FiatCurrency fiat_currency = 2;
}

message GetRentalNodeInfoRequest {}

message RentalAssetConfig {
  Network network = 1;
  string asset_id = 2;
  DecimalString rental_fee_ratio = 3;
  optional string pricing_ticker = 4;
}

message GetRentableAssetInfoRequest {
  Network network = 1;
  string asset_id = 2;
}

message RentChannelResponse {
  string rental_txid = 1;
  string rented_channel_id = 2;
  RentalPayment rental_payment = 3;
}

message RentChannelResponse {
  string rental_txid = 1;
  string rented_channel_id = 2;
  RentalPayment rental_payment = 3;
}

message EstimateRentChannelFeeRequest {
  Network network = 1;
  string asset_id = 2;
  uint64 lifetime_seconds = 3;
  DecimalString amount = 4;
  RentalOption rental_option = 5;
}

message SignMessageResponse { bytes signature = 1; }

message VerifySignatureRequest {
  Network network = 1;
  Message message = 2;
  string public_key = 3;
  bytes signature = 4;
}

message SignMessageResponse { bytes signature = 1; }

message VerifySignatureRequest {
  Network network = 1;
  Message message = 2;
  string public_key = 3;
  bytes signature = 4;
}

message SignMessageResponse { bytes signature = 1; }

message VerifySignatureRequest {
  Network network = 1;
  Message message = 2;
  string public_key = 3;
  bytes signature = 4;
}

message SignMessageResponse { bytes signature = 1; }

message VerifySignatureRequest {
  Network network = 1;
  Message message = 2;
  string public_key = 3;
  bytes signature = 4;
}

message VerifySignatureRequest {
  Network network = 1;
  Message message = 2;
  string public_key = 3;
  bytes signature = 4;
}

message EstimateSwapResponse { optional OrderMatch order_match = 1; }

message SwapRequest {
  OrderbookCurrency sending_currency = 1;
  OrderbookCurrency receiving_currency = 2;
  SwapAmount amount = 3;
}

message EstimateSwapResponse { optional OrderMatch order_match = 1; }

message SwapRequest {
  OrderbookCurrency sending_currency = 1;
  OrderbookCurrency receiving_currency = 2;
  SwapAmount amount = 3;
}

message SwapResponse { string order_id = 1; }

message EstimateSimpleSwapRequest {
  OrderbookCurrency sending_currency = 1;
  OrderbookCurrency receiving_currency = 2;
  SwapAmount amount = 3;
  // The maximum tolerance for the price change in the orderbook when the swap
  // is performed. This is used to make sure that the swap is performed at a
  // price that is not too far from the price intended by the user at the
  // beginning of the operation. The price change tolerance is expressed as
  // (max_tolerated_price - intended_price) / intended_price. This applies to
  // both buys and sells, thus it's an absolute value.
  DecimalString price_change_tolerance = 4;
  // Whether to withdraw back onchain the sent funds at the end of the swap
  // operation.
  bool withdraw_sending_funds = 5;
  // Whether to withdraw back onchain the received funds at the end of the swap
  // operation.
  bool withdraw_receiving_funds = 6;
}

message SwapResponse { string order_id = 1; }

message EstimateSimpleSwapRequest {
  OrderbookCurrency sending_currency = 1;
  OrderbookCurrency receiving_currency = 2;
  SwapAmount amount = 3;
  // The maximum tolerance for the price change in the orderbook when the swap
  // is performed. This is used to make sure that the swap is performed at a
  // price that is not too far from the price intended by the user at the
  // beginning of the operation. The price change tolerance is expressed as
  // (max_tolerated_price - intended_price) / intended_price. This applies to
  // both buys and sells, thus it's an absolute value.
  DecimalString price_change_tolerance = 4;
  // Whether to withdraw back onchain the sent funds at the end of the swap
  // operation.
  bool withdraw_sending_funds = 5;
  // Whether to withdraw back onchain the received funds at the end of the swap
  // operation.
  bool withdraw_receiving_funds = 6;
}

message EstimateSimpleSwapRequest {
  OrderbookCurrency sending_currency = 1;
  OrderbookCurrency receiving_currency = 2;
  SwapAmount amount = 3;
  // The maximum tolerance for the price change in the orderbook when the swap
  // is performed. This is used to make sure that the swap is performed at a
  // price that is not too far from the price intended by the user at the
  // beginning of the operation. The price change tolerance is expressed as
  // (max_tolerated_price - intended_price) / intended_price. This applies to
  // both buys and sells, thus it's an absolute value.
  DecimalString price_change_tolerance = 4;
  // Whether to withdraw back onchain the sent funds at the end of the swap
  // operation.
  bool withdraw_sending_funds = 5;
  // Whether to withdraw back onchain the received funds at the end of the swap
  // operation.
  bool withdraw_receiving_funds = 6;
}

message SimpleSwapResponse { SimpleSwapOutput output = 1; }

message SimpleSwapUpdate {
  // The sending channel is being funded, either by opening a new channel or
  // depositing in an existing one.
  message FundingSendingChannel {
    string txid = 1;
    string channel_id = 2;
    DecimalString amount = 3;
    bool is_opening = 4;
  }

  // The receiving channel is being rented.
  message RentingReceivingChannel {
    string txid = 1;
    string channel_id = 2;
    DecimalString amount = 3;
  }

  // The channels are being dual-funded.
  message DualFundingChannel {
    string txid = 1;
    string channel_id = 2;
    DecimalString self_amount = 3;
    DecimalString counterparty_amount = 4;
    bool is_opening = 5;
  }

  // The sending channel is ready for the swap.
  message SendingChannelReady { string channel_id = 1; }

  // The receiving channel is ready for the swap.
  message ReceivingChannelReady { string channel_id = 1; }

  // The dual-funded channel is ready for the swap.
  message DualFundChannelReady { string channel_id = 1; }

  // Waiting for the balances to be ready for the swap.
  message WaitingForBalances {
    DecimalString needed_sending = 1;
    DecimalString needed_receiving = 2;
  }

  // The balances are ready for the swap.
  message BalancesReady {}

  // The swap order has been created.
  message OrderCreated { string order_id = 1; }

  // The swap order has been completed.
  message OrderCompleted {
    string order_id = 1;
    DecimalString sent_amount = 2;
    DecimalString received_amount = 3;
  }

  // The sending funds are being withdrawn.
  message WithdrawingSendingFunds {
    repeated string txids = 1;
    DecimalString self_amount = 2;
    DecimalString counterparty_amount = 3;
  }

  // The receiving funds are being withdrawn.
  message WithdrawingReceivingFunds {
    repeated string txids = 1;
    DecimalString self_amount = 2;
    DecimalString counterparty_amount = 3;
  }

  // The dual-funded funds are being withdrawn.
  message WithdrawingDualFundedFunds {
    repeated string txids = 1;
    DecimalString sending_self_amount = 2;
    DecimalString sending_counterparty_amount = 3;
    DecimalString receiving_self_amount = 4;
    DecimalString receiving_counterparty_amount = 5;
  }

  // The sending funds have been withdrawn.
  message SendingFundsWithdrawn {}

  // The receiving funds have been withdrawn.
  message ReceivingFundsWithdrawn {}

  // The dual-funded funds have been withdrawn.
  message DualFundedFundsWithdrawn {}

  // The simple swap has been completed.
  message SimpleSwapCompleted {}

  // An error occurred during the simple swap.
  message SimpleSwapError { string error = 1; }

  google.protobuf.Timestamp timestamp = 1;
  string simple_swap_id = 2;
  oneof update {
    FundingSendingChannel funding_sending_channel = 3;
    RentingReceivingChannel renting_receiving_channel = 4;
    DualFundingChannel dual_funding_channel = 5;
    SendingChannelReady sending_channel_ready = 6;
    ReceivingChannelReady receiving_channel_ready = 7;
    DualFundChannelReady dual_fund_channel_ready = 8;
    WaitingForBalances waiting_for_balances = 9;
    BalancesReady balances_ready = 10;
    OrderCreated order_created = 11;
    OrderCompleted order_completed = 12;
    WithdrawingSendingFunds withdrawing_sending_funds = 13;
    WithdrawingReceivingFunds withdrawing_receiving_funds = 14;
    WithdrawingDualFundedFunds withdrawing_dual_funded_funds = 15;
    SendingFundsWithdrawn sending_funds_withdrawn = 16;
    ReceivingFundsWithdrawn receiving_funds_withdrawn = 17;
    DualFundedFundsWithdrawn dual_funded_funds_withdrawn = 18;
    SimpleSwapCompleted simple_swap_completed = 19;
    SimpleSwapError simple_swap_error = 20;
  }
}

message SimpleSwapResponse { SimpleSwapOutput output = 1; }

message SimpleSwapUpdate {
  // The sending channel is being funded, either by opening a new channel or
  // depositing in an existing one.
  message FundingSendingChannel {
    string txid = 1;
    string channel_id = 2;
    DecimalString amount = 3;
    bool is_opening = 4;
  }

  // The receiving channel is being rented.
  message RentingReceivingChannel {
    string txid = 1;
    string channel_id = 2;
    DecimalString amount = 3;
  }

  // The channels are being dual-funded.
  message DualFundingChannel {
    string txid = 1;
    string channel_id = 2;
    DecimalString self_amount = 3;
    DecimalString counterparty_amount = 4;
    bool is_opening = 5;
  }

  // The sending channel is ready for the swap.
  message SendingChannelReady { string channel_id = 1; }

  // The receiving channel is ready for the swap.
  message ReceivingChannelReady { string channel_id = 1; }

  // The dual-funded channel is ready for the swap.
  message DualFundChannelReady { string channel_id = 1; }

  // Waiting for the balances to be ready for the swap.
  message WaitingForBalances {
    DecimalString needed_sending = 1;
    DecimalString needed_receiving = 2;
  }

  // The balances are ready for the swap.
  message BalancesReady {}

  // The swap order has been created.
  message OrderCreated { string order_id = 1; }

  // The swap order has been completed.
  message OrderCompleted {
    string order_id = 1;
    DecimalString sent_amount = 2;
    DecimalString received_amount = 3;
  }

  // The sending funds are being withdrawn.
  message WithdrawingSendingFunds {
    repeated string txids = 1;
    DecimalString self_amount = 2;
    DecimalString counterparty_amount = 3;
  }

  // The receiving funds are being withdrawn.
  message WithdrawingReceivingFunds {
    repeated string txids = 1;
    DecimalString self_amount = 2;
    DecimalString counterparty_amount = 3;
  }

  // The dual-funded funds are being withdrawn.
  message WithdrawingDualFundedFunds {
    repeated string txids = 1;
    DecimalString sending_self_amount = 2;
    DecimalString sending_counterparty_amount = 3;
    DecimalString receiving_self_amount = 4;
    DecimalString receiving_counterparty_amount = 5;
  }

  // The sending funds have been withdrawn.
  message SendingFundsWithdrawn {}

  // The receiving funds have been withdrawn.
  message ReceivingFundsWithdrawn {}

  // The dual-funded funds have been withdrawn.
  message DualFundedFundsWithdrawn {}

  // The simple swap has been completed.
  message SimpleSwapCompleted {}

  // An error occurred during the simple swap.
  message SimpleSwapError { string error = 1; }

  google.protobuf.Timestamp timestamp = 1;
  string simple_swap_id = 2;
  oneof update {
    FundingSendingChannel funding_sending_channel = 3;
    RentingReceivingChannel renting_receiving_channel = 4;
    DualFundingChannel dual_funding_channel = 5;
    SendingChannelReady sending_channel_ready = 6;
    ReceivingChannelReady receiving_channel_ready = 7;
    DualFundChannelReady dual_fund_channel_ready = 8;
    WaitingForBalances waiting_for_balances = 9;
    BalancesReady balances_ready = 10;
    OrderCreated order_created = 11;
    OrderCompleted order_completed = 12;
    WithdrawingSendingFunds withdrawing_sending_funds = 13;
    WithdrawingReceivingFunds withdrawing_receiving_funds = 14;
    WithdrawingDualFundedFunds withdrawing_dual_funded_funds = 15;
    SendingFundsWithdrawn sending_funds_withdrawn = 16;
    ReceivingFundsWithdrawn receiving_funds_withdrawn = 17;
    DualFundedFundsWithdrawn dual_funded_funds_withdrawn = 18;
    SimpleSwapCompleted simple_swap_completed = 19;
    SimpleSwapError simple_swap_error = 20;
  }
}

message SubscribeSimpleSwapsRequest {}

message GetBalancesResponse {
  map<string, Balance> balances = 1; // key: asset_id
}

message GetBalancesResponse {
  map<string, Balance> balances = 1; // key: asset_id
}

message GetBalanceResponse {
  Balance balance = 1; // onchain and offchain balances for the specified asset
}

message GetBalanceResponse {
  Balance balance = 1; // onchain and offchain balances for the specified asset
}

message GetTransactionsRequest { Network network = 1; }

message GetTransactionsResponse { repeated Transaction transactions = 1; }

message GetTransactionRequest {
  Network network = 1;
  string txid = 2;
}

message GetTransactionResponse { Transaction transaction = 1; }

message GetTransactionResponse { Transaction transaction = 1; }

message GetNodeIdResponse { string node_id = 1; }

message GetChannelsRequest { Network network = 1; }

message GetChannelsResponse { repeated Channel channels = 1; }

message GetChannelsWithCounterpartyRequest {
  Network network = 1;
  string counterparty_pubkey = 2;
}

message GetNodeIdResponse { string node_id = 1; }

message GetChannelsRequest { Network network = 1; }

message GetChannelsResponse { repeated Channel channels = 1; }

message GetChannelsWithCounterpartyRequest {
  Network network = 1;
  string counterparty_pubkey = 2;
}

message GetChannelsResponse { repeated Channel channels = 1; }

message GetChannelsWithCounterpartyRequest {
  Network network = 1;
  string counterparty_pubkey = 2;
}

message GetChannelsResponse { repeated Channel channels = 1; }

message GetChannelsWithCounterpartyRequest {
  Network network = 1;
  string counterparty_pubkey = 2;
}

message GetChannelsWithCounterpartyRequest {
  Network network = 1;
  string counterparty_pubkey = 2;
}

message GetChannelResponse { Channel channel = 1; }

message GetPaymentsRequest { Network network = 1; }

message GetPaymentsResponse { repeated Payment payments = 1; }

message GetPaymentRequest {
  Network network = 1;
  string payment_id = 2;
}

message GetChannelResponse { Channel channel = 1; }

message GetPaymentsRequest { Network network = 1; }

message GetPaymentsResponse { repeated Payment payments = 1; }

message GetPaymentRequest {
  Network network = 1;
  string payment_id = 2;
}

message GetPaymentsResponse { repeated Payment payments = 1; }

message GetPaymentRequest {
  Network network = 1;
  string payment_id = 2;
}

message GetPaymentsResponse { repeated Payment payments = 1; }

message GetPaymentRequest {
  Network network = 1;
  string payment_id = 2;
}

message GetPaymentResponse { Payment payment = 1; }

message GetPaymentResponse { Payment payment = 1; }