nis-ruby 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48fc594828a7e878a2d93c176aa7969eda269b74
-  data.tar.gz: dfa004cc7326b9cc581cc5e42e32fa4e6cbc7117
+  metadata.gz: 90a209933bc58268e827373213bbd8246aeb5147
+  data.tar.gz: 2842c5967a6dfab98aea4fdf1e659b967528071e
 SHA512:
-  metadata.gz: 5e0b204992ea6daabbb0186484d98978a984e28598f6bb0bbd4f891143d97292c118c57993be1db835b51790649bbcd6b69c3f98a22934afb9ecd9e52c64ba12
-  data.tar.gz: dcfcace177ac5abcb30c0f90dcb83f62e4586c3a73a343d098de82b5dc9d5aadb968765a4e7628b2fa647d7aca5488eb652c6c5c3c1bdbd83b9309789ec19144
+  metadata.gz: 4d7bbc7b84d6495f60484c7cd3927ca47643f0659dd9948ebaa5be823b741ab1caa052772a8156d78328faf210a57cfa90f348b3b64ae9a6ca5577443b142a8f
+  data.tar.gz: 7a275ef7fda5a0cfb0e34c01db7ba7c92c18feb7036285dd6fe2d50944c74ff9f2307174b7acb93f42b1dfa79be155c4c69ec4bd2b682c3ac39ea4baa5c8b546

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
 rvm:
+  - ruby-head
   - 2.4.0
   - 2.3.0
   - 2.2.6

data/README.md

