nis-ruby 0.0.11.1 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b71820d8d2ab72e1c4ddc2777939b2099a2ff716
-  data.tar.gz: 7bf8eef6eeed3ead69f68e40d3ffa1c63d8f3077
+  metadata.gz: 48fc594828a7e878a2d93c176aa7969eda269b74
+  data.tar.gz: dfa004cc7326b9cc581cc5e42e32fa4e6cbc7117
 SHA512:
-  metadata.gz: 891cdec923af05c61c85c9af8aa644cd2fb5ed5508bea4505ce5ebd5a93896706c91f502518079fd7da8494c02d8c4fb4819446c52e4d8b9115eafab84a3787f
-  data.tar.gz: af8eb1fa70b6d3e5b098b31e5969904598ff72956748d3f70e3e1dc496f8e49164a8bc3201839cbe38639a74b54a33f3d785f036e44ff6d405cdc1124219c21a
+  metadata.gz: 5e0b204992ea6daabbb0186484d98978a984e28598f6bb0bbd4f891143d97292c118c57993be1db835b51790649bbcd6b69c3f98a22934afb9ecd9e52c64ba12
+  data.tar.gz: dcfcace177ac5abcb30c0f90dcb83f62e4586c3a73a343d098de82b5dc9d5aadb968765a4e7628b2fa647d7aca5488eb652c6c5c3c1bdbd83b9309789ec19144

data/.travis.yml

@@ -3,7 +3,7 @@ language: ruby
 rvm:
   - 2.4.0
   - 2.3.0
-  - 2.2.0
+  - 2.2.6
 
 branches:
   only:

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Yoshiyuki Ieyama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -26,10 +26,9 @@ Or add this line to your application's Gemfile:
 gem 'nis-ruby'
 ```
 
-
 ## Usage
 
-More specific sample codes are in **samples/** directory.
+More specific example codes are in **examples/** directory.
 
 ### Methods
 
@@ -44,22 +43,16 @@ nis.status
 # => {code: 6, type: 4, message: "status"}
 # See http://bob.nem.ninja/docs/#status-request
 
+kp = Nis::Keypair.new(SENDER_PRIV_KEY)
 tx = Nis::Transaction::Transfer.new(
-  amount: 10_000_000,
-  recipient: RECIPIENT_ADDRESS,
-  signer: SENDER_PUBLIC_KEY,
-  message: Nis::Struct::Message.new('Hello'),
-  timeStamp: Nis::Util.timestamp,
-  deadline: Nis::Util.timestamp + 43_200,
-  version: Nis::Util::TESTNET_VERSION_1
-)
-
-rpa = Nis::Struct::RequestPrepareAnnounce.new(
-  transaction: tx,
-  privateKey: SENDER_PRIVATE_KEY
+  RECIPIENT_ADDRESS,
+  10_000_000,
+  'Message'
 )
-
-nis.transaction_prepare_announce(request_prepare_announce: rpa)
+req = Nis::Request::PrepareAnnounce.new(tx, kp)
+nis.transaction_prepare_announce(req)
+# See http://bob.nem.ninja/docs/#initiating-a-transfer-transaction
+# => {innerTransactionHash: {}, code: 1, type: 1, message: "SUCCESS", transactionHash: {data: "9da41fd6c6886740ae6a15c869df0470015d78103e5b216971aa09fdbcce9cde"}}
 ```
 
 ### Requesting
@@ -78,27 +71,6 @@ nis.request(:post, '/account/unlock',
 )
 # => Nothing
 # See http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
-
-tx = {
-  amount: 10_000_000,
-  fee:     1_000_000,
-  recipient: 'TALICELCD3XPH4FFI5STGGNSNSWPOTG5E4DS2TOS',
-  signer: 'a1aaca6c17a24252e674d155713cdf55996ad00175be4af02a20c67b59f9fe8a',
-  message: {
-    payload: '',
-    type: 1
-  },
-  type: 0x0101, # 257
-  timeStamp: Nis::Util.timestamp,
-  deadline: Nis::Util.timestamp + 43_200,
-  version: Nis::Util::TESTNET_VERSION_1
-}
-puts nis.request! :post, 'transaction/prepare-announce', {
-  transaction: tx,
-  privateKey: '68e4f79f886927de698df4f857de2aada41ccca6617e56bb0d61623b35b08cc0'
-}
-# => {innerTransactionHash: {}, code: 1, type: 1, message: "SUCCESS", transactionHash: {data: "9da41fd6c6886740ae6a15c869df0470015d78103e5b216971aa09fdbcce9cde"}}
-# See http://bob.nem.ninja/docs/#initiating-a-transfer-transaction
 ```
 
 
@@ -121,12 +93,10 @@ $ nis request get account/harvests --params=address:TALICELCD3XPH4FFI5STGGNSNSWP
 
 ## Connection
 
-### Environment Variable
+You can find nodes here.
+- [NEM Node Rewards](https://supernodes.nem.io/)
 
-```bash
-$ export NIS_URL=http://bigalice3.nem.ninja:7890
-$ nis heartbeat # => {"code":1,"type":2,"message":"ok"}
-```
+*Currently the gem only supports transactions for local node.*
 
 ### Hash
 
@@ -138,13 +108,23 @@ Nis.new(host: 'bigalice3.nem.ninja')
 Nis.new(url: 'http://bigalice3.nem.ninja:7890')
 ```
 
