Add docs for lightning

docs/.vuepress/atomicDEX-sidebar.js

@@ -12,6 +12,10 @@ let atomicDEXsidebar = {
           "/basic-docs/atomicdex/atomicdex-methods.md",
           "RPC Methods for AtomicDEX",
         ],
+        [
+          "/basic-docs/atomicdex/common-structures.md",
+          "Common structure objects in AtomicDEX",
+        ],
         {
           title: "Setup",
           collapsable: true,
@@ -46,6 +50,10 @@ let atomicDEXsidebar = {
               "/basic-docs/atomicdex/atomicdex-tutorials/atomicdex-metrics.md",
               "DEX Metrics",
             ],
+            [
+              "/basic-docs/atomicdex/atomicdex-tutorials/listing-a-coin-on-atomicdex.md",
+              "Adding a new coin to the AtomicDEX-API",
+            ],
             [
               "/basic-docs/atomicdex/atomicdex-tutorials/how-to-become-a-liquidity-provider.md",
               "How to Become a Liquidity Provider",
@@ -362,6 +370,54 @@ let atomicDEXsidebar = {
             ["/basic-docs/atomicdex-api-20-dev/get_current_mtp.md", "get_current_mtp"]
           ]
         },
+        {
+          title: "Lightning",
+          collapsable: true,
+          children: [
+            {
+              title: "Enable",
+              collapsable: true,
+              children: [
+                ["/basic-docs/atomicdex-api-20-dev/task_enable_lightning_init.md", "task_enable_lightning_init"],
+                ["/basic-docs/atomicdex-api-20-dev/task_enable_lightning_status.md", "task_enable_lightning_status"],
+                ["/basic-docs/atomicdex-api-20-dev/task_enable_lightning_cancel.md", "task_enable_lightning_cancel"],
+              ]
+            },
+            {
+              title: "Channels",
+              collapsable: true,
+              children: [
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_get_channel_details.md", "get_channel_details"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_update_channel.md", "update_channel"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_open_channel.md", "open_channel"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_get_claimable_balances.md", "get_claimable_balances"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_list_closed_channels_by_filter.md", "list_closed_channels_by_filter"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_list_open_channels_by_filter.md", "list_open_channels_by_filter"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_channels_close_channel.md", "close_channel"]
+              ]
+            },
+            {
+              title: "Nodes",
+              collapsable: true,
+              children: [
+                ["/basic-docs/atomicdex-api-20-dev/lightning_nodes_add_trusted_node.md", "add_trusted_node"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_nodes_remove_trusted_node.md", "remove_trusted_node"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_nodes_list_trusted_nodes.md", "list_trusted_nodes"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_nodes_connect_to_node.md", "connect_to_node"],
+              ]
+            },
+            {
+              title: "Payments",
+              collapsable: true,
+              children: [
+                ["/basic-docs/atomicdex-api-20-dev/lightning_payments_generate_invoice.md", "generate_invoice"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_payments_get_payment_details.md", "get_payments_details"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_payments_list_payments_by_filter.md", "list_payments_by_filter"],
+                ["/basic-docs/atomicdex-api-20-dev/lightning_payments_send_payment.md", "send_payment"]
+              ]
+            }
+          ]
+        },
         {
           title: "HD Wallet Tasks",
           collapsable: true,

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_close_channel.md

@@ -0,0 +1,22 @@
+### lightning\:\:channels\:\:close_channel
+
+| Parameter            | Type    | Description |
+|----------------------|---------|-------------|
+| coin                 | string  | A coin ticker          |
+| rpc_channel_id       | integer | Channel ID you would like to see the details of |
+| force_close          | boolean | Optional, defaults to `false`. If `true`, will force closing the channel |
+
+
+```json
+{
+    "userpass": "{{userpass}}",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::close_channel",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "rpc_channel_id": 1,
+        "force_close": false
+    },
+    "id": 8
+}
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_get_channel_details.md

@@ -0,0 +1,21 @@
+### lightning\:\:channels\:\:get_channel_details
+
+| Parameter            | Type    | Description |
+|----------------------|---------|-------------|
+| coin                 | string  | A coin ticker          |
+| rpc_channel_id       | integer | Channel ID you would like to see the details of |
+
+
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::get_channel_details",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "rpc_channel_id": 1
+    },
+    "id": 54
+}
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_get_claimable_balances.md

@@ -0,0 +1,20 @@
+### lightning\:\:channels\:\:get_claimable_balances
+
+| Parameter                      | Type    | Description |
+|--------------------------------|---------|-------------|
+| coin                           | string  | A coin ticker          |
+| include_open_channels_balances | boolean | `true` to include balances from open channels, `false` if not |
+
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::get_claimable_balances",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "include_open_channels_balances": false
+    },
+    "id": 762
+}
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_list_closed_channels_by_filter.md

@@ -0,0 +1,80 @@
+### lightning\:\:channels\:\:list_closed_channels_by_filter
+
+| Parameter            | Type    | Description |
+|----------------------|---------|-------------|
+| coin                 | string  | The ticker of the coin you would like to view closed channels for  |
+| filter               | object  | [Lightning closed channels filter](/basic-docs/atomicdex/common-structures.html#Lightning_closed_channel_filter) (optional)      |
+| limit                | string  | Max number of records to return (optional)                         |
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::list_closed_channels_by_filter",
+    "params": {
+        "coin": "tBTC-TEST-lightning"
+    },
+    "id": 55
+}
+```
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::list_closed_channels_by_filter",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "filter": {
+                "channel_id": null,
+                "counterparty_node_id": null,
+                "funding_tx": null,
+                "from_funding_value": null,
+                "to_funding_value": null,
+                "closing_tx": null,
+                "closure_reason": null,
+                "claiming_tx": null,
+                "from_claimed_balance": null,
+                "to_claimed_balance": null,
+                "channel_type": null,
+                "channel_visibility": null
+        },
+        "limit": 10,
+        "paging_options": {
+           "PageNumber": 1
+        }
+    },
+    "id": 55
+}
+
+```
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::list_closed_channels_by_filter",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "filter": {
+                "channel_id": null,
+                "counterparty_node_id": null,
+                "funding_tx": null,
+                "from_funding_value": null,
+                "to_funding_value": null,
+                "closing_tx": null,
+                "closure_reason": null,
+                "claiming_tx": null,
+                "from_claimed_balance": null,
+                "to_claimed_balance": null,
+                "channel_type": null,
+                "channel_visibility": null
+        },
+        "limit": 10,
+        "paging_options": {
+           "FromId": 4
+        }
+    },
+    "id": 55
+}
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_list_open_channels_by_filter.md

@@ -0,0 +1,84 @@
+### lightning\:\:channels\:\:list_open_channels_by_filter
+
+| Parameter            | Type    | Description |
+|----------------------|---------|-------------|
+| coin                 | string  | The ticker of the coin you would like to view closed channels for  |
+| filter               | object  | [Lightning open channels filter](/basic-docs/atomicdex/common-structures.html#Lightning_open_channels_filter) (optional)      |
+| limit                | string  | Max number of records to return (optional)                         |
+
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::list_open_channels_by_filter",
+    "params": {
+        "coin": "tBTC-TEST-lightning"
+    },
+    "id": 55
+}
+```
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::list_open_channels_by_filter",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "filter": {
+                "channel_id": null,
+                "counterparty_node_id": null,
+                "funding_tx": null,
+                "from_funding_value_sats": null,
+                "to_funding_value_sats": null,
+                "is_outbound": null,
+                "from_balance_msat": null,
+                "to_balance_msat": null,
+                "from_outbound_capacity_msat": null,
+                "to_outbound_capacity_msat": null,
+                "from_inbound_capacity_msat": null,
+                "to_inbound_capacity_msat": null,
+                "confirmed": null,
+                "is_usable": null,
+                "is_public": null
+        },
+        "limit": 10,
+        "paging_options": {
+           "PageNumber": 1
+        }
+    },
+    "id": 55
+}
+
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::list_open_channels_by_filter",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "filter": {
+                "channel_id": null,
+                "counterparty_node_id": null,
+                "funding_tx": null,
+                "from_funding_value_sats": null,
+                "to_funding_value_sats": null,
+                "is_outbound": null,
+                "from_balance_msat": null,
+                "to_balance_msat": null,
+                "from_outbound_capacity_msat": null,
+                "to_outbound_capacity_msat": null,
+                "from_inbound_capacity_msat": null,
+                "to_inbound_capacity_msat": null,
+                "confirmed": null,
+                "is_usable": null,
+                "is_public": null
+        },
+        "limit": 10,
+        "paging_options": {
+           "FromId": 4
+        }
+    },
+    "id": 55
+}
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_open_channel.md