@@ -10,9 +10,11 @@
 Ruby client library for the NEM Infrastructure Server API
 
 - [NEM \- Distributed Ledger Technology \(Blockchain\)](https://www.nem.io/)
-- [NEM NIS API Documentation](http://bob.nem.ninja/docs/)
+- [NEM NIS API Documentation](https://nemproject.github.io/)
 - [NEM Forum](https://forum.nem.io/)
 
+*The gem is under development. Incompatible changes can be made.*
+
 
 ## Installation
 
@@ -37,11 +39,11 @@ nis = Nis.new
 
 nis.heartbeat
 # => {code: 1, type: 2, message: "ok"}
-# See http://bob.nem.ninja/docs/#heart-beat-request
+# See https://nemproject.github.io/#heart-beat-request
 
 nis.status
 # => {code: 6, type: 4, message: "status"}
-# See http://bob.nem.ninja/docs/#status-request
+# See https://nemproject.github.io/#status-request
 
 kp = Nis::Keypair.new(SENDER_PRIV_KEY)
 tx = Nis::Transaction::Transfer.new(
@@ -50,9 +52,13 @@ tx = Nis::Transaction::Transfer.new(
   'Message'
 )
 req = Nis::Request::PrepareAnnounce.new(tx, kp)
+# Request to local node.
 nis.transaction_prepare_announce(req)
-# See http://bob.nem.ninja/docs/#initiating-a-transfer-transaction
+# See https://nemproject.github.io/#initiating-a-transfer-transaction
 # => {innerTransactionHash: {}, code: 1, type: 1, message: "SUCCESS", transactionHash: {data: "9da41fd6c6886740ae6a15c869df0470015d78103e5b216971aa09fdbcce9cde"}}
+
+# Request to remote node.
+# nis.transaction_announce(req)
 ```
 
 ### Requesting
@@ -64,13 +70,13 @@ nis.request(:get, '/account/get',
   address: 'TALICELCD3XPH4FFI5STGGNSNSWPOTG5E4DS2TOS'
 )
 # => [AccountMetaDataPair structure]
-# See http://bob.nem.ninja/docs/#accountMetaDataPair
+# See https://nemproject.github.io/#accountMetaDataPair
 
 nis.request(:post, '/account/unlock',
   privateKey: '00983bb01d05edecfaef55df9486c111abb6299c754a002069b1d0ef4537441bda'
 )
 # => Nothing
-# See http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
+# See https://nemproject.github.io/#locking-and-unlocking-accounts
 ```
 
 
@@ -96,8 +102,6 @@ $ nis request get account/harvests --params=address:TALICELCD3XPH4FFI5STGGNSNSWP
 You can find nodes here.
 - [NEM Node Rewards](https://supernodes.nem.io/)
 
-*Currently the gem only supports transactions for local node.*
-
 ### Hash
 
 ```ruby
@@ -121,7 +125,6 @@ Environment variable used as default value.
 ## TODO
 
 * Do more improvements
-  * Remote transaction
   * Mosaic transferring
   * Encryption message
   * Be more easy to use

data/examples/transactions/importance_transfer.rb

@@ -2,14 +2,11 @@ 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)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 tx = Nis::Transaction::ImportanceTransfer.new(B_PUBLIC_KEY, :activate)
 puts "Fee: #{tx.fee.to_i}"

data/examples/transactions/mosaic_definition_creation.rb

@@ -2,12 +2,9 @@ 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)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 mosaic_id = Nis::Struct::MosaicId.new(
   namespaceId: 'sushi',

data/examples/transactions/mosaic_supply_change.rb

@@ -2,11 +2,8 @@ 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)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 mosaic_id = Nis::Struct::MosaicId.new(
   namespaceId: 'sushi',

data/examples/transactions/multisig.rb

@@ -1,18 +1,13 @@
 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)
+kp = Nis::Keypair.new(B_PRIVATE_KEY)
 
 ttx = Nis::Transaction::Transfer.new(B_ADDRESS, 1_000_000, 'Good luck!')
 tx = Nis::Transaction::Multisig.new(ttx, A_PUBLIC_KEY)

data/examples/transactions/multisig_add_cosignatory.rb

@@ -5,14 +5,11 @@ A_PUBLIC_KEY  = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d07
 
 # Account B (cosignatory1)
 B_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
-B_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
 
 # Account C (cosignatory2)
 C_PUBLIC_KEY  = '9fd1e5e886c4006efc715a0e183f2a87f198b8d19c44e7c67925b01aa45a7114'
 
-# 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)
+kp = Nis::Keypair.new(B_PRIVATE_KEY)
 
 mcm = Nis::Struct::MultisigCosignatoryModification.new(
   modificationType: 1,

data/examples/transactions/multisig_aggregate_modification.rb

@@ -2,14 +2,11 @@ require 'nis'
 
 # multisig
 A_PRIVATE_KEY = '9bf8e6fd1a178a3cce39840cda34f80f55fe075c15f48eefad8506f4a70c2b47'
-A_PUBLIC_KEY  = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d078'
 
 # cosignatory
 B_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
 
-# 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)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 mcm = Nis::Struct::MultisigCosignatoryModification.new(
   modificationType: 1,

data/examples/transactions/multisig_signature.rb

@@ -1,7 +1,7 @@
 require 'nis'
 
 # multisig
-A_PUBLIC_KEY  = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d078'
+A_PUBLIC_KEY = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d078'
 A_ADDRESS = 'TBAOYZS4FGY5XPQ5OD2VL3SY7GQ5FLH66GRCX5DL'
 
 # cosignatory1
@@ -11,12 +11,9 @@ A_ADDRESS = 'TBAOYZS4FGY5XPQ5OD2VL3SY7GQ5FLH66GRCX5DL'
 
 # cosignatory2
 C_PRIVATE_KEY = '2f6bececfaa81e0ce878be6263df29d11412559132743eebde99f695fbc4e288'
-C_PUBLIC_KEY  = '9fd1e5e886c4006efc715a0e183f2a87f198b8d19c44e7c67925b01aa45a7114'
 C_ADDRESS = 'TAFPFQOTRYEKMKWWKLLLMYA3I5SCFDGYFACCOFWS'
 
-# TODO: public key calculated from private key in future version.
-# it will not need to set public key.
-kp = Nis::Keypair.new(C_PRIVATE_KEY, public_key: C_PUBLIC_KEY)
+kp = Nis::Keypair.new(C_PRIVATE_KEY)
 
 nis = Nis.new
 txes = nis.account_unconfirmed_transactions(address: C_ADDRESS)

data/examples/transactions/provision_namespace.rb

@@ -2,11 +2,8 @@ require 'nis'
 
 # owner
 A_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
-A_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
 
-# 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)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 tx = Nis::Transaction::ProvisionNamespace.new('sushi')
 puts "Fee: #{tx.fee.to_i}"

data/examples/transactions/transfer.rb

@@ -2,14 +2,11 @@ require 'nis'
 
 # sender
 A_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
-A_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
 
 # receiver
 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(A_PRIVATE_KEY, public_key: A_PUBLIC_KEY)
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
 
 tx = Nis::Transaction::Transfer.new(B_ADDRESS, 1_000_000, 'Good luck!')
 puts "Fee: #{tx.fee.to_i}"

data/examples/transactions/transfer_remote.rb

@@ -0,0 +1,19 @@
+require 'nis'
+
+# sender
+A_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
+
+# receiver
+B_ADDRESS = 'TAWKJTUP4DWKLDKKS534TYP6G324CBNMXKBA4X7B'
+
+kp = Nis::Keypair.new(A_PRIVATE_KEY)
+
+tx = Nis::Transaction::Transfer.new(B_ADDRESS, 1_000_000, 'Good luck!')
+puts "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}"

data/lib/nis/endpoint/account/generate.rb

@@ -1,7 +1,7 @@
 module Nis::Endpoint
   module Account::Generate
     # @return [Nis::Struct::KeyPairViewModel]
-    # @see http://bob.nem.ninja/docs/#generating-new-account-data
+    # @see https://nemproject.github.io/#generating-new-account-data
     def account_generate
       Nis::Struct::KeyPairViewModel.build request!(:get, '/account/generate')
     end

data/lib/nis/endpoint/account/get.rb

@@ -2,7 +2,7 @@ module Nis::Endpoint
   module Account::Get
     # @param [String] address
     # @return [Nis::Struct::AccountMetaDataPair]
-    # @see http://bob.nem.ninja/docs/#requesting-the-account-data
+    # @see https://nemproject.github.io/#requesting-the-account-data
     def account_get(address:)
       request!(:get, '/account/get',
         address: address
@@ -13,7 +13,7 @@ module Nis::Endpoint
 
     # @param [String] public_key
     # @return [Nis::Struct::AccountMetaDataPair]
-    # @see http://bob.nem.ninja/docs/#requesting-the-account-data
+    # @see https://nemproject.github.io/#requesting-the-account-data
     def account_get_from_public_key(public_key:)
       request!(:get, '/account/get/from-public-key',
         publicKey: public_key
@@ -24,7 +24,7 @@ module Nis::Endpoint
 
     # @param [String] address
     # @return [Nis::Struct::AccountMetaDataPair]
-    # @see http://bob.nem.ninja/docs/#requesting-the-original-account-data-for-a-delegate-account
+    # @see https://nemproject.github.io/#requesting-the-original-account-data-for-a-delegate-account
     def account_get_forwarded(address:)
       request!(:get, '/account/get/forwarded',
         address: address
@@ -35,7 +35,7 @@ module Nis::Endpoint
 
     # @param [String] public_key
     # @return [Nis::Struct::AccountMetaDataPair] delegate account
-    # @see http://bob.nem.ninja/docs/#requesting-the-original-account-data-for-a-delegate-account
+    # @see https://nemproject.github.io/#requesting-the-original-account-data-for-a-delegate-account
     def account_get_forwarded_from_public_key(public_key:)
       request!(:get, '/account/get/forwarded/from-public-key',
         publicKey: public_key

data/lib/nis/endpoint/account/harvests.rb

@@ -3,7 +3,7 @@ module Nis::Endpoint
     # @param [String] address
     # @param [String] hash
     # @return [Array <Nis::Struct::HarvestInfo>]
-    # @see http://bob.nem.ninja/docs/#requesting-harvest-info-data-for-an-account
+    # @see https://nemproject.github.io/#requesting-harvest-info-data-for-an-account
     def account_harvests(address:, hash: nil)
       request!(:get, '/account/harvests',
         address: address,

data/lib/nis/endpoint/account/historical.rb

@@ -5,7 +5,7 @@ module Nis::Endpoint
     # @param [Integer] end_height
     # @param [Integer] increment
     # @return [Array <Nis::Struct::AccountHistoricalDataViewModel>]
-    # @see http://bob.nem.ninja/docs/#retrieving-historical-account-data
+    # @see https://nemproject.github.io/#retrieving-historical-account-data
     def account_historical_get(address:, start_height:, end_height:, increment:)
       request!(:get, '/account/historical/get',
         address: address,

data/lib/nis/endpoint/account/importances.rb

@@ -1,7 +1,7 @@
 module Nis::Endpoint
   module Account::Importances
     # @return [Array <Nis::Struct::AccountImportanceViewModel>]
-    # @see http://bob.nem.ninja/docs/#retrieving-account-importances-for-accounts
+    # @see https://nemproject.github.io/#retrieving-account-importances-for-accounts
     def account_importances
       request!(:get, '/account/importances') do |res|
         res[:data].map { |aivm| Nis::Struct::AccountImportanceViewModel.build(aivm) }

data/lib/nis/endpoint/account/lock.rb

@@ -2,7 +2,7 @@ module Nis::Endpoint
   module Account::Lock
     # @param private_key [String]
     # @return [nil]
-    # @see http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
+    # @see https://nemproject.github.io/#locking-and-unlocking-accounts
     def account_lock(private_key:)
       request!(:post, '/account/lock',
         privateKey: private_key

data/lib/nis/endpoint/account/mosaic.rb

@@ -4,7 +4,7 @@ module Nis::Endpoint
     # @param [String] parent
     # @param [String] id
     # @return [Array <Nis::Struct::MosaicDefinition>]
-    # @see http://bob.nem.ninja/docs/##retrieving-mosaic-definitions-that-an-account-has-created
+    # @see https://nemproject.github.io/##retrieving-mosaic-definitions-that-an-account-has-created
     def account_mosaic_definition_page(address:, parent: nil, id: nil)
       request!(:get, '/account/mosaic/definition/page',
         address: address,
@@ -17,7 +17,7 @@ module Nis::Endpoint
 
     # @param [String] address
     # @return [Array <Nis::Struct::AccountMetaDataPair>]
-    # @see http://bob.nem.ninja/docs/#retrieving-mosaics-that-an-account-owns
+    # @see https://nemproject.github.io/#retrieving-mosaics-that-an-account-owns
     def account_mosaic_owned(address:)
       request!(:get, '/account/mosaic/owned', address: address) do |res|
         res[:data].map { |mo| Nis::Struct::Mosaic.build(mo) }

data/lib/nis/endpoint/account/namespace.rb

@@ -5,7 +5,7 @@ module Nis::Endpoint
     # @param [String] id
     # @param [Integer] page_size
     # @return [Array <Nis::Struct::Namespace>]
-    # @see http://bob.nem.ninja/docs/#retrieving-namespaces-that-an-account-owns
+    # @see https://nemproject.github.io/#retrieving-namespaces-that-an-account-owns
     def account_namespace_page(address:, parent: nil, id: nil, page_size: nil)
       request!(:get, '/account/namespace/page',
         address: address,

data/lib/nis/endpoint/account/status.rb

@@ -2,7 +2,7 @@ module Nis::Endpoint
   module Account::Status
     # @param [String] address
     # @return [AccountMetaData]
-    # @see http://bob.nem.ninja/docs/#requesting-the-account-status
+    # @see https://nemproject.github.io/#requesting-the-account-status
     def account_status(address:)
       request!(:get, '/account/status',
         address: address

data/lib/nis/endpoint/account/transfers.rb

@@ -4,7 +4,7 @@ module Nis::Endpoint
     # @param [String] hash
     # @param [String] id
     # @return [Array <Nis::Struct::TransactionMetaDataPair>]
-    # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
+    # @see https://nemproject.github.io/#requesting-transaction-data-for-an-account
     def account_transfers_incoming(address:, hash: nil, id: nil)
       request!(:get, '/account/transfers/incoming',
         address: address,
@@ -19,7 +19,7 @@ module Nis::Endpoint
     # @param [String] hash
     # @param [String] id
     # @return [Array <Nis::Struct::TransactionMetaDataPair>]
-    # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
+    # @see https://nemproject.github.io/#requesting-transaction-data-for-an-account
     def account_transfers_outgoing(address:, hash: nil, id: nil)
       request!(:get, '/account/transfers/outgoing',
         address: address,
@@ -34,7 +34,7 @@ module Nis::Endpoint
     # @param [String] hash
     # @param [String] id
     # @return [Array <Nis::Struct::TransactionMetaDataPair>]
-    # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
+    # @see https://nemproject.github.io/#requesting-transaction-data-for-an-account
     def account_transfers_all(address:, hash: nil, id: nil)
       request!(:get, '/account/transfers/all',
         address: address,

data/lib/nis/endpoint/account/unconfirmed_transactions.rb

@@ -2,7 +2,7 @@ module Nis::Endpoint
   module Account::UnconfirmedTransactions
     # @param [String] address
     # @return [Array <Nis::Struct::UnconfirmedTransactionMetaDataPair>]
-    # @see http://bob.nem.ninja/docs/#requesting-transaction-data-for-an-account
+    # @see https://nemproject.github.io/#requesting-transaction-data-for-an-account
     def account_unconfirmed_transactions(address:)
       request!(:get, '/account/unconfirmedTransactions', address: address) do |res|
         res[:data].map do |utmdp|

data/lib/nis/endpoint/account/unlock.rb

@@ -2,7 +2,7 @@ module Nis::Endpoint
   module Account::Unlock
     # @param [String] private_key
     # @return [nil]
-    # @see http://bob.nem.ninja/docs/#locking-and-unlocking-accounts
+    # @see https://nemproject.github.io/#locking-and-unlocking-accounts
     def account_unlock(private_key:)
       request!(:post, '/account/lock',
         privateKey: private_key