> For the complete documentation index, see [llms.txt](https://dicdoc.gitbook.io/doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dicdoc.gitbook.io/doc/smart-chain-api/network.md).

# Network

### addnode

**addnode "node" "add|remove|onetry"**

The `addnode` method attempts to add or remove a node from the addnode list, or to make a single attempt to connect to a node.

#### Arguments

| Name      | Type               | Description                                                                                                                      |
| --------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| "node"    | (string, required) | the node (see [getpeerinfo](https://app.gitbook.com/basic-docs/smart-chains/smart-chain-api/network.html#getpeerinfo) for nodes) |
| "command" | (string, required) | 'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once          |

#### Response

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

**📌 Examples**

Command:

```
./komodo-cli addnode "192.168.0.6:8233" "onetry"
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addnode", "params": ["192.168.0.6:8233", "onetry"] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

### clearbanned

**clearbanned**

The `clearbanned` method clears all banned IPs.

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

**📌 Examples**

Command:

```
./komodo-cli clearbanned
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "clearbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

### disconnectnode

**disconnectnode "node"**

The `disconnectnode` method instructs the daemon to immediately disconnect from the specified node.

Use `getpeerinfo` to determine the result.

#### Arguments

| Name   | Type               | Description                                                                                                                                |
| ------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| "node" | (string, required) | the node's address (see [getpeerinfo](https://app.gitbook.com/basic-docs/smart-chains/smart-chain-api/network.html#getpeerinfo) for nodes) |

#### Response

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

**📌 Examples**

Command:

```
./komodo-cli disconnectnode "192.168.0.6:8233"
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "disconnectnode", "params": ["192.168.0.6:8233"] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

### getaddednodeinfo

**getaddednodeinfo dns ( "node" )**

The `getaddednodeinfo` method returns information about the given added node, or all added nodes.

If `dns` is set to `false`, only a list of added nodes is returned. Otherwise, connection information is also provided.

::: tip Nodes added via **onetry** are not listed here. :::

#### Arguments

| Name   | Type                | Description                                                                                               |
| ------ | ------------------- | --------------------------------------------------------------------------------------------------------- |
| dns    | (boolean, required) | if false, only a list of added nodes will be provided; otherwise, connection information is also provided |
| "node" | (string, optional)  | if provided, the method returns information about this specific node; otherwise, all nodes are returned   |

#### Response

| Name                   | Type             | Description                                                      |
| ---------------------- | ---------------- | ---------------------------------------------------------------- |
| "addednode"            | (string)         | the node ip address                                              |
| "connected"            | (boolean)        | if connected                                                     |
| "addresses" : \[ ... ] | (array of jsons) |                                                                  |
| "address"              | (string)         | the server host and port                                         |
| "connected"            | (string)         | "connected" accepts two possible values: "inbound" or "outbound" |

**📌 Examples**

Command:

```
./komodo-cli getaddednodeinfo true
```

\<collapse-text hidden title="Response">

```
[
  {
    "addednode": "78.47.196.146",
    "connected": true,
    "addresses": [
      {
        "address": "78.47.196.146:7770",
        "connected": "outbound"
      }
    ]
  }
]
```

\</collapse-text>

Command:

```
./komodo-cli getaddednodeinfo true "78.47.205.239"
```

\<collapse-text hidden title="Response">

```
[
  {
    "addednode": "78.47.205.239",
    "connected": true,
    "addresses": [
      {
        "address": "78.47.205.239:7770",
        "connected": "outbound"
      }
    ]
  }
]
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddednodeinfo", "params": [true, "78.47.205.239"] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": [
    {
      "addednode": "78.47.205.239",
      "connected": true,
      "addresses": [
        {
          "address": "78.47.205.239:7770",
          "connected": "outbound"
        }
      ]
    }
  ],
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### getconnectioncount

**getconnectioncount**

The `getconnectioncount` method returns the number of connections to other nodes.

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name | Type      | Description          |
| ---- | --------- | -------------------- |
| n    | (numeric) | the connection count |

**📌 Examples**

Command:

```
./komodo-cli getconnectioncount
```

\<collapse-text hidden title="Response">

```
10
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getconnectioncount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": 10,
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### getdeprecationinfo

**getdeprecationinfo**

The `getdeprecationinfo` method returns an object containing current version and deprecation block height.

::: tip This method is applicable only to the DIC main net. :::

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name                | Type      | Description                                                                                                                                      |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| "version"           | (numeric) | the server version                                                                                                                               |
| "subversion"        | (string)  | the server sub-version string (i.e. "/MagicBean:x.y.z\[-v]/")                                                                                    |
| "deprecationheight" | (numeric) | the block height at which this version will deprecate and shut down (unless [disabledeprecation](https://z.cash/blog/new-release-1-1-2/) is set) |

**📌 Examples**

Command:

```
./komodo-cli getdeprecationinfo
```

\<collapse-text hidden title="Response">

```
{
  "version": 1001550,
  "subversion": "/MagicBean:1.0.15/",
  "deprecationheight": 1400000
}
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getdeprecationinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": {
    "version": 1001550,
    "subversion": "/MagicBean:1.0.15/",
    "deprecationheight": 1400000
  },
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### getnettotals

**getnettotals**

The `getnettotals` method returns information about network traffic, including bytes in, bytes out, and current time.

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name             | Type      | Description          |
| ---------------- | --------- | -------------------- |
| "totalbytesrecv" | (numeric) | total bytes received |
| "totalbytessent" | (numeric) | total bytes sent     |
| "timemillis"     | (numeric) | total cpu time       |

**📌 Examples**

Command:

```
./komodo-cli getnettotals
```

\<collapse-text hidden title="Response">

```
{
  "totalbytesrecv": 29853501,
  "totalbytessent": 15589555,
  "timemillis": 1536821874559
}
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnettotals", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": {
    "totalbytesrecv": 29872297,
    "totalbytessent": 15650741,
    "timemillis": 1536821938902
  },
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### getnetworkinfo

**getnetworkinfo**

The `getnetworkinfo` method returns an object containing various state info regarding p2p networking.

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name                       | Type             | Description                                                                          |
| -------------------------- | ---------------- | ------------------------------------------------------------------------------------ |
| "version"                  | (numeric)        | the server version                                                                   |
| "subversion"               | (string)         | the server subversion string (i.e. "/MagicBean:x.y.z\[-v]/")                         |
| "protocolversion"          | (numeric)        | the protocol version                                                                 |
| "localservices"            | (string)         | the services we offer to the network                                                 |
| "timeoffset"               | (numeric)        | the time offset                                                                      |
| "connections"              | (numeric)        | the number of connections                                                            |
| "networks": \[ ... ]       | (array of jsons) | information per network                                                              |
| "name"                     | (string)         | network (ipv4, ipv6 or onion)                                                        |
| "limited"                  | (boolean)        | whether the network is limited using -onlynet                                        |
| "reachable"                | (boolean)        | whether the network is reachable                                                     |
| "proxy"                    | (string)         | (submitted as "host:port") the proxy that is used for this network, or empty if none |
| "relayfee"                 | (numeric)        | minimum relay fee for non-free transactions in COIN/kB                               |
| "localaddresses": \[ ... ] | (array of jsons) | list of local addresses                                                              |
| "address"                  | (string)         | network address                                                                      |
| "port"                     | (numeric)        | network port                                                                         |
| "score"                    | (numeric)        | relative score                                                                       |
| "warnings"                 | (string)         | any network warnings (such as alert messages)                                        |

**📌 Examples**

Command:

```
./komodo-cli getnetworkinfo
```

\<collapse-text hidden title="Response">

```
{
  "version": 1001550,
  "subversion": "/MagicBean:1.0.15/",
  "protocolversion": 170003,
  "localservices": "0000000000000001",
  "timeoffset": -1,
  "connections": 10,
  "networks": [
    {
      "name": "ipv4",
      "limited": false,
      "reachable": true,
      "proxy": "",
      "proxy_randomize_credentials": false
    },
    {
      "name": "ipv6",
      "limited": false,
      "reachable": true,
      "proxy": "",
      "proxy_randomize_credentials": false
    },
    {
      "name": "onion",
      "limited": true,
      "reachable": false,
      "proxy": "",
      "proxy_randomize_credentials": false
    }
  ],
  "relayfee": 0.000001,
  "localaddresses": [],
  "warnings": ""
}
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnetworkinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": {
    "version": 1001550,
    "subversion": "/MagicBean:1.0.15/",
    "protocolversion": 170003,
    "localservices": "0000000000000001",
    "timeoffset": -1,
    "connections": 10,
    "networks": [
      {
        "name": "ipv4",
        "limited": false,
        "reachable": true,
        "proxy": "",
        "proxy_randomize_credentials": false
      },
      {
        "name": "ipv6",
        "limited": false,
        "reachable": true,
        "proxy": "",
        "proxy_randomize_credentials": false
      },
      {
        "name": "onion",
        "limited": true,
        "reachable": false,
        "proxy": "",
        "proxy_randomize_credentials": false
      }
    ],
    "relayfee": 1e-6,
    "localaddresses": [],
    "warnings": ""
  },
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### getpeerinfo

**getpeerinfo**

The `getpeerinfo` method returns data about each connected network node as a json array of objects.

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name                 | Type      | Description                                                          |
| -------------------- | --------- | -------------------------------------------------------------------- |
| "id"                 | (numeric) | peer index                                                           |
| "addr":,             | (string)  | the ip address and port of the peer ("host:port")                    |
| "addrlocal"          | (string)  | local address ("ip:port")                                            |
| "services"           | (string)  | the services offered                                                 |
| "lastsend"           | (numeric) | the time in seconds since epoch (Jan 1 1970 GMT) of the last send    |
| "lastrecv"           | (numeric) | the time in seconds since epoch (Jan 1 1970 GMT) of the last receive |
| "bytessent"          | (numeric) | the total bytes sent                                                 |
| "bytesrecv"          | (numeric) | the total bytes received                                             |
| "conntime"           | (numeric) | the connection time in seconds since epoch (Jan 1 1970 GMT)          |
| "timeoffset"         | (numeric) | the time offset in seconds                                           |
| "pingtime"           | (numeric) | ping time                                                            |
| "pingwait"           | (numeric) | ping wait                                                            |
| "version"            | (numeric) | the peer version, such as 170002                                     |
| "subver"             | (string)  | the string version (i.e. "/MagicBean:x.y.z\[-v]/")                   |
| "inbound"            | (boolean) | inbound (true) or outbound (false)                                   |
| "startingheight"     | (numeric) | the starting height (block) of the peer                              |
| "banscore"           | (numeric) | the ban score                                                        |
| "synced\_headers"    | (numeric) | the last header we have in common with this peer                     |
| "synced\_blocks"     | (numeric) | the last block we have in common with this peer                      |
| "inflight": \[ ... ] | (array)   |                                                                      |
| number               | (numeric) | the block height requested from this peer                            |

**📌 Examples**

Command:

```
./komodo-cli getpeerinfo
```

\<collapse-text hidden title="Response">

```
[
  {
    "id": 1,
    "addr": "78.47.196.146:7770",
    "addrlocal": "69.178.104.172:49724",
    "services": "0000000000000001",
    "lastsend": 1536827621,
    "lastrecv": 1536827617,
    "bytessent": 5181633,
    "bytesrecv": 6245958,
    "conntime": 1536792412,
    "timeoffset": -2,
    "pingtime": 0.234065,
    "version": 170003,
    "subver": "/MagicBean:1.0.15/",
    "inbound": false,
    "startingheight": 1007074,
    "banscore": 45,
    "synced_headers": 1007671,
    "synced_blocks": 1007671,
    "inflight": [],
    "whitelisted": false
  }
]
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getpeerinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": [
    {
      "id": 1,
      "addr": "78.47.196.146:7770",
      "addrlocal": "69.178.104.172:49724",
      "services": "0000000000000001",
      "lastsend": 1536827702,
      "lastrecv": 1536827698,
      "bytessent": 5195639,
      "bytesrecv": 6247781,
      "conntime": 1536792412,
      "timeoffset": -2,
      "pingtime": 0.234605,
      "version": 170003,
      "subver": "/MagicBean:1.0.15/",
      "inbound": false,
      "startingheight": 1007074,
      "banscore": 45,
      "synced_headers": 1007672,
      "synced_blocks": 1007672,
      "inflight": [],
      "whitelisted": false
    }
  ],
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### listbanned

**listbanned**

The `listbanned` method lists all banned IP addresses and subnets.

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name            | Type      | Description                                           |
| --------------- | --------- | ----------------------------------------------------- |
| "address"       | (string)  | the address/subnet that is banned                     |
| "banned\_until" | (numeric) | the timestamp, at which point the ban will be removed |

**📌 Examples**

Command:

```
./komodo-cli listbanned
```

\<collapse-text hidden title="Response">

```
[
  {
    "address": "78.47.205.239/255.255.255.255",
    "banned_until": 1536945306
  }
]
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listbanned", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": [
    {
      "address": "78.47.205.239/255.255.255.255",
      "banned_until": 1536945306
    }
  ],
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### ping

**ping**

The `ping` method requests that a ping be sent to all other nodes, to measure ping time.

Results provided in `getpeerinfo`, `pingtime` and `pingwait` fields are decimal seconds.

The `ping` command is handled in queue with all other commands, so it measures processing backlog, not just network ping.

::: tip Use **getpeerinfo** to see **ping** results. :::

#### Arguments

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

#### Response

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

**📌 Examples**

Command:

```
./komodo-cli ping
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "ping", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
{
  "result": null,
  "error": null,
  "id": "curltest"
}
```

\</collapse-text>

### setban

**setban "ip(/netmask)" "add|remove" (bantime) (absolute)**

The `setban` method attempts to add or remove an IP address (and subnet, if indicated) from the banned list.

#### Arguments

| Name           | Type                  | Description                                                                                                                                                                                                             |
| -------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "ip(/netmask)" | (string, ip required) | the IP/subnet (see `getpeerinfo` for nodes ip) with an optional netmask (default is /32 = single ip)                                                                                                                    |
| "command"      | (string, required)    | use "add" to add an IP/subnet to the list, or "remove" to remove an IP/subnet from the list                                                                                                                             |
| bantime        | (numeric, optional)   | indicates how long (in seconds) the ip is banned (or until when, if \[absolute] is set). 0 or empty means the ban is using the default time of 24h, which can also be overwritten using the -bantime runtime parameter. |
| absolute       | (boolean, optional)   | if set to true, the bantime must be an absolute timestamp (in seconds) since epoch (Jan 1 1970 GMT)                                                                                                                     |

#### Response

| Name   | Type | Description |
| ------ | ---- | ----------- |
| (none) |      |             |

::: tip Use **listbanned** to view results. :::

**📌 Examples**

Command:

```
./komodo-cli setban "192.168.0.6" "add" 86400
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

Command:

```
./komodo-cli setban "192.168.0.0/24" "add"
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>

You can find your `rpcuser`, `rpcpassword`, and `rpcport` in the coin's `.conf` file.

Command:

```
curl --user $rpcuser:$rpcpassword --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setban", "params": ["78.47.205.239", "add", 86400] }' -H 'content-type: text/plain;' http://127.0.0.1:$rpcport/
```

\<collapse-text hidden title="Response">

```
(none)
```

\</collapse-text>