Module: CardanoUp::Start

Defined in:
lib/cardano-up/start.rb

Overview

Start cardano-node and cardano-wallet on your system.

For Linux and MacOS it will attempt to start separate screen sessions for wallet and node respectively, therefore ‘screen’ tool is required on your system. If screen is not present you can install it using your package manager for instance:

# MacOS:
brew install screen
# Linux:
sudo apt-get install screen

For Windows it will attepmt to install cardano-node and cardano-wallet as Windows services using ‘nssm’ tool. Nssm can be installed via choco package manager:

choco install nssm

See Also:

Class Method Summary collapse

Class Method Details

.prepare_configuration(opt = { env: 'mainnet', wallet_port: '8090' }) ⇒ Object

Prepare configuration for wallet and node to be started

Parameters:

  • env (Hash) —

    provide env and wallet_port, e.g. { env: ‘mainnet’, wallet_port: ‘8090’ }

Raises:

  • CardanoUp::EnvNotSupportedError

  • CardanoUp::WalletPortError



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/cardano-up/start.rb', line 26

def self.prepare_configuration(opt = { env: 'mainnet', wallet_port: '8090' })
  env = opt[:env]
  raise CardanoUp::EnvNotSupportedError, env unless CardanoUp::ENVS.include? env

  wallet_port = opt[:wallet_port]
  raise CardanoUp::WalletPortError if wallet_port.nil? || wallet_port.empty?

  token_metadata_server = env == 'mainnet' ? CardanoUp::MAINNET_TOKEN_SERVER : CardanoUp::TESTNET_TOKEN_SERVER

  CardanoUp.configure_default unless CardanoUp.configured?
  configs = CardanoUp.config
  bin_dir = configs['bin_dir']
  config_dir = File.join(configs['config_dir'], env)
  log_dir = File.join(configs['log_dir'], env)
  state_dir = File.join(configs['state_dir'], env)
  wallet_db_dir = File.join(state_dir, 'wallet-db')
  node_db_dir = File.join(state_dir, 'node-db')
  [bin_dir, config_dir, log_dir, state_dir, wallet_db_dir, node_db_dir].each do |dir|
    FileUtils.mkdir_p(dir)
  end

  node_socket = if CardanoUp::Utils.win?
                  "\\\\.\\pipe\\cardano-node-#{env}"
                else
                  File.join(state_dir, 'node.socket')
                end
  network = env == 'mainnet' ? '--mainnet' : "--testnet #{config_dir}/byron-genesis.json"

  {
    env: env,
    wallet_port: wallet_port,
    token_metadata_server: token_metadata_server,
    bin_dir: bin_dir,
    config_dir: config_dir,
    log_dir: log_dir,
    state_dir: state_dir,
    wallet_db_dir: wallet_db_dir,
    node_db_dir: node_db_dir,
    node_socket: node_socket,
    network: network
  }
end

.start_node(configuration) ⇒ Object

Parameters:

  • configuration (Hash) —

    output of prepare_configuration



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/cardano-up/start.rb', line 70

def self.start_node(configuration)
  env = configuration[:env]
  bin_dir = configuration[:bin_dir]
  config_dir = configuration[:config_dir]
  log_dir = configuration[:log_dir]
  node_db_dir = configuration[:node_db_dir]
  node_socket = configuration[:node_socket]

  exe = CardanoUp::Utils.win? ? '.exe' : ''
  version = CardanoUp::Utils.cmd "#{bin_dir}/cardano-node#{exe} version"

  if CardanoUp::Utils.win?
    # Turn off p2p for Windows
    # TODO: remove after https://github.com/input-output-hk/ouroboros-network/issues/3968 released
    config_win = JSON.parse(File.read("#{config_dir}/config.json"))
    config_win['EnableP2P'] = false
    File.write("#{config_dir}/config.json", JSON.pretty_generate(config_win))
    topology = %({
          "Producers": [
            {
              "addr": "#{env}-node.world.dev.cardano.org",
              "port": 30002,
              "valency": 2
            }
          ]
        })
    File.write("#{config_dir}/topology.json", topology)

    # create cardano-node.bat file
    node_cmd = ["#{bin_dir}/cardano-node.exe run",
                "--config #{config_dir}/config.json",
                "--topology #{config_dir}/topology.json",
                "--database-path #{node_db_dir}",
                "--socket-path #{node_socket}"].join(' ')
    File.write("#{bin_dir}/cardano-node.bat", node_cmd)
    node_service = "cardano-node-#{env}"
    install_node = "nssm install #{node_service} #{bin_dir}/cardano-node.bat"
    log_stdout_node = "nssm set #{node_service} AppStdout #{log_dir}/node.log"
    log_stderr_node = "nssm set #{node_service} AppStderr #{log_dir}/node.log"
    start_node = "nssm start #{node_service}"

    CardanoUp::Utils.cmd install_node
    CardanoUp::Utils.cmd log_stdout_node
    CardanoUp::Utils.cmd log_stderr_node
    CardanoUp::Utils.cmd start_node
  else
    node_cmd = ["#{bin_dir}/cardano-node run",
                "--config #{config_dir}/config.json",
                "--topology #{config_dir}/topology.json",
                "--database-path #{node_db_dir}",
                "--socket-path #{node_socket}"].join(' ')
    node_service = "NODE_#{env}"
    CardanoUp::Utils.cmd "screen -dmS #{node_service} -L -Logfile #{log_dir}/node.log #{node_cmd}"
  end

  {
    node: {
      service: node_service,
      network: env,
      version: version,
      log: "#{log_dir}/node.log",
      db_dir: node_db_dir,
      socket_path: node_socket,
      protocol_magic: get_protocol_magic(config_dir),
      bin: node_cmd.split.first,
      cmd: node_cmd
    }
  }
