Merge pull request #16 from asdfspace/order-states

added order states
This commit is contained in:
2023-02-01 07:30:03 -05:00
committed by GitHub

View File

@@ -80,4 +80,21 @@ Get information about a channel order
| node_connection_info | The node_connection_info for the node to open the channel to | string |
| channel_open_tx | The txid of the channel funding tx once it is broadcast | string |
| state | The state of the order | string |
| onchain_payments | A list of payments received to btc_address on-chain | object[] |
| onchain_payments | A list of payments received to btc_address on-chain | object[] |
###### Order state enum
| State | Description |
|---------------- |--------------------------------------------------------------------------------------- |
| CREATED | The order has been created but the user hasn't paid yet. |
| UNDER_FUNDED | Funding received but under paid. |
| PENDING | Order is paid but the channel has not been opened yet. |
| OPENING | The opening transaction has been broadcasted. 0conf might skip directly to OPENED. |
| OPENED | Channel is open and has the necessary block confirmations. |
| CLOSING | The closing transaction has been broadcasted. |
| CLOSED | Channel is closed and has the necessary block confirmations. |
| FAILED | Any error. For example, the LSP couldn't connect to the target node. |
| REFUNDED | Payment has been refunded. |
| OFFER_EXPIRED | Order has not been paid and offer has therefore expired. |