tapyrus 0.2.7 → 0.2.8

data/lib/tapyrus/tx_builder.rb

@@ -0,0 +1,158 @@
+module Tapyrus
+  #
+  # Transaction Builder class.
+  #
+  # TxBuilder makes it easy to  build transactions without having to deal with TxOut/TxIn/Script directly.
+  #
+  # @example
+  #
+  #   txb = Tapyrus::TxBuilder.new
+  #   utxo1 = {
+  #     script_pubkey: Tapyrus::Script.parse_from_addr('mgCuyNQ1pUbKqL57tJQZX3hhUCaZcuX3RQ'),
+  #     txid: 'e1fb3255ead43dccd3ae0ac2c4f81b32260ca52749936a739669918bbb895411',
+  #     index: 0,
+  #     value: 3_000
+  #   }
+  #   color_id = Tapyrus::Color::ColorIdentifier.nft(...)
+  #   utxo2 = {
+  #     script_pubkey: Tapyrus::Script.parse_from_addr('mu9QMUcB9UCHbQjZJLAuyysQhM9tmFQbPx'),
+  #     color_id: color_id,
+  #     txid: 'e1fb3255ead43dccd3ae0ac2c4f81b32260ca52749936a739669918bbb895411',
+  #     index: 1,
+  #     value: 3_000
+  #   }
+  #
+  #   tx = txb
+  #     .add_utxo(utxo1)
+  #     .add_utxo(utxo2)
+  #     .data("0102030405060a0b0c")
+  #     .reissuable(utxo1[:script_pubkey],'n4jKJN5UMLsAejL1M5CTzQ8npeWoLBLCAH', 10_000)
+  #     .pay('n4jKJN5UMLsAejL1M5CTzQ8npeWoLBLCAH', 1_000)
+  #     .build
+  #
+  class TxBuilder
+    def initialize
+      @utxos = []
+      @incomings = {}
+      @outgoings = {}
+      @outputs = []
+    end
+
+    # Add utxo for transaction input
+    # @param utxo [Hash] a hash whose fields are `txid`, `index`, `script_pubkey`, `value`, and `color_id` (color_id is optional)
+    def add_utxo(utxo)
+      @utxos << utxo
+      color_id = utxo[:color_id] || Tapyrus::Color::ColorIdentifier.default
+      @incomings[color_id] ||= 0
+      @incomings[color_id] += utxo[:value]
+      self
+    end
+
+    # Issue reissuable token
+    # @param script_pubkey [Tapyrus::Script] the script pubkey in the issue input.
+    # @param address [String] p2pkh or p2sh address.
+    # @param value [Integer] issued amount.
+    def reissuable(script_pubkey, address, value)
+      color_id = Tapyrus::Color::ColorIdentifier.reissuable(script_pubkey)
+      pay(address, value, color_id)
+    end
+
+    # Issue non reissuable token
+    # @param out_point [Tapyrus::OutPoint] the out point at issue input.
+    # @param address [String] p2pkh or p2sh address.
+    # @param value [Integer] issued amount.
+    def non_reissuable(out_point, address, value)
+      color_id = Tapyrus::Color::ColorIdentifier.non_reissuable(out_point)
+      pay(address, value, color_id)
+    end
+
+    # Issue NFT
+    # @param out_point [Tapyrus::OutPoint] the out point at issue input.
+    # @param address [String] p2pkh or p2sh address.
+    # @param value [Integer] issued amount.
+    def nft(out_point, address)
+      color_id = Tapyrus::Color::ColorIdentifier.nft(out_point)
+      pay(address, 1, color_id)
+    end
+
+    # Create payment output.
+    # @param address [String] tapyrus address with Base58 format
+    # @param value [Integer] issued or transferred amount
+    # @param color_id [Tapyrus::Color::ColorIdentifier] color id
+    def pay(address, value, color_id = Tapyrus::Color::ColorIdentifier.default)
+      script_pubkey = Tapyrus::Script.parse_from_addr(address)
+
+      unless color_id.default?
+        raise ArgumentError, 'invalid address' if !script_pubkey.p2pkh? && !script_pubkey.p2sh?
+        script_pubkey = script_pubkey.add_color(color_id)
+      end
+
+      @outgoings[color_id] ||= 0
+      @outgoings[color_id] += value
+      @outputs << Tapyrus::TxOut.new(script_pubkey: script_pubkey, value: value)
+      self
+    end
+
+    # Create data output
+    # @param contents [[String]] array of hex string
+    def data(*contents)
+      payload = contents.join
+      script = Tapyrus::Script.new << Tapyrus::Script::OP_RETURN << payload
+      @outputs << Tapyrus::TxOut.new(script_pubkey: script)
+      self
+    end
+
+    # Set transaction fee.
+    # @param fee [Integer] transaction fee
+    def fee(fee)
+      @fee = fee
+      self
+    end
+
+    # Set address for change.
+    # If set, #build method add output for change which has the specified address
+    # If not set, transaction built by #build method has no output for change.
+    # @param address [String] p2pkh or p2sh address.
+    def change_address(address)
+      script_pubkey = Tapyrus::Script.parse_from_addr(address)
+      raise ArgumentError, 'invalid address' if !script_pubkey.p2pkh? && !script_pubkey.p2sh?
+      @change_script_pubkey = script_pubkey
+      self
+    end
+
+    # Build transaction
+    def build
+      tx = Tapyrus::Tx.new
+      expand_input(tx)
+      @outputs.each { |output| tx.outputs << output }
+      add_change(tx) if @change_script_pubkey
+      tx
+    end
+
+    private
+
+    def add_change(tx)
+      @incomings.each do |color_id, in_amount|
+        out_amount = @outgoings[color_id] || 0
+        change, script_pubkey =
+          if color_id.default?
+            [in_amount - out_amount - estimated_fee, @change_script_pubkey]
+          else
+            [in_amount - out_amount, @change_script_pubkey.add_color(color_id)]
+          end
+        tx.outputs << Tapyrus::TxOut.new(script_pubkey: script_pubkey, value: change) if change > 0
+      end
+    end
+
+    def expand_input(tx)
+      @utxos.each do |utxo|
+        tx.inputs << Tapyrus::TxIn.new(out_point: Tapyrus::OutPoint.from_txid(utxo[:txid], utxo[:index]))
+      end
+    end
+
+    # Return transaction fee
+    def estimated_fee
+      @fee
+    end
+  end
+end

