cleaned up develop branch

src/config/config.go

@@ -1,6 +1,6 @@
 /*
 The config package contains structures related to the configuration of an
-Yggdrasil node.
+Mesh node.
 
 The configuration contains, amongst other things, encryption keys which are used
 to derive a node's identity, information about peerings and node information
@@ -11,7 +11,7 @@ In order for a node to maintain the same identity across restarts, you should
 persist the configuration onto the filesystem or into some configuration storage
 so that the encryption keys (and therefore the node ID) do not change.
 
-Note that Yggdrasil will automatically populate sane defaults for any
+Note that Mesh will automatically populate sane defaults for any
 configuration option that is not provided.
 */
 package config
@@ -23,8 +23,8 @@ import (
 )
 
 // NodeConfig is the main configuration structure, containing configuration
-// options that are necessary for an Yggdrasil node to run. You will need to
-// supply one of these structs to the Yggdrasil core when starting a node.
+// options that are necessary for an Mesh node to run. You will need to
+// supply one of these structs to the Mesh core when starting a node.
 type NodeConfig struct {
 	sync.RWMutex        `json:"-"`
 	Peers               []string                   `comment:"List of connection strings for outbound peer connections in URI format,\ne.g. tls://a.b.c.d:e or socks://a.b.c.d:e/f.g.h.i:j. These connections\nwill obey the operating system routing table, therefore you should\nuse this section when you may connect via different interfaces."`
@@ -37,7 +37,7 @@ type NodeConfig struct {
 	PrivateKey          string                     `comment:"Your private key. DO NOT share this with anyone!"`
 	IfName              string                     `comment:"Local network interface name for TUN adapter, or \"auto\" to select\nan interface automatically, or \"none\" to run without TUN."`
 	IfMTU               uint64                     `comment:"Maximum Transmission Unit (MTU) size for your local TUN interface.\nDefault is the largest supported size for your platform. The lowest\npossible value is 1280."`
-	NodeInfoPrivacy     bool                       `comment:"By default, nodeinfo contains some defaults including the platform,\narchitecture and Yggdrasil version. These can help when surveying\nthe network and diagnosing network routing problems. Enabling\nnodeinfo privacy prevents this, so that only items specified in\n\"NodeInfo\" are sent back if specified."`
+	NodeInfoPrivacy     bool                       `comment:"By default, nodeinfo contains some defaults including the platform,\narchitecture and Mesh version. These can help when surveying\nthe network and diagnosing network routing problems. Enabling\nnodeinfo privacy prevents this, so that only items specified in\n\"NodeInfo\" are sent back if specified."`
 	NodeInfo            map[string]interface{}     `comment:"Optional node info. This must be a { \"key\": \"value\", ... } map\nor set as null. This is entirely optional but, if set, is visible\nto the whole network on request."`
 }
 

src/core/api.go

@@ -122,7 +122,7 @@ func (c *Core) Listen(u *url.URL, sintf string) (*TcpListener, error) {
 	return c.links.tcp.listenURL(u, sintf)
 }
 
-// Address gets the IPv6 address of the Yggdrasil node. This is always a /128
+// Address gets the IPv6 address of the Mesh node. This is always a /128
 // address. The IPv6 address is only relevant when the node is operating as an
 // IP router and often is meaningless when embedded into an application, unless
 // that application also implements either VPN functionality or deals with IP
@@ -132,7 +132,7 @@ func (c *Core) Address() net.IP {
 	return addr
 }
 
-// Subnet gets the routed IPv6 subnet of the Yggdrasil node. This is always a
+// Subnet gets the routed IPv6 subnet of the Mesh node. This is always a
 // /64 subnet. The IPv6 subnet is only relevant when the node is operating as an
 // IP router and often is meaningless when embedded into an application, unless
 // that application also implements either VPN functionality or deals with IP
@@ -143,7 +143,7 @@ func (c *Core) Subnet() net.IPNet {
 	return net.IPNet{IP: subnet, Mask: net.CIDRMask(64, 128)}
 }
 
-// SetLogger sets the output logger of the Yggdrasil node after startup. This
+// SetLogger sets the output logger of the Mesh node after startup. This
 // may be useful if you want to redirect the output later. Note that this
 // expects a Logger from the github.com/gologme/log package and not from Go's
 // built-in log package.

src/core/core.go

@@ -21,8 +21,8 @@ import (
 	"github.com/RiV-chain/RiV-mesh/src/version"
 )
 
-// The Core object represents the Yggdrasil node. You should create a Core
-// object for each Yggdrasil node you plan to run.
+// The Core object represents the Mesh node. You should create a Core
+// object for each Mesh node you plan to run.
 type Core struct {
 	// This is the main data structure that holds everything else for a node
 	// We're going to keep our own copy of the provided config - that way we can
@@ -116,7 +116,7 @@ func (c *Core) _addPeerLoop() {
 	})
 }
 
