nis-ruby 0.0.16 → 0.0.17

data/examples/node/active_peers.rb

@@ -0,0 +1,6 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.node_active_peers_max_chain_height

data/examples/node/boot.rb

@@ -0,0 +1,25 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
+
+bnr = Nis::Struct::BootNodeRequest.new(
+  metaData: {
+    application: 'NIS'
+  },
+  endpoint: {
+    protocol: 'http',
+    port: 7890,
+    host: 'localhost'
+  },
+  identity: {
+    'private-key': 'a6cbd01d04edecfaef51df9486c111abb6299c764a00206eb1d01f4587491b3f',
+    name: 'Alice'
+  }
+)
+
+begin
+  p nis.node_boot(boot_node_request: bnr)
+rescue => ex
+  p ex
+end

data/examples/node/info.rb

@@ -0,0 +1,8 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.node_info
+p nis.node_extended_info
+p nis.node_experiences

data/examples/node/peerlist.rb

@@ -0,0 +1,14 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+# mapped methods
+p nis.node_peerlist_all
+p nis.node_peerlist_reachable
+p nis.node_peerlist_active
+
+# another way
+p nis.node_peerlist(:all)
+p nis.node_peerlist(:reachable)
+p nis.node_peerlist(:active)

data/examples/time_sync/network_time.rb

@@ -0,0 +1,6 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
+
+p nis.time_sync_network_time

data/examples/transactions/get.rb

@@ -0,0 +1,42 @@
+require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+nis = Nis.new(host: '23.228.67.85')
+
+# transfer
+hash = 'a7131c0836da45e72f61ac6e76259d7200a85f0d2cf38f79f223b2c366673b08'
+p nis.transaction_get(hash: hash)
+
+# important transfer
+hash = '0765dbe0e79c2a57f2f71ae77f915d67b66290b2f72db5b3537bb32a1b09e2bf'
+p nis.transaction_get(hash: hash)
+
+# multisig aggregate modification
+hash = '9593e7846c01a3a8c00363af9ae7a333cc11e266eb88636957578ae0d9f495a3'
+p nis.transaction_get(hash: hash)
+
+# multisig signature
+# hash = ''
+# p nis.transaction_get(hash: hash)
+
+# transfer (multisig)
+hash = '4185cad053f0bc7a2b3b9e5adc493e81a5af2f0a431f3d34ba2a25c937731629'
+p nis.transaction_get(hash: hash)
+
+# aggregate (multisig)
+hash = 'f7d385a4c8b78d8a6a91c7b778df4ae793394c9c8bfeeca1393bf43770328a06'
+p nis.transaction_get(hash: hash)
+
+# provision namespace
+hash = '63a3982228b68de56c73896d394cfa3698d7d81e7aec89ea1a77a6d68d103d22'
+p nis.transaction_get(hash: hash)
+
+# mosaic definition creation
+hash = '0a16d30f57d65c5241cb0894a50fee51efbf6ff25a7a605de10423819234ab5d'
+p nis.transaction_get(hash: hash)
+
+# mosaic supply change
+hash = '7d2c7f4c2895075a4c1bf2fdceba3781c3a80313e6979c29f1cd83277fe64ded'
+p nis.transaction_get(hash: hash)

data/examples/transactions/importance_transfer.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # sender
 A_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
@@ -9,11 +12,10 @@ B_PUBLIC_KEY = 'cc6c9485d15b992501e57fe3799487e99de272f79c5442de94eeb998b45e0144
 kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 tx = Nis::Transaction::ImportanceTransfer.new(B_PUBLIC_KEY, :activate)
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/mosaic_definition_creation.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # mosaic creator
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -37,11 +40,10 @@ definition = Nis::Struct::MosaicDefinition.new(
 )
 
 tx = Nis::Transaction::MosaicDefinitionCreation.new(definition)
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/mosaic_supply_change.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # mosaic owner
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -11,11 +14,10 @@ mosaic_id = Nis::Struct::MosaicId.new(
 )
 
 tx = Nis::Transaction::MosaicSupplyChange.new(mosaic_id, :increase, 1_000)
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/multisig.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # multisig
 M_PUBLIC_KEY  = '00f077782658ae91b77f238ba5fcd7ef110564b5c189072e4d4590d9b17f9d76f3'
