nis-ruby 0.0.11.1 → 0.0.12

data/examples/transactions/multisig_add_cosignatory.rb

@@ -0,0 +1,31 @@
+require 'nis'
+
+# Account A (multisig)
+A_PUBLIC_KEY  = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d078'
+
+# 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)
+
+mcm = Nis::Struct::MultisigCosignatoryModification.new(
+  modificationType: 1,
+  cosignatoryAccount: C_PUBLIC_KEY
+)
+min_cosigs = 2
+mtx = Nis::Transaction::MultisigAggregateModification.new([mcm], min_cosigs)
+
+tx = Nis::Transaction::Multisig.new(mtx, A_PUBLIC_KEY)
+
+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_aggregate_modification.rb

@@ -0,0 +1,28 @@
+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)
+
+mcm = Nis::Struct::MultisigCosignatoryModification.new(
+  modificationType: 1,
+  cosignatoryAccount: B_PUBLIC_KEY
+)
+min_cosigs = 1
+
+tx = Nis::Transaction::MultisigAggregateModification.new([mcm], min_cosigs)
+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_signature.rb

@@ -0,0 +1,38 @@
+require 'nis'
+
+# multisig
+A_PUBLIC_KEY  = '4b26a75313b747985470977a085ae6f840a0b84ebd96ddf17f4a31a2b580d078'
+A_ADDRESS = 'TBAOYZS4FGY5XPQ5OD2VL3SY7GQ5FLH66GRCX5DL'
+
+# cosignatory1
+# B_PRIVATE_KEY = '260206d683962350532408e8774fd14870a173b7fba17f6b504da3dbc5f1cc9f'
+# B_PUBLIC_KEY  = 'cc63b4dcdec745417043c3fa0992ec3a1695461a26d90264744648abbd5caa0d'
+# B_ADDRESS = 'TAWKJTUP4DWKLDKKS534TYP6G324CBNMXKBA4X7B'
+
+# 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)
+
+nis = Nis.new
+txes = nis.account_unconfirmed_transactions(address: C_ADDRESS)
+
+unless txes.size > 0
+  puts 'There are no transactions to sign.'
+  exit
+end
+
+hash = txes.first.meta.data
+puts "Unconfirmed Transaction Hash: #{hash}"
+
+tx = Nis::Transaction::MultisigSignature.new(hash, A_ADDRESS, C_PUBLIC_KEY)
+
+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/provision_namespace.rb

@@ -0,0 +1,19 @@
+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)
+
+tx = Nis::Transaction::ProvisionNamespace.new('sushi')
+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/transfer.rb

@@ -0,0 +1,22 @@
+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)
+
+tx = Nis::Transaction::Transfer.new(B_ADDRESS, 1_000_000, 'Good luck!')
+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/lib/nis.rb

@@ -1,7 +1,10 @@
 require 'nis/version'
 require 'nis/mixin'
 require 'nis/util'
+require 'nis/keypair'
+require 'nis/fee'
 require 'nis/client'
+require 'nis/request'
 require 'nis/endpoint'
 require 'nis/struct'
 require 'nis/transaction'
@@ -15,17 +18,18 @@ class Nis
   def_delegators :@client, :request, :request!
 
   # @param [hash] options HTTP Client connection information
-  # @option options [Symbol] :url URL
-  # @option options [Symbol] :scheme default http (http only)
+  # @option options [String] :url URL
+  # @option options [String] :scheme default http
   # @option options [Symbol] :host default 127.0.0.1
-  # @option options [Symbol] :port default 7890
-  # @option options [Symbol] :timeout default 5
+  # @option options [Integer] :port default 7890
+  # @option options [Integer] :timeout default 5
   def initialize(options = {})
     @client = Client.new(options)
   end
 
   include Nis::Endpoint::Heartbeat
   include Nis::Endpoint::Status
+  include Nis::Endpoint::Shutdown
 
   include Nis::Endpoint::Account::Generate
   include Nis::Endpoint::Account::Get

data/lib/nis/client.rb

@@ -19,7 +19,8 @@ class Nis::Client
     '/local/account/transfers/outgoing',
     '/local/account/transfers/all',
     '/node/boot',
-    '/transaction/prepare-announce'
+    '/transaction/prepare-announce',
+    '/shutdown'
   ]
 
   attr_reader :options

data/lib/nis/endpoint/shutdown.rb

@@ -0,0 +1,7 @@
+module Nis::Endpoint
+  module Shutdown
+    def shutdown
+      request(:get, '/shutdown')
+    end
+  end
+end

data/lib/nis/endpoint/transaction/announce.rb

@@ -3,7 +3,7 @@ module Nis::Endpoint
     # @param [Nis::Struct::RequestAnnounce] request_announce
     # @return [Nis::Struct::Node]
     # @see http://bob.nem.ninja/docs/#sending-the-data-to-NIS