end

.start_node_and_wallet(configuration) ⇒ Object

Parameters:

  • configuration (Hash) —

    output of prepare_configuration



201
202
203
204
205
 
# File 'lib/cardano-up/start.rb', line 201

def self.start_node_and_wallet(configuration)
  cn = start_node(configuration)
  cw = start_wallet(configuration)
  cn.merge(cw)
end

.start_wallet(configuration) ⇒ Object

Parameters:

  • configuration (Hash) —

    output of prepare_configuration



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/cardano-up/start.rb', line 141

def self.start_wallet(configuration)
  env = configuration[:env]
  wallet_port = configuration[:wallet_port]
  token_metadata_server = configuration[:token_metadata_server]
  bin_dir = configuration[:bin_dir]
  log_dir = configuration[:log_dir]
  wallet_db_dir = configuration[:wallet_db_dir]
  node_socket = configuration[:node_socket]
  network = configuration[:network]

  exe = CardanoUp::Utils.win? ? '.exe' : ''
  version = CardanoUp::Utils.cmd "#{bin_dir}/cardano-wallet#{exe} version"

  if CardanoUp::Utils.win?

    # create cardano-wallet.bat file
    wallet_cmd = ["#{bin_dir}/cardano-wallet.exe serve",
                  "--port #{wallet_port}",
                  "--node-socket #{node_socket}",
                  network.to_s,
                  "--database #{wallet_db_dir}",
                  "--token-metadata-server #{token_metadata_server}"].join(' ')
    File.write("#{bin_dir}/cardano-wallet.bat", wallet_cmd)
    wallet_service = "cardano-wallet-#{env}"
    install_wallet = "nssm install #{wallet_service} #{bin_dir}/cardano-wallet.bat"
    log_stdout_wallet = "nssm set #{wallet_service} AppStdout #{log_dir}/wallet.log"
    log_stderr_wallet = "nssm set #{wallet_service} AppStderr #{log_dir}/wallet.log"
    start_wallet = "nssm start #{wallet_service}"

    CardanoUp::Utils.cmd install_wallet
    CardanoUp::Utils.cmd log_stdout_wallet
    CardanoUp::Utils.cmd log_stderr_wallet
    CardanoUp::Utils.cmd start_wallet
  else
    wallet_cmd = ["#{bin_dir}/cardano-wallet serve",
                  "--port #{wallet_port}",
                  "--node-socket #{node_socket}",
                  network.to_s,
                  "--database #{wallet_db_dir}",
                  "--token-metadata-server #{token_metadata_server}"].join(' ')
    wallet_service = "WALLET_#{env}"
    CardanoUp::Utils.cmd "screen -dmS #{wallet_service} -L -Logfile #{log_dir}/wallet.log #{wallet_cmd}"
  end

  {
    wallet: {
      service: wallet_service,
      network: env,
      version: version,
      log: "#{log_dir}/wallet.log",
      db_dir: wallet_db_dir,
      port: wallet_port.to_i,
      host: "http://localhost:#{wallet_port}/v2",
      bin: wallet_cmd.split.first,
      cmd: wallet_cmd
    }
  }
end

.stop_node(env) ⇒ Object

Raises:

  • CardanoUp::EnvNotSupportedError



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/cardano-up/start.rb', line 208

def self.stop_node(env)
  raise CardanoUp::EnvNotSupportedError, env unless CardanoUp::ENVS.include? env

  if CardanoUp::Utils.win?
    CardanoUp::Utils.cmd "nssm stop cardano-node-#{env}"
    CardanoUp::Utils.cmd "nssm remove cardano-node-#{env} confirm"
  else
    CardanoUp::Utils.cmd "screen -S NODE_#{env} -X at '0' stuff '^C'"
    CardanoUp::Utils.cmd "screen -XS NODE_#{env} quit"
  end
end

.stop_node_and_wallet(env) ⇒ Object

Raises:

  • CardanoUp::EnvNotSupportedError



234
235
236
237
 
# File 'lib/cardano-up/start.rb', line 234

def self.stop_node_and_wallet(env)
  stop_wallet(env)
  stop_node(env)
end

.stop_wallet(env) ⇒ Object

Raises:

  • CardanoUp::EnvNotSupportedError



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cardano-up/start.rb', line 221

def self.stop_wallet(env)
  raise CardanoUp::EnvNotSupportedError, env unless CardanoUp::ENVS.include? env

  if CardanoUp::Utils.win?
    CardanoUp::Utils.cmd "nssm stop cardano-wallet-#{env}"
    CardanoUp::Utils.cmd "nssm remove cardano-wallet-#{env} confirm"
  else
    CardanoUp::Utils.cmd "screen -S WALLET_#{env} -X at '0' stuff '^C'"
    CardanoUp::Utils.cmd "screen -XS WALLET_#{env} quit"
  end
end