@@ -0,0 +1,34 @@
+
+```json
+{
+    "userpass": "{{userpass}}",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::open_channel",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "node_address": "038863cf8ab91046230f561cd5b386cbff8309fa02e3f0c3ed161a3aeb64a643b9@203.132.94.196:9735",
+        "amount": {
+            "type": "Exact", // Accepted values: "Exact", "Max"
+            "value": 0.004 // Required only if: "type": "Exact"
+        }
+        // "push_msat": 0,
+        // "channel_options": {
+        //     // "proportional_fee_in_millionths_sats": 0, // Default: Coin Config
+        //     // "base_fee_msat": 1000, // Default: Coin Config
+        //     // "cltv_expiry_delta": 72, // Default: Coin Config
+        //     // "max_dust_htlc_exposure_msat": 5000000, // Default: Coin Config
+        //     // "force_close_avoidance_max_fee_satoshis": 1000 // Default: Coin Config
+        // },
+        // "channel_configs" : {
+        //     // "counterparty_locktime": 144, // Default: Coin Config
+        //     // "our_htlc_minimum_msat": 1, // Default: Coin Config
+        //     // "negotiate_scid_privacy": false, // Default: Coin Config
+        //     // "max_inbound_in_flight_htlc_percent": 10, // Default: Coin Config
+        //     // "announced_channel": false, // Default: Coin Config
+        //     // "commit_upfront_shutdown_pubkey": true // Default: Coin Config
+        // }
+    }
+    // "id": null // Accepted values: Integers
+}
+
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_channels_update_channel.md

@@ -0,0 +1,21 @@
+
+```json
+{
+    "userpass": "{{userpass}}",
+    "mmrpc": "2.0",
+    "method": "lightning::channels::update_channel",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "rpc_channel_id": 1,
+        "channel_options": {
+            // "proportional_fee_in_millionths_sats": 0, // Default: Coin Config
+            // "base_fee_msat": 1000, // Default: Coin Config
+            // "cltv_expiry_delta": 72, // Default: Coin Config
+            // "max_dust_htlc_exposure_msat": 5000000, // Default: Coin Config
+            // "force_close_avoidance_max_fee_satoshis": 1000 // Default: Coin Config
+        }
+    },
+    "id": 1
+}
+
+```

docs/basic-docs/atomicdex-api-20-dev/lightning_nodes_add_trusted_node.md

@@ -0,0 +1,20 @@
+### lightning\:\:nodes\:\:add_trusted_node
+
+| Parameter            | Type    | Description |
+|----------------------|---------|-------------|
+| coin                 | string  | A coin ticker          |
+| node_id              | string  | ID of node you would like to add to your trusted list |
+
+
+```json
+{
+    "userpass": "userpass",
+    "mmrpc": "2.0",
+    "method": "lightning::nodes::add_trusted_node",
+    "params": {
+        "coin": "tBTC-TEST-lightning",
+        "node_id": "038863cf8ab91046230f561cd5b386cbff8309fa02e3f0c3ed161a3aeb64a643b9"
+    },
+    "id": 56
+}
+```