-    def transaction_announce(request_announce:)
+    def transaction_announce(request_announce)
       Nis::Struct::NemAnnounceResult.build request!(:post,
         '/transaction/announce',
         request_announce

data/lib/nis/endpoint/transaction/prepareAnnounce.rb

@@ -3,7 +3,7 @@ module Nis::Endpoint
     # @param [Nis::Struct::RequestPrepareAnnounce] request_prepare_announce
     # @return [Nis::Struct::Node]
     # @see http://bob.nem.ninja/docs/#initiating-a-transaction
-    def transaction_prepare_announce(request_prepare_announce:)
+    def transaction_prepare_announce(request_prepare_announce)
       Nis::Struct::NemAnnounceResult.build request!(:post,
         '/transaction/prepare-announce',
         request_prepare_announce

data/lib/nis/fee.rb

@@ -0,0 +1 @@
+Dir[File.expand_path('../fee/*.rb', __FILE__)].each { |f| require f }

data/lib/nis/fee/importance_transfer.rb

@@ -0,0 +1,22 @@
+class Nis::Fee
+  class ImportanceTransfer
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      testnet? ? 0.15 * 1_000_000 : 6_000_000
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+  end
+end

data/lib/nis/fee/mosaic_definition_creation.rb

@@ -0,0 +1,22 @@
+class Nis::Fee
+  class MosaicDefinitionCreation
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      (testnet? ? 10 : 500) * 1_000_000
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+  end
+end

data/lib/nis/fee/mosaic_supply_change_transfer.rb

@@ -0,0 +1,22 @@
+class Nis::Fee
+  class MosaicSupplyChangeTransfer
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      testnet? ? 0.15 * 1_000_000 : 20 * 1_000_000
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+  end
+end

data/lib/nis/fee/multisig.rb

@@ -0,0 +1,22 @@
+class Nis::Fee
+  class Multisig
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      testnet? ? 0.15 * 1_000_000 : 6_000_000
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+  end
+end

data/lib/nis/fee/multisig_aggregation_modification.rb

@@ -0,0 +1,30 @@
+class Nis::Fee
+  class MultisigAggregateModification
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      if @transaction.minCosignatories == 0
+        testnet? ?
+          0.5 * 1_000_000 :
+          (10 + 6 * @transaction.modifications.length) * 1_000_000
+      else
+        testnet? ?
+          0.5 * 1_000_000 :
+          (10 + 6 * @transaction.modifications.length + 6) * 1_000_000
+      end
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+  end
+end

data/lib/nis/fee/provision_namespace.rb

@@ -0,0 +1,32 @@
+class Nis::Fee
+  class ProvisionNamespace
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      @transaction.root? ? root_fee : sub_fee
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+
+    private
+
+    def root_fee
+      (testnet? ? 100 : 5_000) * 1_000_000
+    end
+
+    def sub_fee
+      (testnet? ? 10 : 200) * 1_000_000
+    end
+  end
+end

data/lib/nis/fee/transfer.rb

@@ -0,0 +1,51 @@
+class Nis::Fee
+  class Transfer
+    def initialize(transaction)
+      @transaction = transaction
+    end
+
+    # @return [Integer] fee in micro XEM
+    def value
+      tmp = 0
+
+      if @transaction.mosaics.empty?
+        tmp += min_fee
+      else
+        tmp += mosaics_fee
+      end
+
+      if @transaction.message.bytesize > 0
+        tmp += message_fee
+      end
+
+      tmp * 1_000_000
+    end
+
+    # @return [Integer] fee in micro XEM
+    def to_i
+      value.to_i
+    end
+
+    # @return [Boolean]
+    def testnet?
+      @transaction.network == :testnet
+    end
+
+    private
+
+    def min_fee
+      tmp = [1, @transaction.amount / 1_000_000 / 10_000].max
+      tmp = (tmp > 25 ? 25 : tmp)
+      testnet? ? 0.05 * tmp : tmp
+    end
+
+    def message_fee
+      tmp = [1, (@transaction.message.bytesize / 2 / 32) + 1].max
+      testnet? ? 0.05 * tmp : tmp
+    end
+
+    def mosaics_fee
+      raise NotImplementedError, 'not implemented calculation mosaics fee.'
+    end
+  end
+end

data/lib/nis/keypair.rb

@@ -0,0 +1,18 @@
+class Nis
+  class Keypair
+    attr_reader :private, :public
+
+    def initialize(private_key, public_key: nil)
+      @private = private_key
+      @public  = public_key
+    end
+
+    def fix_private_key(key)
+      "#{'0' * 64}#{key.sub(/^00/i, '')}"[-64, 64]
+    end
+
+    def calc_pubkey
+      # TODO: calculate pubkey from privkey
+    end
+  end
+end