Class: Zold::Node

Inherits:

Object

• Object
• Zold::Node

Includes:

ThreadBadge

Defined in:

lib/zold/commands/node.rb

Overview

NODE command

Defined Under Namespace

Classes: NohupLog

Instance Method Summary

• #initialize(wallets:, remotes:, copies:, log: Log::NULL) ⇒ Node constructor

  A new instance of Node.

• #run(args = []) ⇒ Object

Constructor Details

#initialize(wallets:, remotes:, copies:, log: Log::NULL) ⇒ Node

Returns a new instance of Node.

# File 'lib/zold/commands/node.rb', line 68

def initialize(wallets:, remotes:, copies:, log: Log::NULL)
  @remotes = remotes
  @copies = copies
  @log = log
  @wallets = wallets
end

Instance Method Details

#run(args = []) ⇒ Object

# File 'lib/zold/commands/node.rb', line 75

def run(args = [])
  @log.debug("Node.run(#{args.join(' ')})")
  opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
    o.banner = 'Usage: zold node [options]'
    o.string '--invoice',
      'The invoice you want to collect money to or the wallet ID',
      required: true
    o.integer '--port',
      "TCP port to announce in Zold Network (default: #{Remotes::PORT})",
      default: Remotes::PORT
    o.integer '--bind-port',
      "TCP port to listen on, which may differ from --port if you are behind a proxy (default: #{Remotes::PORT})",
      default: Remotes::PORT
    o.string '--host',
      'Host name (will attempt to auto-detect it, if not specified)'
    o.integer '--strength',
      "The strength of the score (default: #{Score::STRENGTH})",
      default: Score::STRENGTH
    o.integer '--threads',
      "How many threads to use for scores finding (default: #{[Concurrent.processor_count / 2, 2].max})",
      default: [Concurrent.processor_count / 2, 2].max
    o.bool '--dump-errors',
      'Make HTTP front-end errors visible in the log (false by default)',
      default: false
    o.bool '--standalone',
      'Never communicate with other nodes (mostly for testing)',
      default: false
    o.bool '--ignore-score-weakness',
      'Ignore score weakness of incoming requests and register those nodes anyway',
      default: false
    o.bool '--tolerate-edges',
      'Don\'t fail if only "edge" (not "master" ones) nodes accepted/have the wallet',
      default: false
    o.integer '--tolerate-quorum',
      'The minimum number of nodes required for a successful fetch (default: 4)',
      default: 4
    o.boolean '--nohup',
      'Run it in background, rebooting when a higher version is available in the network',
      default: false
    o.string '--nohup-command',
      'The command to run in server "nohup" mode (default: "gem install zold")',
      default: 'gem install zold'
    o.string '--nohup-log',
      'The file to log output into (default: zold.log)',
      default: 'zold.log'
    o.integer '--nohup-log-truncate',
      'The maximum amount of bytes to keep in the file, and truncate it in half if it grows bigger',
      default: 1024 * 1024
    o.string '--halt-code',
      'The value of HTTP query parameter "halt," which will cause the front-end immediate termination',
      default: ''
    o.integer '--trace-length',
      'Maximum length of the trace to keep in memory (default: 4096)',
      default: 4096
    o.string '--save-pid',
      'The file to save process ID into right after start (only in NOHUP mode)'
    o.bool '--never-reboot',
      'Don\'t reboot when a new version shows up in the network',
      default: false
    o.bool '--routine-immediately',
      'Run all routines immediately, without waiting between executions (for testing mostly)',
      default: false
    o.bool '--no-cache',
      'Skip caching of front JSON pages (will seriously slow down, mostly useful for testing)',
      default: false
    o.boolean '--skip-audit',
      'Don\'t report audit information to the console every minute',
      default: false
    o.boolean '--skip-reconnect',
      'Don\'t reconnect to the network every minute (for testing)',
      default: false
    o.boolean '--not-hungry',
      'Don\'t do hugry pulling of missed nodes (mostly for testing)',
      default: false
    o.bool '--allow-spam',
      'Don\'t filter the incoming spam via PUT requests (duplicate wallets)',
      default: false
    o.bool '--ignore-empty-remotes',
      'Don\'t fail if the list of remotes is empty (for testing mostly)',
      default: false
    o.bool '--skip-oom',
      'Skip Out Of Memory check and never exit, no matter how much RAM is consumed',
      default: false
    o.integer '--oom-limit',
      "Maximum amount of memory we can consume, quit if we take more than that, in Mb (default: #{oom_limit})",
      default: oom_limit
    o.integer '--queue-limit',
      'The maximum number of wallets to be accepted via PUSH and stored in the queue (default: 256)',
      default: 256
    o.bool '--skip-gc',
      'Don\'t run garbage collector and never remove any wallets from the disk',
      default: false
    o.integer '--gc-age',
      'Maximum time in seconds to keep an empty and unused wallet on the disk',
      default: 60 * 60 * 24 * 10
    o.string '--expose-version',
      "The version of the software to expose in JSON (default: #{VERSION})",
      default: VERSION
    o.string '--private-key',
      'The location of RSA private key (default: ~/.ssh/id_rsa)',
      default: '~/.ssh/id_rsa'
    o.string '--network',
      "The name of the network (default: #{Wallet::MAINET})",
      default: Wallet::MAINET
    o.integer '--nohup-max-cycles',
      'Maximum amount of nohup re-starts (-1 by default, which means forever)',
      default: -1
    o.string '--home',
      "Home directory (default: #{Dir.pwd})",
      default: Dir.pwd
    o.bool '--no-metronome',
      'Don\'t run the metronome',
      default: false
    o.bool '--disable-push',
      'Prohibit all PUSH requests',
      default: false
    o.bool '--disable-fetch',
      'Prohibit all FETCH requests',
      default: false
    o.string '--alias',
      'The alias of the node (default: host:port)'
    o.string '--farmer',
      'The name of the farmer, e.g. "plain", "spawn", "fork" (default: "plain")',
      default: 'plain'
    o.bool '--help', 'Print instructions'
  end
  if opts.help?
    @log.info(opts.to_s)
    return
  end
  raise '--invoice is mandatory' unless opts['invoice']
  if opts['nohup']
    if @remotes.all.empty? && !opts['standalone'] && !opts['ignore-empty-remotes']
      raise 'There are no remote nodes in the list and you are not running in --standalone mode;
