mirror of https://github.com/PeernetOfficial/core.git synced 2026-07-17 02:47:51 +01:00

Files

Kleissner aca6d65044 Introduce default configuration file which is embedded into the binary.

Proper LoadConfig function with error status. Close #1
Separate InitLog function with error return.

2021-02-28 14:46:16 +01:00

2.3 KiB

Raw Blame History

Peernet Core

The core library which is needed for any Peernet application. It provides connectivity to the network and all basic functions.

Current version: 0.1 (pre-alpha)

Encryption and Hashing functions

Salsa20 is used for encrypting the packets.
secp256k1 is used to generate the peer IDs (public keys).
blake3 is used for hashing the packets when signing.

Dependencies

Go 1.16 or higher is required. Before compiling, make sure to download and update all 3rd party packages:

go get -u github.com/btcsuite/btcd/btcec
go get -u github.com/libp2p/go-reuseport
go get -u lukechampine.com/blake3

Configuration

Peernet follows a "zeroconf" approach, meaning there is no manual configuration required. However, in certain cases such as providing root peers [1] that shall listen on a fixed IP and port, it is desirable to create a config file.

The name of the config file is passed to the function LoadConfig. If it does not exist, it will be created with the values from the file Config Default.yaml. It uses the YAML format. Any public/private keys in the config are hex encoded. Here are some notable settings:

PrivateKey The users Private Key hex encoded. The users public key is derived from it.
ListenWorkers defines the count of concurrent workers processing packets (decrypting them and then taking action). Default 2.
Listen defines IP:Port combinations to listen on. If not specified, it will listen on all IPs. You can specify an IP but port 0 for auto port selection. IPv6 addresses must be in the format "[IPv6]:Port".

[1] Root peer = A peer operated by a known trusted entity. They allow to speed up the network including discovery of peers and data.

Private Key

The Private Key is required to make any changes to the user's blockchain, including deleting, renaming, and adding files on Peernet, or nuking the blockchain. If the private key is lost, no write access will be possible. Users should always create a secure backup of their private key.

Contributing

Please note that by contributing code, documentation, ideas, snippets, or any other intellectual property you agree that you have all the necessary rights and you agree that we, the Peernet Foundation, may use it for any purpose.

2.3 KiB Raw Blame History