data/lib/tapyrus/tx_in.rb

@@ -2,10 +2,8 @@
 # https://github.com/lian/bitcoin-ruby/blob/master/COPYING
 
 module Tapyrus
-
   # transaction input
   class TxIn
-
     attr_accessor :out_point
     attr_accessor :script_sig
     attr_accessor :sequence
@@ -58,11 +56,10 @@ module Tapyrus
       p
     end
 
-
     def to_h
       sig = script_sig.to_h
       sig.delete(:type)
-      h = {txid: out_point.txid, vout: out_point.index,  script_sig: sig }
+      h = { txid: out_point.txid, vout: out_point.index, script_sig: sig }
       h[:sequence] = sequence
       h
     end
@@ -76,7 +73,5 @@ module Tapyrus
       return nil unless out_point
       out_point.tx_hash
     end
-
   end
-
 end

data/lib/tapyrus/tx_out.rb

@@ -2,10 +2,8 @@
 # https://github.com/lian/bitcoin-ruby/blob/master/COPYING
 
 module Tapyrus
-
   # transaction output
   class TxOut
-
     include OpenAssets::MarkerOutput
     include Tapyrus::Color::ColoredOutput
 
@@ -39,7 +37,7 @@ module Tapyrus
     end
 
     def to_h
-      {value: value_to_btc, script_pubkey: script_pubkey.to_h}
+      { value: value_to_btc, script_pubkey: script_pubkey.to_h }
     end
 
     def ==(other)
@@ -65,11 +63,8 @@ module Tapyrus
       n_size = size
       n_size += (32 + 4 + 1 + 107 + 4)
       fee = n_size * Tapyrus.chain_params.dust_relay_fee / 1000
-      if fee == 0 && n_size != 0
-        fee = Tapyrus.chain_params.dust_relay_fee > 0 ? 1 : -1
-      end
+      fee = Tapyrus.chain_params.dust_relay_fee > 0 ? 1 : -1 if fee == 0 && n_size != 0
       fee
     end
   end
-
 end

data/lib/tapyrus/util.rb

@@ -2,12 +2,10 @@
 # https://github.com/lian/bitcoin-ruby/blob/master/COPYING
 
 module Tapyrus
