nxtbase: node management and command line tools

[ferment]

Hello all:

I put together a little project to simplify the management of a nxt node on Linux and MacOS. You can easily download and deploy the most recent version, start, stop, lock/unlock, and generate hallmarks. More fun cli tools are planned.

See the README for more info:
https://github.com/fermentNXT/nxtbase

The error handling and stuff is pretty bare right now. I'll make things more robust as I go. Please post feedback, questions, bug reports, etc to this thread.

Thanks,
Ferm

Quick Start:
1. Install nxtbase

Code: [Select]

$ git clone https://github.com/fermentNXT/nxtbase.git
$ cd nxtbase-or-

Code: [Select]

$ curl -O -L https://github.com/fermentNXT/nxtbase/archive/master.zip
$ unzip master.zip
$ cd nxtbase-master
2. Install JDK (example for Ubuntu in bin/ubuntu_setup)
3. Download latest version and create symlink to ./nxt.

Code: [Select]

bin/deploy-or-

Code: [Select]

bin/deploy experimental
Basic Commands
bin/start - starts current version
bin/stop - stops running node
bin/kill - stops running node with 'kill -9'

More Configuration
1. Copy etc/web.xml.default (or etc/web-experimental.xml.default).

Code: [Select]

$ cp etc/web.xml.default etc/web.xml

2. Get your address

Code: [Select]

$ bin/myinfo nxtbase.com
3. Generate hallmark

Code: [Select]

$ bin/hallmark your_address_here
4. Update etc/web.xml with address

Code: [Select]

<init-param>
  <param-name>myAddress</param-name>
  <param-value>PUT_ADDRESS_HERE</param-value>
</init-param>

5. Update etc/web.xml with hallmark

Code: [Select]

<init-param>
 <param-name>myHallmark</param-name>
  <param-value>PUT_HALLMARK_HERE</param-value>
</init-param>

6. Copy etc/web.xml (bin/deploy will do this automatically).

Code: [Select]

$ cp etc/web.xml nxt/webapps/root/WEB-INF/

7. Restart

Code: [Select]

$ bin/stop
$ bin/start

Advanced commands
bin/unlock - unlocks account for mining
bin/lock - locks account back
bin/setup_ubuntu - installs the jdk and updates open file limits. run as sudo. requires reboot. use at own risk!

UPDATE: new nxt client cli too!

bin/nxt is a command line tool for interacting with a nxt node. it is written in ruby.

To get started:
1. Install Ruby
2. Install dependent gems:

Code: [Select]


$ gem install thor json httparty
3. check out the help

Code: [Select]

$ bin/nxt help

Following commands are available:

Code: [Select]

Commands:
  nxt balance ACCOUNT              # Get the balance of an account
  nxt block BLOCK                  # Get block info
  nxt decode_hallmark HALLMARK     # Decode a given hallmark
  nxt decode_token TOKEN WEBSITE   # Decode a token for a given website
  nxt help [COMMAND]               # Describe available commands or one specific command
  nxt my_info ADDRESS              # Get info of this client from a server
  nxt peer ADDRESS                 # Get info on a peer
  nxt peers                        # Gets a list of peers
  nxt state                        # Get the state
  nxt time                         # Retrieves current time measured in seconds since the genesis block timestamp
  nxt transaction TRANSACTION      # Get transaction info
  nxt unconfirmed_transaction_ids  # List of transactions pending inclusion in blocks

Example using localhost:

Code: [Select]

$ bin/nxt state

Example using a remote server:

Code: [Select]

$ bin/nxt state --server node1.nxtbase.com

The corresponding scripts for the above commands have been removed from bin/. The remainder of the NXT api will be added over the next day. Eventually I'm going to move the ruby stuff into it's own gem later this week. Please play with it and let me know if you have any problem.

[Graviton]

Looks very useful! Will be trying out soon.

[ferment]

Added new commands for balance, decode_token, decode_hallmark, peers, peer, and state.

They return JSON at the moment, but still readable.

[NxtChoice]

More Configuration
1. Copy etc/web.xml.default (or etc/web-experimental.xml.default).

Code: [Select]

$ cp etc/web.xml.default etc/web/xml


It may be

Code: [Select]

cp etc/web.xml.default etc/web.xml


[ferment]

It may be

Code: [Select]

cp etc/web.xml.default etc/web.xml


Good catch! Fixed the typo above.

[jefdiesel]

Permission denied (publickey) from github

I've not really used this before. Ideas?

[ferment]

Permission denied (publickey) from github

I've not really used this before. Ideas?

try this:

Code: [Select]

git clone https://github.com/fermentNXT/nxtbase.git


[jefdiesel]

awesome
thanks

[ferment]

Just added support for etc/start.ini. You can change things like what interface to listen, memory settings, etc. If you change the IP address of jetty, all of the tools in bin/ will bust. Working on a fix...

[ferment]

Created and added well known peers to web.xml.default:

node1.nxtbase.com
node2.nxtbase.com
node3.nxtbase.com
node4.nxtbase.com
node5.nxtbase.com
node6.nxtbase.com
node7.nxtbase.com
node8.nxtbase.com
node9.nxtbase.com
node10.nxtbase.com

TODO:
log management
service supervisor
remote control (via capistrano)
ruby cli tool to replace bash scripts
more automation of new node setup
scout support

[ferment]

UPDATE: new nxt client cli too!

bin/nxt is a command line tool for interacting with a nxt node. it is written in ruby.

To get started:
0. git pull in your existing nxtbase directory

Code: [Select]

$ git pull
1. Install Ruby
2. Install dependent gems:

Code: [Select]


$ gem install thor json httparty
3. check out the help

Code: [Select]

$ bin/nxt help

Following commands are available:

Code: [Select]

Commands:
  nxt balance ACCOUNT             # Get the balance of an account
  nxt decode_hallmark HALLMARK    # Decode a given hallmark
  nxt decode_token TOKEN WEBSITE  # Decode a token for a given website
  nxt help [COMMAND]              # Describe available commands or one specific command
  nxt my_info ADDRESS             # Get info of this client from a server
  nxt peer ADDRESS                # Get info on a peer
  nxt peers                       # Gets peers of the the specified node
  nxt state                       # Get the state of a server

Example using localhost:

Code: [Select]

$ bin/nxt state

Example using a remote server:

Code: [Select]

$ bin/nxt state --server node1.nxtbase.com

The corresponding scripts for the above commands have been removed from bin/. The remainder of the NXT api will be added over the next day. Eventually I'm going to move the ruby stuff into it's own gem later this week. Please play with it and let me know if you have any problem.

[ferment]

Added more APIs: time, block, transaction, unconfirmed_transaction_ids.

[ferment]

Upgrade to 0.3.20 in 1 minute!

Code: [Select]

$ git pull
$ cp etc/web.xml etc/web.xml.bak
$ cp etc/web.xml.default etc/web.xml
$ <update web.xml with your address and hallmark>
$ bin/stop
$ bin/deploy
$ bin/start

Easy, huh?

[krisjoseph]

LOVE IT!

I've added a link to this thread (and the utility) to the Nxt Wiki's software section.