+### Environment Variable
+
+```bash
+$ export NIS_URL=http://bigalice3.nem.ninja:7890
+$ nis heartbeat # => {"code":1,"type":2,"message":"ok"}
+```
+
+Environment variable used as default value.
+
 
 ## TODO
 
 * Do more improvements
+  * Remote transaction
   * Mosaic transferring
   * Encryption message
-  * Remote transaction
+  * Be more easy to use
 
 
 ## Documentation

data/{samples/request_account.rb → examples/account.rb}

@@ -1,5 +1,4 @@
 require 'nis'
-hr = '-' * 64
 
 # create NIS instance
 nis = Nis.new
@@ -9,44 +8,37 @@ nis = Nis.new
 # Each endpoint mapped into method name.
 # It returns Nis::Struct object which mapped API response.
 keypair = nis.account_generate
-puts hr
 
 # Access properties.
 # Names are same API response.
 puts keypair.address
 puts keypair.privateKey
 puts keypair.publicKey
-puts hr
 
 # Ruby style access.
 # Also can be access property by snakecase.
 puts keypair.private_key
 puts keypair.public_key
-puts hr
 
 # hash like access.
 # Also can be access property like hash.
 puts keypair[:privateKey]
 puts keypair[:private_key]
-puts hr
 
 # Address object
 # Some property wrapped by value object.
 puts address = keypair.address
 puts address.testnet?
-puts hr
 
 # /account/get?address={address}
 #   -> account_get address: {address}
 # Passing parameters by keyword arguments.
-account_meta_pair = nis.account_get address: keypair.address
+account_meta_pair = nis.account_get(address: keypair.address)
 account = account_meta_pair[:account]
 puts account.balance
-puts hr
 
 # /account/get/from-public-key?public-key={key}
 #   -> account_get_public_key public_key: {key}
-account_meta_pair = nis.account_get_from_public_key public_key: keypair.public_key
+account_meta_pair = nis.account_get_from_public_key(public_key: keypair.public_key)
 account = account_meta_pair.account
 puts account.address
-puts hr

data/{samples/request_debug.rb → examples/debug.rb}

@@ -1,6 +1,4 @@
-require 'pp'
 require 'nis'
-hr = '-' * 64
 
 nis = Nis.new
 
@@ -9,33 +7,27 @@ incoming = nis.debug_connections_incoming
 incoming[:outstanding].each do |ai|
   puts ai.to_hash
 end
-puts hr
 
 incoming[:most_recent].each do |ai|
   puts ai.to_hash
 end
-puts hr
 
 outgoing = nis.debug_connections_outgoing
 
 outgoing[:outstanding].each do |ai|
   puts ai.to_hash
 end
-puts hr
 
 outgoing[:most_recent].each do |ai|
   puts ai.to_hash
 end
-puts hr
 
 timers = nis.debug_connections_timers
 timers.each do |t|
   puts t.to_hash
 end
-puts hr
 
 syncs = nis.debug_time_synchronization
 syncs.each do |sync|
   puts sync.to_hash
 end
-puts hr

data/{samples/request_local.rb → examples/local.rb}

@@ -1,5 +1,4 @@
 require 'nis'
-hr = '-' * 64
 
 nis = Nis.new
 