-
   # tapyrus utility.
   # following methods can be used as follows.
   #     Tapyrus.pack_var_int(5)
   module Util
-
     def pack_var_string(payload)
       pack_var_int(payload.bytesize) + payload
     end
@@ -18,7 +16,7 @@ module Tapyrus
     end
 
     def pack_var_int(i)
-      if i <  0xfd
+      if i < 0xfd
         [i].pack('C')
       elsif i <= 0xffff
         [0xfd, i].pack('Cv')
@@ -111,10 +109,14 @@ module Tapyrus
     def decode_base58_address(addr)
       hex = Base58.decode(addr)
       if hex.size == 50 && calc_checksum(hex[0...-8]) == hex[-8..-1]
-        raise 'Invalid version bytes.' unless [Tapyrus.chain_params.address_version, Tapyrus.chain_params.p2sh_version].include?(hex[0..1])
+        unless [Tapyrus.chain_params.address_version, Tapyrus.chain_params.p2sh_version].include?(hex[0..1])
+          raise 'Invalid version bytes.'
+        end
         [hex[2...-8], hex[0..1]]
       elsif hex.size == 116 && calc_checksum(hex[0...-8]) == hex[-8..-1]
-        raise 'Invalid version bytes.' unless [Tapyrus.chain_params.cp2pkh_version, Tapyrus.chain_params.cp2sh_version].include?(hex[0..1])
+        unless [Tapyrus.chain_params.cp2pkh_version, Tapyrus.chain_params.cp2sh_version].include?(hex[0..1])
+          raise 'Invalid version bytes.'
+        end
         [hex[2...-8], hex[0..1]]
       else
         raise 'Invalid address.'
@@ -142,15 +144,11 @@ module Tapyrus
         false
       end
     end
-
   end
 
   module HexConverter
-
     def to_hex
       to_payload.bth
     end
-
   end
-
 end

data/lib/tapyrus/validation.rb

@@ -1,7 +1,5 @@
 module Tapyrus
-
   class Validation
-
     # check transaction validation
     def check_tx(tx, state)
       # Basic checks that don't depend on any context
@@ -16,14 +14,20 @@ module Tapyrus
       # Check for negative or overflow output values
       amount = 0
       tx.outputs.each do |o|
-        return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-vout-negative') if o.value < 0
-        return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-vout-toolarge') if MAX_MONEY < o.value
+        if o.value < 0
+          return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-vout-negative')
+        end
+        if MAX_MONEY < o.value
+          return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-vout-toolarge')
+        end
         amount += o.value
-        return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-vout-toolarge') if MAX_MONEY < amount
+        if MAX_MONEY < amount
+          return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-vout-toolarge')
+        end
       end
 
       # Check for duplicate inputs - note that this check is slow so we skip it in CheckBlock
-      out_points = tx.inputs.map{|i|i.out_point.to_payload}
+      out_points = tx.inputs.map { |i| i.out_point.to_payload }
       unless out_points.size == out_points.uniq.size
         return state.DoS(100, reject_code: Message::Reject::CODE_INVALID, reject_reason: 'bad-txns-inputs-duplicate')
       end
@@ -46,7 +50,6 @@ module Tapyrus
     def check_block_header(header, state)
       header.block_hash
       header.bits
-
     end
 
     def check_block(block, state)
@@ -63,12 +66,10 @@ module Tapyrus
 
       # check sigop count
     end
-
   end
 
   class ValidationState
-
-    MODE = {valid: 0, invlid: 1, error: 2}
+    MODE = { valid: 0, invlid: 1, error: 2 }
 
     attr_accessor :mode
     attr_accessor :n_dos
@@ -107,4 +108,4 @@ module Tapyrus
       mode == MODE[:error]
     end
   end
-end
+end

data/lib/tapyrus/version.rb

@@ -1,3 +1,3 @@
 module Tapyrus
-  VERSION = "0.2.7"
+  VERSION = '0.2.8'
 end

data/lib/tapyrus/wallet/account.rb

@@ -1,11 +1,10 @@
 module Tapyrus
   module Wallet
-
     # the account in BIP-44
     class Account
       include Tapyrus::HexConverter
 
