[lbry] docs: update README.md
This commit is contained in:
Roy Lee
parent
6093d9adca
commit
0eb0616b66
7 changed files with 139 additions and 86 deletions
99
README.md
99
README.md
|
|
@ -1,20 +1,19 @@
|
||||||
lbcd
|
# lbcd
|
||||||
====
|
|
||||||
|
|
||||||
[](https://github.com/lbryio/lbcd/actions)
|
[](https://github.com/lbryio/lbcd/actions)
|
||||||
[](https://coveralls.io/github/lbryio/lbcd?branch=master)
|
[](https://coveralls.io/github/lbryio/lbcd?branch=master)
|
||||||
[](http://copyfree.org)
|
[](http://copyfree.org)
|
||||||
<!--[](https://pkg.go.dev/github.com/lbryio/lbcd)-->
|
<!--[](https://pkg.go.dev/github.com/lbryio/lbcd)-->
|
||||||
|
|
||||||
lbcd is a full node implementation of LBRY's blockchain written in Go (golang).
|
`lbcd` is a full node implementation of LBRY's blockchain written in Go (golang).
|
||||||
|
|
||||||
This project is currently under active development and is in a Beta state while we
|
This project is currently under active development and is in a Beta state while
|
||||||
ensure it matches LBRYcrd's functionality. The intention is that it properly downloads, validates, and serves the block chain using the exact
|
we ensure it matches LBRYcrd's functionality. The intention is that it properly
|
||||||
rules (including consensus bugs) for block acceptance as LBRYcrd. We have
|
downloads, validates, and serves the block chain using the exact rules
|
||||||
taken great care to avoid lbcd causing a fork to the blockchain.
|
(including consensus bugs) for block acceptance as LBRYcrd.
|
||||||
|
We have taken great care to avoid lbcd causing a fork to the blockchain.
|
||||||
|
|
||||||
Note: lbcd does *NOT* include
|
Note: `lbcd` does *NOT* include wallet functionality. That functionality is provided by the
|
||||||
wallet functionality. That functionality is provided by the
|
|
||||||
[lbcwallet](https://github.com/lbryio/lbcwallet) and the [LBRY SDK](https://github.com/lbryio/lbry-sdk).
|
[lbcwallet](https://github.com/lbryio/lbcwallet) and the [LBRY SDK](https://github.com/lbryio/lbry-sdk).
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
@ -23,7 +22,7 @@ We take security seriously. Please contact [security](mailto:security@lbry.com)
|
||||||
Our PGP key is [here](https://lbry.com/faq/pgp-key) if you need it.
|
Our PGP key is [here](https://lbry.com/faq/pgp-key) if you need it.
|
||||||
|
|
||||||
We maintain a mailing list for notifications of upgrades, security issues,
|
We maintain a mailing list for notifications of upgrades, security issues,
|
||||||
and soft/hard forks. To join, visit https://lbry.com/forklist
|
and soft/hard forks. To join, visit [fork list](https://lbry.com/forklist)
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
@ -31,36 +30,90 @@ All common operating systems are supported. lbcd requires at least 8GB of RAM
|
||||||
and at least 100GB of disk storage. Both RAM and disk requirements increase slowly over time.
|
and at least 100GB of disk storage. Both RAM and disk requirements increase slowly over time.
|
||||||
Using a fast NVMe disk is recommended.
|
Using a fast NVMe disk is recommended.
|
||||||
|
|
||||||
lbcd is not immune to data loss. It expects a clean shutdown
|
`lbcd` is not immune to data loss. It expects a clean shutdown via SIGINT or
|
||||||
via SIGINT or SIGTERM. SIGKILL, immediate VM kills, and sudden power loss
|
SIGTERM. SIGKILL, immediate VM kills, and sudden power loss can cause data
|
||||||
can cause data corruption, thus requiring chain resynchronization for recovery.
|
corruption, thus requiring chain resynchronization for recovery.
|
||||||
|
|
||||||
For compilation, [Go](http://golang.org) 1.16 or newer is required.
|
For compilation, [Go](http://golang.org) 1.16 or newer is required.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Acquire binary files from https://github.com/lbryio/lbcd/releases
|
Acquire binary files from [releases](https://github.com/lbryio/lbcd/releases)
|
||||||
|
|
||||||
#### To build from Source on Linux/BSD/MacOSX/POSIX:
|
### To build from Source on Linux/BSD/MacOSX/POSIX
|
||||||
|
|
||||||
- Install Go according to its [installation instructions](http://golang.org/doc/install).
|
Install Go according to its [installation instructions](http://golang.org/doc/install).
|
||||||
- Use your favorite git tool to acquire the lbcd source.
|
|
||||||
- lbcd has no non-Go dependencies; it can be built by simply running `go build .`
|
``` sh
|
||||||
- lbcctl can be built similarly:
|
git clone https://github.com/lbryio/lbcd
|
||||||
|
cd lbcd
|
||||||
|
|
||||||
|
# Build lbcd
|
||||||
|
go build .
|
||||||
|
|
||||||
|
# Build lbcctl
|
||||||
|
go build ./cmd/lbcctl
|
||||||
|
```
|
||||||
|
|
||||||
Both [GoLand](https://www.jetbrains.com/go/)
|
Both [GoLand](https://www.jetbrains.com/go/)
|
||||||
and [VS Code](https://code.visualstudio.com/docs/languages/go) IDEs are supported.
|
and [VS Code](https://code.visualstudio.com/docs/languages/go) IDEs are supported.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
By default, data and logs are stored in `~/.lbcd/`
|
By default, data and logs are stored in `<LBCDDIR>`:
|
||||||
|
|
||||||
|
- Linux: `~/.lbcd/`
|
||||||
|
- MacOS: `/Users/<username>/Library/Application Support/Lbcd/`
|
||||||
|
|
||||||
To enable RPC access a username and password is required. Example:
|
To enable RPC access a username and password is required. Example:
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
./lbcd --txindex --rpcuser=rpcuser --rpcpass=rpcpass
|
||||||
```
|
```
|
||||||
./lbcd --notls --rpcuser=x --rpcpass=y --txindex &
|
|
||||||
./lbcctl --notls --rpcuser=x --rpcpass=y getblocktemplate
|
Interact with lbcd via RPC using `lbcctl`
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
./lbcctl --rpcuser=rpcuser --rpcpass=rpcpass getblockcount
|
||||||
|
./lbcctl --rpcuser=rpcuser --rpcpass=rpcpass getblocktemplate
|
||||||
```
|
```
|
||||||
<!-- TODO: explain how to use TLS certificates. -->
|
|
||||||
|
By default, the RPCs are served over TLS. `lbcd` generates (if not exists) `rpc.cert` and
|
||||||
|
`rpc.key` under `<LBCDDIR>` where `lbcctl` would search and use them.
|
||||||
|
|
||||||
|
The RPCs can also be served without TLS *(on localhost only)* using (`--notls`)
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
./lbcd --txindex --rpcuser=rpcuser --rpcpass=rpcpass --notls
|
||||||
|
./lbcctl --rpcuser=rpcuser --rpcpass=rpcpass --notls getblockcount
|
||||||
|
```
|
||||||
|
|
||||||
|
## Working with Different Networks
|
||||||
|
|
||||||
|
By default, `lbcd` and `lbcctl` use the following ports for different networks respectively:
|
||||||
|
|
||||||
|
| Network | RPC Port | Network Port |
|
||||||
|
| ------- | -------- | ------------ |
|
||||||
|
| mainnet | 9245 | 9246 |
|
||||||
|
| testnet | 19245 | 19246 |
|
||||||
|
| regtest | 29245 | 29246 |
|
||||||
|
|
||||||
|
Running `lbcd` and `lbcctl` with `--testnet` or `--regtest` would use different chain params as well as default RPC and Network ports.
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
./lbcd --txindex --rpcuser=rpcuser --rpcpass=rpcpass --regtest
|
||||||
|
./lbcctl --rpcuser=rpcuser --rpcpass=rpcpass --regtest getblockcount
|
||||||
|
```
|
||||||
|
|
||||||
|
The default Network and RPC ports of `lbcd` can be overriden using `--listen` and `--rpclisten`
|
||||||
|
`lbcctl` can also connect to RPC server specified by `--rpcserver`
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
./lbcd --txindex --rpcuser=rpcuser --rpcpass=rpcpass --regtest --listen=127.0.0.1:29248 --rpclisten=127.0.0.1:29247
|
||||||
|
./lbcctl --rpcuser=rpcuser --rpcpass=rpcpass --regtest --rpcserver=127.0.0.1:29247 getblockcount
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: Wallet related RPCs are provided by [lbcwallet](https://github.com/lbryio/lbcwallet).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
|
||||||
6
doc.go
6
doc.go
|
|
@ -73,8 +73,8 @@ Application Options:
|
||||||
fee to the given amount in thousands of bytes per
|
fee to the given amount in thousands of bytes per
|
||||||
minute (default: 15)
|
minute (default: 15)
|
||||||
--listen= Add an interface/port to listen for connections
|
--listen= Add an interface/port to listen for connections
|
||||||
(default all interfaces port: 8333, testnet:
|
(default all interfaces port: 9246, testnet:
|
||||||
18333, signet: 38333)
|
19246, regtest: 29246, signet: 39246)
|
||||||
--logdir= Directory to log output
|
--logdir= Directory to log output
|
||||||
--maxorphantx= Max number of orphan transactions to keep in
|
--maxorphantx= Max number of orphan transactions to keep in
|
||||||
memory (default: 100)
|
memory (default: 100)
|
||||||
|
|
@ -125,7 +125,7 @@ Application Options:
|
||||||
--rpclimitpass= Password for limited RPC connections
|
--rpclimitpass= Password for limited RPC connections
|
||||||
--rpclimituser= Username for limited RPC connections
|
--rpclimituser= Username for limited RPC connections
|
||||||
--rpclisten= Add an interface/port to listen for RPC
|
--rpclisten= Add an interface/port to listen for RPC
|
||||||
connections (default port: 8334, testnet: 18334)
|
connections (default port: 9245, testnet: 19245, regtest: 29245)
|
||||||
--rpcmaxclients= Max number of RPC clients for standard
|
--rpcmaxclients= Max number of RPC clients for standard
|
||||||
connections (default: 10)
|
connections (default: 10)
|
||||||
--rpcmaxconcurrentreqs= Max number of concurrent RPC requests that may be
|
--rpcmaxconcurrentreqs= Max number of concurrent RPC requests that may be
|
||||||
|
|
|
||||||
|
|
@ -17,28 +17,28 @@ interfaces as a couple of the examples below illustrate.
|
||||||
Command Line Examples:
|
Command Line Examples:
|
||||||
|
|
||||||
| Flags | Comment |
|
| Flags | Comment |
|
||||||
|----------|------------|
|
| ------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
| --listen= | all interfaces on default port which is changed by `--testnet` and `--regtest` (**default**) |
|
| --listen= | all interfaces on default port which is changed by `--testnet` and `--regtest` (**default**) |
|
||||||
| --listen=0.0.0.0 | all IPv4 interfaces on default port which is changed by `--testnet` and `--regtest` |
|
| --listen=0.0.0.0 | all IPv4 interfaces on default port which is changed by `--testnet` and `--regtest` |
|
||||||
| --listen=:: | all IPv6 interfaces on default port which is changed by `--testnet` and `--regtest` |
|
| --listen=:: | all IPv6 interfaces on default port which is changed by `--testnet` and `--regtest` |
|
||||||
|--listen=:8333|all interfaces on port 8333|
|
| --listen=:9246 | all interfaces on port 9246 |
|
||||||
|--listen=0.0.0.0:8333|all IPv4 interfaces on port 8333|
|
| --listen=0.0.0.0:9246 | all IPv4 interfaces on port 9246 |
|
||||||
|--listen=[::]:8333|all IPv6 interfaces on port 8333|
|
| --listen=[::]:9246 | all IPv6 interfaces on port 9246 |
|
||||||
|--listen=127.0.0.1:8333|only IPv4 localhost on port 8333|
|
| --listen=127.0.0.1:9246 | only IPv4 localhost on port 9246 |
|
||||||
|--listen=[::1]:8333|only IPv6 localhost on port 8333|
|
| --listen=[::1]:9246 | only IPv6 localhost on port 9246 |
|
||||||
|--listen=:8336|all interfaces on non-standard port 8336|
|
| --listen=:9247 | all interfaces on non-standard port 9247 |
|
||||||
|--listen=0.0.0.0:8336|all IPv4 interfaces on non-standard port 8336|
|
| --listen=0.0.0.0:9247 | all IPv4 interfaces on non-standard port 9247 |
|
||||||
|--listen=[::]:8336|all IPv6 interfaces on non-standard port 8336|
|
| --listen=[::]:9247 | all IPv6 interfaces on non-standard port 9247 |
|
||||||
|--listen=127.0.0.1:8337 --listen=[::1]:8333|IPv4 localhost on port 8337 and IPv6 localhost on port 8333|
|
| --listen=127.0.0.1:9248 --listen=[::1]:9246 | IPv4 localhost on port 9248 and IPv6 localhost on port 9246 |
|
||||||
|--listen=:8333 --listen=:8337|all interfaces on ports 8333 and 8337|
|
| --listen=:9246 --listen=:9248 | all interfaces on ports 9246 and 9248 |
|
||||||
|
|
||||||
The following config file would configure lbcd to only listen on localhost for both IPv4 and IPv6:
|
The following config file would configure lbcd to only listen on localhost for both IPv4 and IPv6:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
[Application Options]
|
[Application Options]
|
||||||
|
|
||||||
listen=127.0.0.1:8333
|
listen=127.0.0.1:9246
|
||||||
listen=[::1]:8333
|
listen=[::1]:9246
|
||||||
```
|
```
|
||||||
|
|
||||||
In addition, if you are starting lbcd with TLS and want to make it
|
In addition, if you are starting lbcd with TLS and want to make it
|
||||||
|
|
@ -77,20 +77,20 @@ A few things to note regarding the RPC server:
|
||||||
Command Line Examples:
|
Command Line Examples:
|
||||||
|
|
||||||
| Flags | Comment |
|
| Flags | Comment |
|
||||||
|----------|------------|
|
| ---------------------------------------------- | ------------------------------------------------------------------- |
|
||||||
| --rpclisten= | all interfaces on default port which is changed by `--testnet` |
|
| --rpclisten= | all interfaces on default port which is changed by `--testnet` |
|
||||||
| --rpclisten=0.0.0.0 | all IPv4 interfaces on default port which is changed by `--testnet` |
|
| --rpclisten=0.0.0.0 | all IPv4 interfaces on default port which is changed by `--testnet` |
|
||||||
| --rpclisten=:: | all IPv6 interfaces on default port which is changed by `--testnet` |
|
| --rpclisten=:: | all IPv6 interfaces on default port which is changed by `--testnet` |
|
||||||
|--rpclisten=:8334|all interfaces on port 8334|
|
| --rpclisten=:9245 | all interfaces on port 9245 |
|
||||||
|--rpclisten=0.0.0.0:8334|all IPv4 interfaces on port 8334|
|
| --rpclisten=0.0.0.0:9245 | all IPv4 interfaces on port 9245 |
|
||||||
|--rpclisten=[::]:8334|all IPv6 interfaces on port 8334|
|
| --rpclisten=[::]:9245 | all IPv6 interfaces on port 9245 |
|
||||||
|--rpclisten=127.0.0.1:8334|only IPv4 localhost on port 8334|
|
| --rpclisten=127.0.0.1:9245 | only IPv4 localhost on port 9245 |
|
||||||
|--rpclisten=[::1]:8334|only IPv6 localhost on port 8334|
|
| --rpclisten=[::1]:9245 | only IPv6 localhost on port 9245 |
|
||||||
|--rpclisten=:8336|all interfaces on non-standard port 8336|
|
| --rpclisten=:9247 | all interfaces on non-standard port 9247 |
|
||||||
|--rpclisten=0.0.0.0:8336|all IPv4 interfaces on non-standard port 8336|
|
| --rpclisten=0.0.0.0:9247 | all IPv4 interfaces on non-standard port 9247 |
|
||||||
|--rpclisten=[::]:8336|all IPv6 interfaces on non-standard port 8336|
|
| --rpclisten=[::]:9247 | all IPv6 interfaces on non-standard port 9247 |
|
||||||
|--rpclisten=127.0.0.1:8337 --listen=[::1]:8334|IPv4 localhost on port 8337 and IPv6 localhost on port 8334|
|
| --rpclisten=127.0.0.1:9248 --listen=[::1]:9245 | IPv4 localhost on port 9248 and IPv6 localhost on port 9245 |
|
||||||
|--rpclisten=:8334 --listen=:8337|all interfaces on ports 8334 and 8337|
|
| --rpclisten=:9245 --listen=:9248 | all interfaces on ports 9245 and 9248 |
|
||||||
|
|
||||||
The following config file would configure the lbcd RPC server to listen to all interfaces on the default port, including external interfaces, for both IPv4 and IPv6:
|
The following config file would configure the lbcd RPC server to listen to all interfaces on the default port, including external interfaces, for both IPv4 and IPv6:
|
||||||
|
|
||||||
|
|
@ -114,7 +114,7 @@ access to your lbcd from external sources such as in more advanced network
|
||||||
configurations. You can disable UPnP with the `--noupnp` daemon option.
|
configurations. You can disable UPnP with the `--noupnp` daemon option.
|
||||||
|
|
||||||
| Name | Port |
|
| Name | Port |
|
||||||
|----|----|
|
| ------------------------- | -------- |
|
||||||
| Default peer-to-peer port | TCP 9246 |
|
| Default peer-to-peer port | TCP 9246 |
|
||||||
| Default RPC port | TCP 9245 |
|
| Default RPC port | TCP 9245 |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -60,7 +60,7 @@ address.
|
||||||
|
|
||||||
```text
|
```text
|
||||||
HiddenServiceDir /var/tor/lbcd
|
HiddenServiceDir /var/tor/lbcd
|
||||||
HiddenServicePort 8333 127.0.0.1:8333
|
HiddenServicePort 9246 127.0.0.1:9246
|
||||||
```
|
```
|
||||||
|
|
||||||
Once Tor is configured to provide the hidden service and you have obtained your
|
Once Tor is configured to provide the hidden service and you have obtained your
|
||||||
|
|
|
||||||
|
|
@ -242,8 +242,8 @@ the method name for further details such as parameter and return information.
|
||||||
| Description | Returns information about manually added (persistent) peers. |
|
| Description | Returns information about manually added (persistent) peers. |
|
||||||
| Returns (dns=false) | `["ip:port", ...]` |
|
| Returns (dns=false) | `["ip:port", ...]` |
|
||||||
| Returns (dns=true) | `[ (json array of objects)`<br /> `{ (json object)`<br /> `"addednode": "ip_or_domain", (string) the ip address or domain of the added peer`<br /> `"connected": true or false, (boolean) whether or not the peer is currently connected`<br /> `"addresses": [ (json array or objects) DNS lookup and connection information about the peer`<br /> `{ (json object)`<br /> `"address": "ip", (string) the ip address for this DNS entry`<br /> `"connected": "inbound/outbound/false" (string) the connection 'direction' (if connected)`<br /> `}, ...`<br /> `]`<br /> `}, ...`<br />`]` |
|
| Returns (dns=true) | `[ (json array of objects)`<br /> `{ (json object)`<br /> `"addednode": "ip_or_domain", (string) the ip address or domain of the added peer`<br /> `"connected": true or false, (boolean) whether or not the peer is currently connected`<br /> `"addresses": [ (json array or objects) DNS lookup and connection information about the peer`<br /> `{ (json object)`<br /> `"address": "ip", (string) the ip address for this DNS entry`<br /> `"connected": "inbound/outbound/false" (string) the connection 'direction' (if connected)`<br /> `}, ...`<br /> `]`<br /> `}, ...`<br />`]` |
|
||||||
| Example Return (dns=false) | `["192.168.0.10:8333", "mydomain.org:8333"]` |
|
| Example Return (dns=false) | `["192.168.0.10:9246", "mydomain.org:9246"]` |
|
||||||
| Example Return (dns=true) | `[`<br /> `{`<br /> `"addednode": "mydomain.org:8333",`<br /> `"connected": true,`<br /> `"addresses": [`<br /> `{`<br /> `"address": "1.2.3.4",`<br /> `"connected": "outbound"`<br /> `},`<br /> `{`<br /> `"address": "5.6.7.8",`<br /> `"connected": "false"`<br /> `}`<br /> `]`<br /> `}`<br />`]` |
|
| Example Return (dns=true) | `[`<br /> `{`<br /> `"addednode": "mydomain.org:9246",`<br /> `"connected": true,`<br /> `"addresses": [`<br /> `{`<br /> `"address": "1.2.3.4",`<br /> `"connected": "outbound"`<br /> `},`<br /> `{`<br /> `"address": "5.6.7.8",`<br /> `"connected": "false"`<br /> `}`<br /> `]`<br /> `}`<br />`]` |
|
||||||
[Return to Overview](#MethodOverview)<br />
|
[Return to Overview](#MethodOverview)<br />
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
@ -427,7 +427,7 @@ the method name for further details such as parameter and return information.
|
||||||
| Parameters | None |
|
| Parameters | None |
|
||||||
| Description | Returns data about each connected network peer as an array of json objects. |
|
| Description | Returns data about each connected network peer as an array of json objects. |
|
||||||
| Returns | `[`<br /> `{`<br /> `"addr": "host:port", (string) the ip address and port of the peer`<br /> `"services": "00000001", (string) the services supported by the peer`<br /> `"lastrecv": n, (numeric) time the last message was received in seconds since 1 Jan 1970 GMT`<br /> `"lastsend": n, (numeric) time the last message was sent in seconds since 1 Jan 1970 GMT`<br /> `"bytessent": n, (numeric) total bytes sent`<br /> `"bytesrecv": n, (numeric) total bytes received`<br /> `"conntime": n, (numeric) time the connection was made in seconds since 1 Jan 1970 GMT`<br /> `"pingtime": n, (numeric) number of microseconds the last ping took`<br /> `"pingwait": n, (numeric) number of microseconds a queued ping has been waiting for a response`<br /> `"version": n, (numeric) the protocol version of the peer`<br /> `"subver": "useragent", (string) the user agent of the peer`<br /> `"inbound": true_or_false, (boolean) whether or not the peer is an inbound connection`<br /> `"startingheight": n, (numeric) the latest block height the peer knew about when the connection was established`<br /> `"currentheight": n, (numeric) the latest block height the peer is known to have relayed since connected`<br /> `"syncnode": true_or_false, (boolean) whether or not the peer is the sync peer`<br /> `}, ...`<br />`]` |
|
| Returns | `[`<br /> `{`<br /> `"addr": "host:port", (string) the ip address and port of the peer`<br /> `"services": "00000001", (string) the services supported by the peer`<br /> `"lastrecv": n, (numeric) time the last message was received in seconds since 1 Jan 1970 GMT`<br /> `"lastsend": n, (numeric) time the last message was sent in seconds since 1 Jan 1970 GMT`<br /> `"bytessent": n, (numeric) total bytes sent`<br /> `"bytesrecv": n, (numeric) total bytes received`<br /> `"conntime": n, (numeric) time the connection was made in seconds since 1 Jan 1970 GMT`<br /> `"pingtime": n, (numeric) number of microseconds the last ping took`<br /> `"pingwait": n, (numeric) number of microseconds a queued ping has been waiting for a response`<br /> `"version": n, (numeric) the protocol version of the peer`<br /> `"subver": "useragent", (string) the user agent of the peer`<br /> `"inbound": true_or_false, (boolean) whether or not the peer is an inbound connection`<br /> `"startingheight": n, (numeric) the latest block height the peer knew about when the connection was established`<br /> `"currentheight": n, (numeric) the latest block height the peer is known to have relayed since connected`<br /> `"syncnode": true_or_false, (boolean) whether or not the peer is the sync peer`<br /> `}, ...`<br />`]` |
|
||||||
| Example Return | `[`<br /> `{`<br /> `"addr": "178.172.xxx.xxx:8333",`<br /> `"services": "00000001",`<br /> `"lastrecv": 1388183523,`<br /> `"lastsend": 1388185470,`<br /> `"bytessent": 287592965,`<br /> `"bytesrecv": 780340,`<br /> `"conntime": 1388182973,`<br /> `"pingtime": 405551,`<br /> `"pingwait": 183023,`<br /> `"version": 70001,`<br /> `"subver": "/lbcd:0.4.0/",`<br /> `"inbound": false,`<br /> `"startingheight": 276921,`<br /> `"currentheight": 276955,`<br/> `"syncnode": true,`<br /> `}`<br />`]` |
|
| Example Return | `[`<br /> `{`<br /> `"addr": "178.172.xxx.xxx:9246",`<br /> `"services": "00000001",`<br /> `"lastrecv": 1388183523,`<br /> `"lastsend": 1388185470,`<br /> `"bytessent": 287592965,`<br /> `"bytesrecv": 780340,`<br /> `"conntime": 1388182973,`<br /> `"pingtime": 405551,`<br /> `"pingwait": 183023,`<br /> `"version": 70001,`<br /> `"subver": "/lbcd:0.4.0/",`<br /> `"inbound": false,`<br /> `"startingheight": 276921,`<br /> `"currentheight": 276955,`<br/> `"syncnode": true,`<br /> `}`<br />`]` |
|
||||||
[Return to Overview](#MethodOverview)<br />
|
[Return to Overview](#MethodOverview)<br />
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,6 @@ certificate into the default system Certificate Authority list.
|
||||||
|
|
||||||
## Set your mining software url to use https
|
## Set your mining software url to use https
|
||||||
|
|
||||||
`cgminer -o https://127.0.0.1:8334 -u rpcuser -p rpcpassword`
|
`cgminer -o https://127.0.0.1:9245 -u rpcuser -p rpcpassword`
|
||||||
|
|
||||||
Alternatively, you can disable TLS with the `--notls` option for the server.
|
Alternatively, you can disable TLS with the `--notls` option for the server.
|
||||||
|
|
|
||||||
|
|
@ -86,9 +86,9 @@
|
||||||
; You may specify each IP address with or without a port. The default port will
|
; You may specify each IP address with or without a port. The default port will
|
||||||
; be added automatically if one is not specified here.
|
; be added automatically if one is not specified here.
|
||||||
; addpeer=192.168.1.1
|
; addpeer=192.168.1.1
|
||||||
; addpeer=10.0.0.2:8333
|
; addpeer=10.0.0.2:9246
|
||||||
; addpeer=fe80::1
|
; addpeer=fe80::1
|
||||||
; addpeer=[fe80::2]:8333
|
; addpeer=[fe80::2]:9246
|
||||||
|
|
||||||
; Add persistent peers that you ONLY want to connect to as desired. One peer
|
; Add persistent peers that you ONLY want to connect to as desired. One peer
|
||||||
; per line. You may specify each IP address with or without a port. The
|
; per line. You may specify each IP address with or without a port. The
|
||||||
|
|
@ -96,9 +96,9 @@
|
||||||
; NOTE: Specifying this option has other side effects as described above in
|
; NOTE: Specifying this option has other side effects as described above in
|
||||||
; the 'addpeer' versus 'connect' summary section.
|
; the 'addpeer' versus 'connect' summary section.
|
||||||
; connect=192.168.1.1
|
; connect=192.168.1.1
|
||||||
; connect=10.0.0.2:8333
|
; connect=10.0.0.2:9246
|
||||||
; connect=fe80::1
|
; connect=fe80::1
|
||||||
; connect=[fe80::2]:8333
|
; connect=[fe80::2]:9246
|
||||||
|
|
||||||
; Maximum number of inbound and outbound peers.
|
; Maximum number of inbound and outbound peers.
|
||||||
; maxpeers=125
|
; maxpeers=125
|
||||||
|
|
@ -135,16 +135,16 @@
|
||||||
; listen=0.0.0.0
|
; listen=0.0.0.0
|
||||||
; All ipv6 interfaces on default port:
|
; All ipv6 interfaces on default port:
|
||||||
; listen=::
|
; listen=::
|
||||||
; All interfaces on port 8333:
|
; All interfaces on port 9246:
|
||||||
; listen=:8333
|
; listen=:9246
|
||||||
; All ipv4 interfaces on port 8333:
|
; All ipv4 interfaces on port 9246:
|
||||||
; listen=0.0.0.0:8333
|
; listen=0.0.0.0:9246
|
||||||
; All ipv6 interfaces on port 8333:
|
; All ipv6 interfaces on port 9246:
|
||||||
; listen=[::]:8333
|
; listen=[::]:9246
|
||||||
; Only ipv4 localhost on port 8333:
|
; Only ipv4 localhost on port 9246:
|
||||||
; listen=127.0.0.1:8333
|
; listen=127.0.0.1:9246
|
||||||
; Only ipv6 localhost on port 8333:
|
; Only ipv6 localhost on port 9246:
|
||||||
; listen=[::1]:8333
|
; listen=[::1]:9246
|
||||||
; Only ipv4 localhost on non-standard port 8336:
|
; Only ipv4 localhost on non-standard port 8336:
|
||||||
; listen=127.0.0.1:8336
|
; listen=127.0.0.1:8336
|
||||||
; All interfaces on non-standard port 8336:
|
; All interfaces on non-standard port 8336:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue