nem-ruby 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e104168b1b964bfe7781e60bd856c8c47810d49f58620423c297298f7bcd0155
-  data.tar.gz: 25a00eaf0970adb06568c3334a94be759983113ff9cc02d43503eac8a593e954
+  metadata.gz: ecc626aa901b8ebab5b35db375fb920ac1a66a9feb2193d79ff34d35eef37904
+  data.tar.gz: 6aa07a4ba05b0757c8e78a25abecbbb3169a726eecabeeb86ac047c8a4de7d75
 SHA512:
-  metadata.gz: 229d81f04786aa310945ffd53a503786d7bf4f02b2551055ed24f751b64a923ede6377a092fcfe7508347ccff8c23e349fc92f8ff786bb42539c1851c174ba98
-  data.tar.gz: e3fb15751022dd9a99eeb3288544b91607711653b57a57487b6fab6f6de9dfa618e1d640b99dd872ca0340a89de0256dbc6ae89b7ac666d1d739f902cd0ed1da
+  metadata.gz: a051321b5579cee745c6922530f07e0fb30431401e6957a7f56bf598403aa6f9131652d1d04d8cd37172980ed1c416f337b77654b6a36795224a1d66b0811568
+  data.tar.gz: 7946079fc07bb27eaa1631562fb3a444fd94423a35ba9a3e9e1655f23583bf482a4f819c28240f5f55bfde39b6128492384e52a74e8e07be7231922b01c30ec2

data/.gitignore

@@ -5,6 +5,7 @@
 /coverage/
 /doc/
 /pkg/
+/site/
 /spec/reports/
 /tmp/
 

data/docs/about.md

@@ -0,0 +1,30 @@
+## Feedback and Contact
+
+For further development of nem with ruby, feel free to send me your feedback, feature requests, bug reports!
+
+* [44uk/nem-ruby - gitter](https://gitter.im/44uk/nem-ruby)
+* [@44uk_i3 - Twitter](https://twitter.com/44uk_i3)
+
+and I would be glad if you could let me know any project using the gem!
+
+## Donation
+
+The project gratefully accepts donations via nem:xem.
+
+```text
+NCPBJTNKHODIGPDMPKPETJK6YLMUPAW7ISBIQGUP
+```
+
+## Thanks
+
+- [NEM \- Distributed Ledger Technology \(Blockchain\)](https://www.nem.io/)
+- [NEM NIS API Documentation](https://nemproject.github.io/)
+- [NEM Forum](https://forum.nem.io/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [44uk/nem-ruby](https://github.com/44uk/nem-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/44uk/nem-ruby/blob/master/LICENSE).

data/docs/custom.css

@@ -0,0 +1,3 @@
+.wy-side-nav-search, .wy-nav-top {
+  background-color: #cc342d;
+}

data/docs/examples/account.md

@@ -0,0 +1,104 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+endpoint = Nem::Endpoint::Account.new(node)
+```
+
+## Find Address
+
+```ruby
+# find by address
+pp endpoint.find('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# alias
+pp endpoint.get('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# find by public key
+pp endpoint.find_by_public_key('e59ef184a612d4c3c4d89b5950eb57262c69862b2f96e59c5043bf41765c482f')
+
+# find forwarded by address
+pp endpoint.find_forwarded('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+# find forwarded by public key
+pp endpoint.find_forwarded_by_public_key('e59ef184a612d4c3c4d89b5950eb57262c69862b2f96e59c5043bf41765c482f')
+```
+
+## Hervests
+
+```ruby
+pp endpoint.harvests('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+```
+
+## Namespace / Mosaics
+
+```ruby
+# namespace
+pp endpoint.namespace('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+
+# fetch mosaic definition of account
+pp endpoint.mosaic_definition('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+
+# fetch owned mosaics of account
+mosaics = account_endpoint.mosaic_owned('TDPICOQ7GIEMIDJOOMIQSOYIJKG3C7V7OP2DUFIR')
+pp mosaics
+
+## can find by namespace
+pp mosaics.find_by_namespace_id('tpico')
+
+## can find by fqn
+pp mosaics.find_by_fqn('tpico:test')
+```
+
+## Transactions
+
+```ruby
+## incomings
+pp endpoint.transfers_incoming('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+## outgoings
+pp endpoint.transfers_outgoing('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+## all
+pp endpoint.transfers_all('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+
+## unconfirmed
+pp endpoint.transfers_unconfirmed('TBULEAUG2CZQISUR442HWA6UAKGWIXHDABJVIPS4')
+```
+
+## Status
+
+```ruby
+pp endpoint.status('TDJNDAQ7F7AQRXKP2YVTH67QYCWWKE6QLSJFWN64')
+```
+
+## Unlocked
+
+```ruby
+pp endpoint.unlocked_info
+```
+
+## Historical
+
+```ruby
+pp endpoint.historical('TDWWYDGQNBKSAJBSHZX7QWVX7WNVAWWB7HGPWRB2',
+  start_height: 1245390,
+  end_height: 1245400,
+  increment: 1
+)
+```
+
+## Generate Account / Lock, Unlock
+
+The APIs allowed only Local NIS.
+
+```ruby
+## generate account
+pp endpoint.generate
+
+## lock account
+pp endpoint.lock('__private_key__')
+
+## unlock account
+pp endpoint.unlock('__private_key__')
+```

data/docs/examples/apostille.md

@@ -0,0 +1,58 @@
+## Public Apostille
+
+### Create
+
+```ruby
+require 'pp'
+require 'nem'
+
+FIXTURES_PATH = File.expand_path('../../spec/fixtures', __FILE__)
+
+# sender
+A_PRIVATE_KEY = '4ce5c8f9fce571db0d9ac1adf00b8d3ba0f078ed40835fd3d730a2f24b834214'
+
+kp = Nem::Keypair.new(A_PRIVATE_KEY)
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+tx_endpoint = Nem::Endpoint::Transaction.new(node)
+
+file = File.open("#{FIXTURES_PATH}/nemLogoV2.png")
+apo = Nem::Apostille.new(kp, file, :sha1,
+  multisig: false,
+  signed: false,
+  network: :testnet
+)
+tx = apo.transaction
+pp "Fee: #{tx.fee.to_i}"
+
+req = Nem::Request::Announce.new(tx, kp)
+res = tx_endpoint.announce(req)
+
+pp "Message: #{res.message}"
+pp "TransactionHash: #{res.transaction_hash}"
+pp "ApostilleFormat: #{apo.apostille_format(res.transaction_hash)}"
+
+FileUtils.cp(file.path, apo.apostille_format(res.transaction_hash))
+```
+
+### Audit
+
+```ruby
+require 'pp'
+require 'nem'
+
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+tx_endpoint = Nem::Endpoint::Transaction.new(node)
+
+# transaction hash from Filename
+tx_hash = 'c035c2603356852687c4730fbc6f8d21da3af7c4c0eb8b3619bc9ecdc833255a'
+tx = tx_endpoint.find(tx_hash)
+
+# NOTE: it may return "Hash was not found in cache"
+# because of NIS not supporting caching transactions.
+# 'fe4e545902cde315617a435ebfd5fe8875d699e2f2363262f5'
+apostille_hash = tx.message.payload
+file = File.open("#{FIXTURES_PATH}/nemLogoV2 -- Apostille TX c035c2603356852687c4730fbc6f8d21da3af7c4c0eb8b3619bc9ecdc833255a -- Date 2017-12-18.png")
+
+apa = Nem::ApostilleAudit.new(file, apostille_hash)
+pp apa.valid? ? 'OK, Valid Apostille!' : 'Bad, Invalid Apostille!'
+```

data/docs/examples/block.md

@@ -0,0 +1,12 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+endpoint = Nem::Endpoint::Account.new(node)
+```
+
+## at public
+
+```ruby
+pp endpoint.at_public(1_223_559)
+```

data/docs/examples/chain.md

@@ -0,0 +1,24 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+endpoint = Nem::Endpoint::Chain.new(node)
+```
+
+## height
+
+```ruby
+pp endpoint.height
+```
+
+## score
+
+```ruby
+pp endpoint.score
+```
+
+## last block
+
+```ruby
+pp endpoint.last_block
+```

data/docs/examples/configure.md

@@ -0,0 +1,20 @@
+## Configuration
+
+```ruby
+Nem.configure do |conf|
+  # output path
+  conf.logger = Logger.new('./nem-ruby.log')
+
+  # logger level
+  conf.logger.level = Logger::DEBUG
+
+  # output debug log
+  conf.debug = true
+
+  # deadline(sec)
+  conf.default_deadline = 7200
+
+  # :mainnet if you'd like to use on mainnet!
+  conf.default_network = :mainnet
+end
+```

data/docs/examples/debug.md

@@ -0,0 +1,25 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+endpoint = Nem::Endpoint::Debug.new(node)
+```
+
+## connections
+
+```ruby
+# mapped methods
+pp endpoint.connections_incoming
+pp endpoint.connections_outgoing
+pp endpoint.connections_timers
+
+# another way
+pp endpoint.debug_connections(:in)
+pp endpoint.debug_connections(:out)
+```
+
+## time synchronization
+
+```ruby
+pp endpoint.time_synchronization
+```

data/docs/examples/define_mosaic_attachment.md

@@ -0,0 +1,10 @@
+## Mosaic attachment definition
+
+```ruby
+class MyMosaic < Nem::Mosaic::Base
+  namespace_id 'my'
+  name 'moz'
+  divisibility 3
+  initial_supply 1_234_567_890
+end
+```

data/docs/examples/local.md

@@ -0,0 +1,28 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new
+endpoint = Nem::Endpoint::Local.new(node)
+```
+
+## account transfers
+
+```ruby
+value = '00b4a68d16dc505302e9631b860664ba43a8183f0903bc5782a2403b2f9eb3c8a1'
+
+# mapped methods
+pp endpoint.transfers_incoming(value)
+pp endpoint.transfers_outgoing(value)
+pp endpoint.transfers_all(value)
+
+# another way
+pp endpoint.transfers(value, :in)
+pp endpoint.transfers(value, :out)
+pp endpoint.transfers(value, :all)
+```
+
+##chain blocks after
+
+```ruby
+pp endpoint.blocks_after(1_223_559)
+```

data/docs/examples/mosaic.md

@@ -0,0 +1,12 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new
+endpoint = Nem::Endpoint::Mosaic.new(node)
+```
+
+## supply
+
+```ruby
+pp mo_endpoint.supply('nembar:vip')
+```

data/docs/examples/namespace.md

@@ -0,0 +1,25 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+endpoint = Nem::Endpoint::Namespace.new(node)
+```
+
+## find
+
+```ruby
+pp ns_endpoint.find('alice')
+```
+
+
+## root
+
+```ruby
+pp ns_endpoint.root(882, page_size: 1)
+```
+
+## mosaic definition page
+
+```ruby
+pp ns_endpoint.mosaic_definition('tpico')
+```

data/docs/examples/nis.md

@@ -0,0 +1,23 @@
+## Node
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+```
+
+## heartbeat
+
+```ruby
+pp node.heartbeat
+
+# passing API Path
+pp node.request :get, 'heartbeat'
+```
+
+## status
+
+```ruby
+pp node.status
+
+# passing API Path
+pp node.request :get, 'status'
+```

data/docs/examples/node.md

@@ -0,0 +1,61 @@
+## Endpoint
+
+```ruby
+node = Nem::Node.new(host: 'bigalice2.nem.ninja')
+endpoint = Nem::Endpoint::Node.new(node)
+```
+
+## Info
+
+```ruby
+pp endpoint.node_info
+pp endpoint.node_extended_info
+pp endpoint.node_experiences
+```
+
+## Peerlist
+
+```ruby
+# mapped methods
+pp endpoint.node_peerlist_all
+pp endpoint.node_peerlist_reachable
+pp endpoint.node_peerlist_active
+
+# another way
+pp endpoint.node_peerlist(:all)
+pp endpoint.node_peerlist(:reachable)
+pp endpoint.node_peerlist(:active)
+```
+
+## Active peers max chain height
+
+```ruby
+endpoint = node_endpoint = Nem::Endpoint::Node.new(Nem::Node.new)
+
+pp endpoint.node_active_peers_max_chain_height
+```
+
+## Boot node request
+
+```ruby
+bnr = Nis::Struct::BootNodeRequest.new(
+  metaData: {
+    application: 'NIS'
+  },
+  endpoint: {
+    protocol: 'http',
+    port: 7890,
+    host: 'localhost'
+  },
+  identity: {
+    'private-key': 'a6cbd01d04edecfaef51df9486c111abb6299c764a00206eb1d01f4587491b3f',
+    name: 'Alice'
+  }
+)
+
+begin
+  pp endpoint.node_boot(boot_node_request: bnr)
+rescue => ex
+  pp ex
+end
+```