Nanook
This is a Ruby library for managing a nano currency node, including making and receiving payments, using the nano RPC protocol. Nano is a fee-less, fast, environmentally-friendly cryptocurrency. It's awesome. See https://nano.org.
Installation
Add this line to your application's Gemfile:
gem 'nanook', "~> 1.0"
And then execute:
$ bundle
Or install it yourself as:
$ gem install nanook
Getting Started
Initializing
Nanook will by default connect to http://localhost:7076.
nanook = Nanook.new
To connect to another host instead:
nanook = Nanook.new("http://ip6-localhost:7076")
Basics
Working with wallets and accounts
Create a wallet:
Nanook.new.wallet.create
Create an account within a wallet:
Nanook.new.wallet(wallet_id).account.create
List accounts within a wallet:
Nanook.new.wallet(wallet_id).accounts
Sending a payment
To send a payment from an account in a wallet:
account = Nanook.new.wallet(wallet_id).account(account_id)
account.pay(to: recipient_account_id, amount: 0.2, id: unique_id)
Or, a wallet:
wallet = Nanook.new.wallet(wallet_id)
wallet.pay(from: your_account_id, to: recipient_account_id, amount: 0.2, id: unique_id)
The id can be any string and needs to be unique per payment. It serves an important purpose; it allows you to make this call multiple times with the same id and be reassured that you will only ever send that nano payment once. From the Nano RPC:
You can (and should) specify a unique id for each spend to provide idempotency. That means that if you [make the payment call] two times with the same id, the second request won't send any additional Nano.
The unit of the amount is NANO (which is currently technically Mnano — see What are Nano's Units). You can pass an amount of raw instead by adding the unit: :raw argument:
account.pay(to: recipient_account_id, amount: 999, unit: :raw, id: unique_id)
Note, there may be a delay in receiving a response due to Proof of Work being done. From the Nano RPC:
Proof of Work is precomputed for one transaction in the background. If it has been a while since your last transaction it will send instantly, the next one will need to wait for Proof of Work to be generated.
Receiving a payment
The simplest way to receive a payment is:
account = Nanook.new.wallet(wallet_id).account(account_id)
account.receive
# or:
wallet = Nanook.new.wallet(wallet_id)
wallet.receive(into: account_id)
The receive method when called as above will receive the latest pending payment for an account in a wallet. It will either return a block hash if a payment was received, or false if there were no pending payments to receive.
You can also receive a specific pending block if you know it (you may have discovered it through calling account.pending for example):
account = Nanook.new.wallet(wallet_id).account(account_id)
account.receive(block_id)
# or:
wallet = Nanook.new.wallet(wallet_id)
wallet.receive(block_id, into: account_id)
All commands
Below is a quick reference list of commands. See the full Nanook documentation for a searchable detailed description of every class and method, what the arguments mean, and example responses (Tip: expand the "Nanook < Object" item in the sidebar).
Wallets
See the full documentation for Nanook::Wallet for a detailed description of each method and example responses.
Create wallet:
Nanook.new.wallet.create
Working with a single wallet:
wallet = Nanook.new.wallet(wallet_id)
wallet.balance
wallet.balance(account_break_down: true)
wallet.balance(unit: :raw)
wallet.pay(from: your_account_id, to: recipient_account_id, amount: 2, id: unique_id)
wallet.pay(from: your_account_id, to: recipient_account_id, amount: 2, unit: :raw, id: unique_id)
wallet.receive(into: account_id)
wallet.receive(pending_block_id, into: account_id)
wallet.account.create
wallet.accounts
wallet.contains?(account_id)
wallet.export
wallet.locked?
wallet.unlock(password)
wallet.change_password(password)
wallet.destroy
Accounts
Create account:
Nanook.new.wallet(wallet_id).account.create
Working with a single account:
account = Nanook.new.wallet(wallet_id).account(account_id)
account.balance
account.balance(unit: :raw)
account.pay(to: recipient_account_id, amount: 2, id: unique_id)
account.pay(to: recipient_account_id, amount: 2, unit: :raw, id: unique_id)
account.pending
account.pending(limit: 1)
account.receive
account.receive(pending_block_id)
account.exists?
account.info
account.info(detailed: true)
account.ledger
account.ledger(limit: 10)
account.history
account.history(limit: 1)
account.public_key
account.delegators
account.representative
account.weight
account.destroy
Working with any account (not necessarily in your wallet):
See the full documentation for Nanook::Account for a detailed description of each method and example responses.
account = Nanook.new.account(account_id)
account.balance
account.balance(unit: :raw)
account.pending
account.pending(limit: 1)
account.exists?
account.info
account.info(detailed: true)
account.ledger
account.ledger(limit: 10)
account.history
account.history(limit: 1)
account.public_key
account.delegators
account.representative
account.weight
Blocks
See the full documentation for Nanook::Block for a detailed description of each method and example responses.
block = Nanook.new.block(block_id)
block.info # Verified blocks in the ledger
block.info(allow_unchecked: true) # Verified blocks AND unchecked synchronizing blocks
block.account
block.chain
block.chain(limit: 10)
block.history
block.history(limit: 10)
block.republish
block.republish(sources: 2)
block.republish(destinations: 2)
block.pending?
block.publish
block.successors
block.successors(limit: 10)
block.generate_work
block.cancel_work
block.is_valid_work?(work_id)
Managing your nano node
node = Nanook.new.node
node.block_count
node.block_count_type
node.bootstrap_any
node.bootstrap(address: "::ffff:138.201.94.249", port: 7075)
node.frontier_count
node.peers
node.representatives
node.representatives
node.sync_progress
node.synced?
node.version
node.stop
Work peers
work_peers = Nanook.new.work_peers
work_peers.add(address: "::ffff:172.17.0.1:7076", port: 7076)
work_peers.clear
work_peers.list
Keys
Create private public key pair:
Nanook.new.key.generate
Nanook.new.key.generate(seed: seed, index: 0)
Working with a single key
key = Nanook.new.key(private_key)
key.info
Nanook Metal
You can do any call listed in the Nano RPC directly through the rpc method. The first argument should match the action of the RPC call, and then all remaining parameters are passed in as arguments.
E.g., the accounts_create command can be called like this:
Nano.new.rpc(:accounts_create, wallet: wallet_id, count: 2)
Contributing
Bug reports and pull requests are welcome. Pull requests with passing tests are even better.
To run the test suite:
bundle exec rspec spec
To update rdoc documentation:
bundle exec rake rerdoc
License
The gem is available as open source under the terms of the MIT License.
Buy me a nano coffee
This library is totally free to use, but feel free to send some nano my way if you'd like to!
xrb_3c3ek3k8135f6e8qtfy8eruk9q3yzmpebes7btzncccdest8ymzhjmnr196j