the node won\'t connect to the network like that; try to do "zold remote reset" first'
    end
    pid = nohup(opts)
    IO.write(opts['save-pid'], pid) if opts['save-pid']
    @log.debug("Process ID #{pid} saved into \"#{opts['save-pid']}\"")
    @log.info(pid)
    return
  end
  @log = Trace.new(@log, opts['trace-length'])
  Front.set(:log, @log)
  Front.set(:logger, @log)
  Front.set(:trace, @log)
  Front.set(:nohup_log, opts['nohup-log']) if opts['nohup-log']
  Front.set(:protocol, Zold::PROTOCOL)
  Front.set(:logging, @log.debug?)
  home = File.expand_path(opts['home'])
  Front.set(:home, home)
  @log.info("Time: #{Time.now.utc.iso8601}; CPUs: #{Concurrent.processor_count}")
  @log.info("Home directory: #{home}")
  @log.info("Ruby version: #{RUBY_VERSION}/#{RUBY_PLATFORM}")
  @log.info("Zold gem version: #{Zold::VERSION}")
  @log.info("Zold protocol version: #{Zold::PROTOCOL}")
  @log.info("Network ID: #{opts['network']}")
  @log.info('Front caching is disabled via --no-cache') if opts['no-cache']
  host = opts[:host] || ip
  port = opts[:port]
  address = "#{host}:#{port}".downcase
  @log.info("Node location: #{address}")
  @log.info("Local address: http://127.0.0.1:#{opts['bind-port']}/")
  @log.info("Remote nodes (#{@remotes.all.count}): \
#{@remotes.all.map { |r| "#{r[:host]}:#{r[:port]}" }.join(', ')}")
  @log.info("Wallets at: #{@wallets.path}")
  if opts['standalone']
    @remotes = Remotes::Empty.new
    @log.info('Running in standalone mode! (will never talk to other remotes)')
  elsif @remotes.exists?(host, port)
    Remote.new(remotes: @remotes).run(['remote', 'remove', host, port.to_s])
    @log.info("Removed current node (#{address}) from list of remotes")
  end
  if File.exist?(@copies)
    FileUtils.rm_rf(@copies)
    @log.info("Directory #{@copies} deleted")
  end
  wts = @wallets
  if opts['not-hungry']
    @log.info('Hungry pulling disabled because of --not-hungry')
  else
    hungry = ThreadPool.new('hungry', log: @log)
    wts = HungryWallets.new(@wallets, @remotes, @copies, hungry, log: @log, network: opts['network'])
  end
  Front.set(:zache, Zache.new(dirty: true))
  Front.set(:wallets, wts)
  Front.set(:remotes, @remotes)
  Front.set(:copies, @copies)
  Front.set(:address, address)
  Front.set(:root, home)
  ledger = File.join(home, 'ledger.csv')
  Front.set(:ledger, ledger)
  Front.set(:opts, opts)
  Front.set(:dump_errors, opts['dump-errors'])
  Front.set(:port, opts['bind-port'])
  async_dir = File.join(home, '.zoldata/async-entrance')
  FileUtils.mkdir_p(async_dir)
  Front.set(:async_dir, async_dir)
  journal_dir = File.join(home, '.zoldata/journal')
  FileUtils.mkdir_p(journal_dir)
  Front.set(:journal_dir, journal_dir)
  Front.set(:node_alias, node_alias(opts, address))
  entrance = SafeEntrance.new(
    NoSpamEntrance.new(
      NoDupEntrance.new(
        AsyncEntrance.new(
          SpreadEntrance.new(
            SyncEntrance.new(
              Entrance.new(
                wts,
                JournaledPipeline.new(
                  Pipeline.new(
                    @remotes, @copies, address,
                    ledger: ledger,
                    network: opts['network']
                  ),
                  journal_dir
                ),
                log: @log
              ),
              File.join(home, '.zoldata/sync-entrance'),
              log: @log
            ),
            wts, @remotes, address,
            log: @log,
            ignore_score_weakeness: opts['ignore-score-weakness'],
            tolerate_edges: opts['tolerate-edges']
          ),
          async_dir,
          log: @log,
          queue_limit: opts['queue-limit']
        ),
        wts,
        log: @log
      ),
      period: opts['allow-spam'] ? 0 : 60 * 60,
      log: @log
    ),
    network: opts['network']
  )
  entrance.start do |ent|
    Front.set(:entrance, ent)
    farm = Farm.new(
      invoice(opts), File.join(home, 'farm'),
      log: @log, farmer: farmer(opts), strength: opts[:strength]
    )
    farm.start(host, opts[:port], threads: opts[:threads]) do |f|
      Front.set(:farm, f)
      metronome(f, opts, host, port).start do |metronome|
        Front.set(:metronome, metronome)
        @log.info("Starting up the web front at http://#{host}:#{opts[:port]}...")
        Front.run!
        @log.info("The web front stopped at http://#{host}:#{opts[:port]}")
      end
    end
  end
  hungry.kill unless opts['not-hungry']
  @log.info('Thanks for helping Zold network!')
end