package autoswaprpc

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ExecuteRecommendations (ExecuteRecommendationsRequest, ExecuteRecommendationsResponse)

  autoswaprpc.proto:20

  Executes recommendations previously returned by `GetRecommendations`. Intended to be used when autoswap is fully configured but not enabled to allow for manual approval.

  message ExecuteRecommendationsRequest

  autoswaprpc.proto:102

  • repeated LightningRecommendation lightning = 1

  • repeated ChainRecommendation chain = 2

  • optional bool force = 3

    Forcefully execute all recommendations, even ones that have dismissal reasons.

  message ExecuteRecommendationsResponse

  autoswaprpc.proto:108

  (message has no fields)

• rpc GetConfig (GetConfigRequest, Config)

  autoswaprpc.proto:41

  Returns the currently used configuration.

  message GetConfigRequest

  autoswaprpc.proto:124

  (message has no fields)

• rpc GetRecommendations (GetRecommendationsRequest, GetRecommendationsResponse)

  autoswaprpc.proto:14

  Returns a list of swaps which are currently recommended by autoswap. Also works when autoswap is not running.

  message GetRecommendationsRequest

  autoswaprpc.proto:50

  (message has no fields)

  message GetRecommendationsResponse

  autoswaprpc.proto:97

  • repeated LightningRecommendation lightning = 1

  • repeated ChainRecommendation chain = 2

• rpc GetStatus (GetStatusRequest, GetStatusResponse)

  autoswaprpc.proto:25

  Returns the current budget of autoswap and some relevant stats.

  message GetStatusRequest

  autoswaprpc.proto:110

  (message has no fields)

  message GetStatusResponse

  autoswaprpc.proto:119

  • optional Status lightning = 1

  • optional Status chain = 2

• rpc ReloadConfig (google.protobuf.Empty, Config)

  autoswaprpc.proto:46

  Reloads the configuration from disk.

• rpc UpdateChainConfig (UpdateChainConfigRequest, Config)

  autoswaprpc.proto:36

  Updates the chain configuration entirely or partially. Autoswap will reload the configuration after this call.

  message UpdateChainConfigRequest

  autoswaprpc.proto:132

  • optional ChainConfig config = 1

  • optional google.protobuf.FieldMask field_mask = 2

  • optional bool reset = 3

• rpc UpdateLightningConfig (UpdateLightningConfigRequest, Config)

  autoswaprpc.proto:31

  Updates the lightning configuration entirely or partially. Autoswap will reload the configuration after this call.

  message UpdateLightningConfigRequest

  autoswaprpc.proto:126

  • optional LightningConfig config = 1

  • optional google.protobuf.FieldMask field_mask = 2

  • optional bool reset = 3

Used in: Status

• uint64 total = 1

• uint64 remaining = 2

• int64 start_date = 3

• int64 end_date = 4

• optional boltzrpc.SwapStats stats = 5

Used in: Config, UpdateChainConfigRequest

• bool enabled = 1

• string from_wallet = 2

• string to_wallet = 3

• string to_address = 4

• uint64 max_balance = 5

• uint64 reserve_balance = 10

• float max_fee_percent = 6

• uint64 budget = 7

• uint64 budget_interval = 8

• optional string tenant = 9

Used in: ExecuteRecommendationsRequest, GetRecommendationsResponse

• optional ChainSwap swap = 1

  Populated when a swap is recommended based on the configured `wallet_balance` of the configured `from_wallet` exceeds the currently configured `max_balance`

• optional boltzrpc.Balance wallet_balance = 2

• uint64 max_balance = 3

Used in: ChainRecommendation

• uint64 amount = 1

• uint64 fee_estimate = 2

• repeated string dismissed_reasons = 3

  Reasons for which the swap is not being executed

Used as response type in: AutoSwap.GetConfig, AutoSwap.ReloadConfig, AutoSwap.UpdateChainConfig, AutoSwap.UpdateLightningConfig

• repeated ChainConfig chain = 1

• repeated LightningConfig lightning = 2

Used in: Config, UpdateLightningConfigRequest

• bool enabled = 1

• uint64 channel_poll_interval = 2

• string static_address = 3

• uint64 outbound_balance = 4

• uint64 inbound_balance = 5

• float outbound_balance_percent = 6

• float inbound_balance_percent = 7

• float max_fee_percent = 8

• bool accept_zero_conf = 9

• uint64 failure_backoff = 10

• uint64 budget = 11

• uint64 budget_interval = 12

• boltzrpc.Currency currency = 13

• string swap_type = 14

• bool per_channel = 15

• string wallet = 16

• uint64 max_swap_amount = 17

• optional string tenant = 18

Used in: ExecuteRecommendationsRequest, GetRecommendationsResponse

• optional LightningSwap swap = 1

  Populated when a swap is recommended for the associated `channel`, otherwise, the current balances are below the configured thresholds

• optional boltzrpc.LightningChannel channel = 2

• optional LightningThresholds thresholds = 3

  the thresholds for a swap to be recommended for the `channel`

Used in: LightningRecommendation

• uint64 amount = 1

• uint64 fee_estimate = 2

• boltzrpc.SwapType type = 3

• repeated string dismissed_reasons = 4

  Reasons for which the swap is not being executed

Used in: LightningRecommendation

• optional uint64 inbound = 1

• optional uint64 outbound = 2

Used in: GetStatusResponse

• bool running = 1

• optional string error = 2

• optional Budget budget = 3

• string description = 4