@@ -9,16 +8,12 @@ page = Nis::Struct::AccountPrivateKeyTransactionsPage.new(
 
 incoming = nis.local_account_transfers_incoming(page: page)
 puts incoming.last.to_hash
-puts hr
 
 outgoing = nis.local_account_transfers_outgoing(page: page)
 puts outgoing.last.to_hash
-puts hr
 
 all = nis.local_account_transfers_all(page: page)
 puts all.last.to_hash
-puts hr
 
 blocks = nis.local_chain_blocks_after(block_height: 2649)
 puts blocks.last
-puts hr

data/{samples/request_namespace.rb → examples/namespace.rb}

@@ -1,12 +1,9 @@
 require 'nis'
-hr = '-' * 64
 
 nis = Nis.new
 
 ns_mosaics = nis.namespace_mosaic_definition_page(namespace: 'alice.misc')
 puts ns_mosaics.first.to_hash
-puts hr
 
 ns_root = nis.namespace_root_page
 puts ns_root.first.to_hash
-puts hr

data/{samples/request_node.rb → examples/node.rb}

@@ -1,34 +1,26 @@
 require 'nis'
-hr = '-' * 64
 
 nis = Nis.new
 
 node_info = nis.node_info
 puts node_info.to_hash
-puts hr
 
 ext_node_info = nis.node_extended_info
 puts ext_node_info.to_hash
-puts hr
 
 node_exp = nis.node_experiences
 puts node_exp.first.to_hash
-puts hr
 
 peer_all = nis.node_peerlist_all
 puts peer_all.to_hash
-puts hr
 
 reachables = nis.node_peerlist_reachable
 puts reachables.first.to_hash
-puts hr
 
 actives = nis.node_peerlist_active
 puts actives.first.to_hash
-puts hr
 
 puts nis.node_active_peers_max_chain_height
-puts hr
 
 bnr = Nis::Struct::BootNodeRequest.new(
   metaData: {
@@ -50,4 +42,3 @@ begin
 rescue => ex
   puts ex
 end
-puts hr

data/examples/shutdown.rb

@@ -0,0 +1,6 @@
+require 'nis'
+
+nis = Nis.new(host: 'localhost')
+
+# only accept local node
+nis.shutdown

data/examples/transactions/importance_transfer.rb

@@ -0,0 +1,22 @@
+require 'nis'
+
+# sender
+A_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
+A_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
+
+# remote
+B_PUBLIC_KEY = 'cc6c9485d15b992501e57fe3799487e99de272f79c5442de94eeb998b45e0144'
+
+# TODO: public key calculated from private key in future version.
+# it will not need to set public key.
+kp = Nis::Keypair.new(A_PRIVATE_KEY, public_key: A_PUBLIC_KEY)
+
+tx = Nis::Transaction::ImportanceTransfer.new(B_PUBLIC_KEY, :activate)
+puts "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}"

data/examples/transactions/mosaic_definition_creation.rb

@@ -0,0 +1,50 @@
+require 'nis'
+
+# owner
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+A_PUBLIC_KEY  = 'be2ba9cb15a547110d511a4d43c0482fbb584d78781abac01fb053d18f4a0033'
+A_ADDRESS = 'TDPP2C4XQLMESBMCYGWN4NRAJAKZEYRV75KGYSOB'
+
+# TODO: public key calculated from private key in future version.
+# it will not need to set public key.
+kp = Nis::Keypair.new(A_PRIVATE_KEY, public_key: A_PUBLIC_KEY)
+
+mosaic_id = Nis::Struct::MosaicId.new(
+  namespaceId: 'sushi',
+  name: 'maguro'
+)
+
+properties = Nis::Struct::MosaicProperties.new(
+  divisibility: 0,
+  initialSupply: 10_000,
+  supplyMutable: true,
+  transferable: true
+)
+
+levy = Nis::Struct::MosaicLevy.new(
+  type: 1,
+  recipient: A_ADDRESS,
+  mosaicId: {
+    namespaceId: 'nem',
+    name: 'xem'
+  },
+  fee: 1_000
+)
+
+definition = Nis::Struct::MosaicDefinition.new(
+  creator: A_PUBLIC_KEY,
+  id: mosaic_id,
+  description: 'Japanese Soul food SHUSHI.',
+  properties: properties,
+  levy: levy
+)
+
+tx = Nis::Transaction::MosaicDefinitionCreation.new(definition)
+puts "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}"

data/examples/transactions/mosaic_supply_change.rb

@@ -0,0 +1,24 @@
+require 'nis'
+
+# owner
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+A_PUBLIC_KEY  = 'be2ba9cb15a547110d511a4d43c0482fbb584d78781abac01fb053d18f4a0033'
+
+# TODO: public key calculated from private key in future version.
+# it will not need to set public key.
+kp = Nis::Keypair.new(A_PRIVATE_KEY, public_key: A_PUBLIC_KEY)
+
+mosaic_id = Nis::Struct::MosaicId.new(
+  namespaceId: 'sushi',
+  name: 'maguro'
+)
+
+tx = Nis::Transaction::MosaicSupplyChange.new(mosaic_id, :increase, 1_000)
+puts "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}"

data/examples/transactions/multisig.rb

@@ -0,0 +1,26 @@
+require 'nis'
+
+# multisig
+# A_PRIVATE_KEY = '9bf8e6fd1a178a3cce39840cda34f80f55fe075c15f48eefad8506f4a70c2b47'
+A_PUBLIC_KEY  = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d078'
+# A_ADDRESS = 'TBAOYZS4FGY5XPQ5OD2VL3SY7GQ5FLH66GRCX5DL'
+
+# cosignatory
+B_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
+B_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
+B_ADDRESS = 'TAWKJTUP4DWKLDKKS534TYP6G324CBNMXKBA4X7B'
+
+# TODO: public key calculated from private key in future version.
+# it will not need to set public key.
+kp = Nis::Keypair.new(B_PRIVATE_KEY, public_key: B_PUBLIC_KEY)
+
+ttx = Nis::Transaction::Transfer.new(B_ADDRESS, 1_000_000, 'Good luck!')
+tx = Nis::Transaction::Multisig.new(ttx, A_PUBLIC_KEY)
+puts "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}"