@@ -13,11 +16,10 @@ kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 ttx = Nis::Transaction::Transfer.new(B_ADDRESS, 1, 'Good luck!')
 tx = Nis::Transaction::Multisig.new(ttx, M_PUBLIC_KEY)
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/multisig_add_cosignatory.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # multisig
 M_PUBLIC_KEY  = '6d72b57d2bc199d328e7ea3e24775f7f614760bc18f3f8501cd3daa9870cc40c'
@@ -20,7 +23,6 @@ min_cosigs = 1
 mtx = Nis::Transaction::MultisigAggregateModification.new([mcm], min_cosigs)
 tx = Nis::Transaction::Multisig.new(mtx, M_PUBLIC_KEY)
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 

data/examples/transactions/multisig_aggregate_modification.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # multisig
 M_PRIVATE_KEY = '00f077782658ae91b77f238ba5fcd7ef110564b5c189072e4d4590d9b17f9d76f3'
@@ -16,11 +19,10 @@ mcm = Nis::Struct::MultisigCosignatoryModification.new(
 min_cosigs = 1
 
 tx = Nis::Transaction::MultisigAggregateModification.new([mcm], min_cosigs)
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/multisig_signature.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # multisig
 M_PUBLIC_KEY = '6d72b57d2bc199d328e7ea3e24775f7f614760bc18f3f8501cd3daa9870cc40c'
@@ -24,12 +27,12 @@ unless txes.size > 0
 end
 
 hash = txes.first.meta.data
-puts "Unconfirmed Transaction Hash: #{hash}"
+p "Unconfirmed Transaction Hash: #{hash}"
 
 tx = Nis::Transaction::MultisigSignature.new(hash, M_ADDRESS, B_PUBLIC_KEY)
 
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/provision_namespace.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # namespace creator
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -6,11 +9,10 @@ A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b83421
 kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 tx = Nis::Transaction::ProvisionNamespace.new('sushi')
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/transfer.rb

@@ -1,4 +1,13 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+# output debug log example
+# Nis.configure do |conf|
+#   conf.logger = Logger.new('./nis-ruby.log')
+#   conf.logger.level = Logger::DEBUG
+# end
+
+nis = Nis.new
 
 # sender
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -9,17 +18,15 @@ B_PUBLIC_KEY = '9e7ab2924cd1a3482df784db190614cfc8a33671f5d80a5b15a9c9e8b4d13933
 
 kp = Nis::Keypair.new(A_PRIVATE_KEY)
 tx = Nis::Transaction::Transfer.new(B_ADDRESS, 1, 'Good luck!')
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"
 
 # with encrypted message
-
 message = Nis::Struct::Message.new('Good luck!', type: :encrypted,
   private_key: kp.private,
   public_key: B_PUBLIC_KEY
@@ -30,5 +37,5 @@ puts "Fee: #{tx.fee.to_i}"
 
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/transfer_mosaic.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new
 
 # sender
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -9,7 +12,6 @@ B_ADDRESS = 'TA4TX6U5HG2MROAESH2JE5524T4ZOY2EQKQ6ELHF'
 kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 # fetch mosaic definition
-nis = Nis.new
 mo_dmdps = nis.namespace_mosaic_definition_page(namespace: 'kon')
 mo_def = mo_dmdps.first.mosaic
 
@@ -48,5 +50,5 @@ tx.mosaics << Nis::Struct::MosaicAttachment.new(mo_def, 1)
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
 res = nis.transaction_prepare_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/examples/transactions/transfer_remote.rb

@@ -1,4 +1,7 @@
 require 'nis'
+Nis.logger.level = Logger::DEBUG
+
+nis = Nis.new(host: '23.228.67.85')
 
 # sender
 A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
@@ -9,11 +12,10 @@ B_ADDRESS = 'TA4TX6U5HG2MROAESH2JE5524T4ZOY2EQKQ6ELHF'
 kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 tx = Nis::Transaction::Transfer.new(B_ADDRESS, 1, 'Good luck!')
-puts "Fee: #{tx.fee.to_i}"
+p "Fee: #{tx.fee.to_i}"
 
-nis = Nis.new(host: '104.128.226.60')
 req = Nis::Request::Announce.new(tx, kp)
 res = nis.transaction_announce(req)
 
-puts "Message: #{res.message}"
-puts "TransactionHash: #{res.transaction_hash}"
+p "Message: #{res.message}"
+p "TransactionHash: #{res.transaction_hash}"

data/lib/nis.rb

@@ -1,4 +1,5 @@
 require 'nis/version'
+require 'nis/configuration'
 require 'nis/mixin'
 require 'nis/util'
 require 'nis/keypair'
@@ -13,6 +14,8 @@ require 'nis/error'
 
 # API Ruby Wrapper for NEM Infrastructure Server
 class Nis
+  extend Nis::Configuration
+
   extend Forwardable
 
   def_delegators :@client, :request, :request!
@@ -56,6 +59,7 @@ class Nis
   include Nis::Endpoint::Block::At
   include Nis::Endpoint::Block::Get
 
+  include Nis::Endpoint::Transaction::Get
   include Nis::Endpoint::Transaction::PrepareAnnounce
   include Nis::Endpoint::Transaction::Announce
 
@@ -69,6 +73,8 @@ class Nis
   include Nis::Endpoint::Node::Info
   include Nis::Endpoint::Node::PeerList
 
+  include Nis::Endpoint::TimeSync::NetworkTime
+
   include Nis::Endpoint::Debug::Connections
   include Nis::Endpoint::Debug::TimeSynchronization
 end

data/lib/nis/client.rb

@@ -15,6 +15,7 @@ class Nis::Client
   }.freeze
 
   LOCAL_ONLY_PATHES = [
+    '/account/generate',
     '/local/account/transfers/incoming',
     '/local/account/transfers/outgoing',
     '/local/account/transfers/all',
@@ -40,6 +41,7 @@ class Nis::Client
   # @param [Hash] params API Parameters
   # @return [Hash] Hash converted API Response
   def request(method, path, params = {})
+    log(method, path, params)
     if connection.remote? && local_only?(path)
       raise Nis::Error, "The request (#{method} #{path}) is only permitted to local NIS."
     end
@@ -120,6 +122,15 @@ class Nis::Client
     options
   end
 
+  def log(method, path, params)
+    Nis.logger.debug "host:%s\tmethod:%s\tpath:%s\tparams:%s" % [
+      connection.url_prefix,
+      method,
+      path,
+      params.to_hash
+    ]
+  end
+
   module Local
     def local?
       host == '127.0.0.1' || host == 'localhost'

data/lib/nis/configuration.rb

@@ -0,0 +1,23 @@
+require 'logger'
+
+class Nis
+  module Configuration
+    # Logger for {#debug}, default is `Nis::Logger.new(STDOUT)`
+    # @return [Logger]
+    attr_accessor :logger
+
+    def self.extended(base)
+      base.logger = Logger.new($stdout).tap { |logger| logger.level = Logger::INFO }
+    end
+
+    # @yield [self]
+    # @example
+    #   Nis.configure do |conf|
+    #     conf.logger = Logger.new('path/to/nis-ruby.log')
+    #     conf.logger.level = Logger::DEBUG
+    #   end
+    def configure
+      yield self
+    end
+  end
+end