-// Start starts up Yggdrasil using the provided config.NodeConfig, and outputs
+// Start starts up Mesh using the provided config.NodeConfig, and outputs
 // debug logging through the provided log.Logger. The started stack will include
 // TCP and UDP sockets, a multicast discovery socket, an admin socket, router,
 // switch and DHT node. A config.NodeState is returned which contains both the
@@ -159,7 +159,7 @@ func (c *Core) _start(nc *config.NodeConfig, log *log.Logger) error {
 	return nil
 }
 
-// Stop shuts down the Yggdrasil node.
+// Stop shuts down the Mesh node.
 func (c *Core) Stop() {
 	phony.Block(c, func() {
 		c.log.Infoln("Stopping...")

src/defaults/defaults_windows.go

@@ -10,7 +10,7 @@ func GetDefaults() platformDefaultParameters {
 		DefaultAdminListen: "tcp://localhost:9001",
 
 		// Configuration (used for meshctl)
-		DefaultConfigFile: "C:\\Program Files\\Yggdrasil\\mesh.conf",
+		DefaultConfigFile: "C:\\Program Files\\Mesh\\mesh.conf",
 
 		// Multicast interfaces
 		DefaultMulticastInterfaces: []MulticastInterfaceConfig{
@@ -20,6 +20,6 @@ func GetDefaults() platformDefaultParameters {
 		// TUN/TAP
 		MaximumIfMTU:  65535,
 		DefaultIfMTU:  65535,
-		DefaultIfName: "Yggdrasil",
+		DefaultIfName: "Mesh",
 	}
 }

src/multicast/multicast.go

@@ -21,8 +21,8 @@ import (
 )
 
 // Multicast represents the multicast advertisement and discovery mechanism used
-// by Yggdrasil to find peers on the same subnet. When a beacon is received on a
-// configured multicast interface, Yggdrasil will attempt to peer with that node
+// by Mesh to find peers on the same subnet. When a beacon is received on a
+// configured multicast interface, Mesh will attempt to peer with that node
 // automatically.
 type Multicast struct {
 	phony.Inbox

src/tuntap/tun.go

@@ -28,7 +28,7 @@ import (
 type MTU uint16
 
 // TunAdapter represents a running TUN interface and extends the
-// mesh.Adapter type. In order to use the TUN adapter with Yggdrasil, you
+// mesh.Adapter type. In order to use the TUN adapter with Mesh, you
 // should pass this object to the mesh.SetRouterAdapter() function before
 // calling mesh.Start().
 type TunAdapter struct {
@@ -92,7 +92,7 @@ func MaximumMTU() uint64 {
 }
 
 // Init initialises the TUN module. You must have acquired a Listener from
-// the Yggdrasil core before this point and it must not be in use elsewhere.
+// the Mesh core before this point and it must not be in use elsewhere.
 func (tun *TunAdapter) Init(rwc *ipv6rwc.ReadWriteCloser, config *config.NodeConfig, log *log.Logger, options interface{}) error {
 	tun.rwc = rwc
 	tun.config = config