-      PURPOSE_TYPE = {legacy: 44, nested_witness: 49, native_segwit: 84}
+      PURPOSE_TYPE = { legacy: 44, nested_witness: 49, native_segwit: 84 }
 
       attr_reader :purpose # either 44 or 49 or 84
       attr_reader :index # BIP-44 index
@@ -86,26 +85,26 @@ module Tapyrus
       # get the list of derived keys for receive key.
       # @return [Array[Tapyrus::ExtPubkey]]
       def derived_receive_keys
-        (receive_depth + 1).times.map{|i|derive_key(0,i)}
+        (receive_depth + 1).times.map { |i| derive_key(0, i) }
       end
 
       # get the list of derived keys for change key.
       # @return [Array[Tapyrus::ExtPubkey]]
       def derived_change_keys
-        (change_depth + 1).times.map{|i|derive_key(1,i)}
+        (change_depth + 1).times.map { |i| derive_key(1, i) }
       end
 
       # get account type label.
       def type
         case purpose
-          when PURPOSE_TYPE[:legacy]
-            'pubkeyhash'
-          when PURPOSE_TYPE[:nested_witness]
-            'p2wpkh-p2sh'
-          when PURPOSE_TYPE[:native_segwit]
-            'p2wpkh'
-          else
-            'unknown'
+        when PURPOSE_TYPE[:legacy]
+          'pubkeyhash'
+        when PURPOSE_TYPE[:nested_witness]
+          'p2wpkh-p2sh'
+        when PURPOSE_TYPE[:native_segwit]
+          'p2wpkh'
+        else
+          'unknown'
         end
       end
 
@@ -126,10 +125,17 @@ module Tapyrus
 
       def to_h
         {
-            name: name, type: type, index: index, receive_depth: receive_depth, change_depth: change_depth,
-            look_ahead: lookahead, receive_address: derive_key(0, receive_depth).addr,
-            change_address: derive_key(1, change_depth).addr,
-            account_key: account_key.to_base58, path: path, watch_only: watch_only
+          name: name,
+          type: type,
+          index: index,
+          receive_depth: receive_depth,
+          change_depth: change_depth,
+          look_ahead: lookahead,
+          receive_address: derive_key(0, receive_depth).addr,
+          change_address: derive_key(1, change_depth).addr,
+          account_key: account_key.to_base58,
+          path: path,
+          watch_only: watch_only
         }
       end
 
@@ -145,8 +151,6 @@ module Tapyrus
         version_bytes = Tapyrus::ExtPubkey.version_from_purpose(purpose + Tapyrus::HARDENED_THRESHOLD)
         raise 'The purpose and the account key do not match.' unless account_key.version == version_bytes
       end
-
     end
-
   end
 end

data/lib/tapyrus/wallet/base.rb

@@ -2,9 +2,7 @@ require 'leveldb-native'
 
 module Tapyrus
   module Wallet
-
     class Base
-
       attr_accessor :wallet_id
       attr_reader :db
       attr_reader :path
@@ -24,6 +22,7 @@ module Tapyrus
       def self.create(wallet_id = 1, path_prefix = default_path_prefix)
         raise ArgumentError, "wallet_id : #{wallet_id} already exist." if self.exist?(wallet_id, path_prefix)
         w = self.new(wallet_id, path_prefix)
+
         # generate seed
         raise RuntimeError, 'the seed already exist.' if w.db.registered_master?
         master = Tapyrus::Wallet::MasterKey.generate
@@ -122,14 +121,20 @@ module Tapyrus
 
       # decrypt wallet
       # @param [String] passphrase the wallet passphrase
-      def decrypt(passphrase)
-
-      end
+      def decrypt(passphrase); end
 
       # wallet information
       def to_h
         a = accounts.map(&:to_h)
-        { wallet_id: wallet_id, version: version, account_depth: a.size, accounts: a, master: {encrypted: master_key.encrypted} }
+        {
+          wallet_id: wallet_id,
+          version: version,
+          account_depth: a.size,
+          accounts: a,
+          master: {
+            encrypted: master_key.encrypted
+          }
+        }
       end
 
       # get data elements tobe monitored with Bloom Filter.
@@ -153,10 +158,8 @@ module Tapyrus
 
       # find account using +account_name+
       def find_account(account_name, purpose = nil)
-        accounts(purpose).find{|a| a.name == account_name}
+        accounts(purpose).find { |a| a.name == account_name }
       end
-
     end
-
   end
 end