@noia-network/node v1.2.4

README

You would normally want to use noia-node-gui or noia-node-terminal.

Modules

* - example modules how to use noia-node internally and create headless or node with GUI.

Sample code

console.log("[NODE]: Initializing...")
// Initialize node with default values
const node = new Node({
  settingsPath: "settings.json",
  ssl: true,
  privateKeyPath: "path/to/private.key",
  crtPath: "path/to/crt.cert",
  crtBundlePath: "path/to/crt-bundle.cert",
  // One option for test purposes is to use https://ropsten.infura.io infrastructure.
  walletProviderUrl: "https://example-wallet-provider.io/API_KEY"
})
console.log("[NODE]: initialized.")

// Setters take effect after restart
// node.setStorageSpace('/path/to/storage', 1048576)

// Events
node.on("started", () => {
  console.log("[NODE]: started.")
})
node.master.on("connected", () => {
  console.log("[NODE]: connected to master.")
})
node.master.on("closed", (info) => {
  if (info && info.code !== 1000) {
    console.log(`[NODE]: connection with master closed, info =`, info)
    node.restart()
  } else {
    console.log(`[NODE]: connection with master closed, normal exit`, info)
  }
})
node.master.on("cache", (info) => {
  console.log(`[NODE][IN]: cache request, resource = ${info.source.url}`)
})
node.master.on("clear", (info) => {
  console.log(`[NODE][IN]: clear request, infoHashes = ${info.infoHashes}`)
})
node.master.on("seed", (info) => {
  console.log("[NODE][IN]: seed request.")
})
if (node.clientSockets.http) {
  node.clientSockets.http.on("listening", (info) => {
    console.log(`[NODE]: listening for HTTP requests on port ${info.port}.`)
  })
  node.clientSockets.http.on("closed", () => {
  console.log(`[NODE]: closed HTTP server.`)
  })
}
if (node.clientSockets.ws) {
  node.clientSockets.ws.on("listening", (info) => {
    console.log(`[NODE]: listening for ${info.ssl ? "WSS" : "WS"} requests on port ${info.port}.`)
  })
  node.clientSockets.ws.on("closed", () => {
    console.log(`[NODE]: closed WS/WSS server.`)
  })
  node.clientSockets.ws.on("connections", (count) => {
    console.log(`[NODE]: WS Clients connections = ${count}`)
  })
}
node.contentsClient.on("seeding", (infoHashes) => {
  console.log("[NODE]: seeding contents: ", infoHashes)
})
node.clientSockets.on("resourceSent", (info) => {
  const client = `client ${info.ip}`
  const resource = `resource = ${info.resource.infoHash}`
  const url = `url = ${info.resource.url}`
  const size = `size = ${info.resource.size}`
  const sizeMB = `size = ${info.resource.size/1024/1024}`
  if (info.resource.url) {
    console.log(`[NODE]: HTTP sent to ${client} ${resource} ${sizeMB} ${url}`)
  } else {
    console.log(`[NODE]: WS sent to ${client} ${resource} ${sizeMB}`)
  }
})
node.on("destroyed", () => {
  console.log("[NODE]: stopped.")
})
node.on("error", (error) => {
  console.log("[NODE]: error =", error)
})

// Start
node.start()

Configuration

Node configuration can be supplied to Node object or set via settings.json file. settings.json is generated on first run.

* mandatory to make sure configuration is correct to connect to NOIA master and serve content using WebRTC protocol (default setup) or via secure WS (WebSockets). Currently HTTPS is not recommended and poorly supported.

Note: skipBlockchain is turned on by default while we develop blockchain network.

Note: On startup, node is registered on blockchain and client address (client) is saved in settings.json. If any of domain, sockets.ws.port or external IP information property changes, client should be regenerated. To do so, simply remove client property from settings.json and it will registern node client on blockchain with updated values.

SSL

TODO: add SSL docs.

Logging to log file

Node by default doesn't log activiy to file. To log to file noia-node.log, create .env file and add line LOG_TO_FILE=yes to enable it.