openassets 1.0.0

data/lib/openassets/transaction/transfer_parameters.rb

@@ -0,0 +1,41 @@
+module OpenAssets
+  module Transaction
+
+    # The value object of a bitcoin or asset transfer.
+    class TransferParameters
+
+      attr_accessor :unspent_outputs
+      attr_accessor :amount
+      attr_accessor :change_script
+      attr_accessor :to_script
+      attr_accessor :output_qty
+
+      # initialize
+      # @param [Array[OpenAssets::Transaction::SpendableOutput]] unspent_outputs Array of the unspent outputs available for the transaction.
+      # @param [String] to_script the output script to which to send the assets or bitcoins.
+      # @param [String] change_script the output script to which to send any remaining change.
+      # @param [Integer] amount The asset quantity or amount of the satoshi sent in the transaction.
+      def initialize(unspent_outputs, to_script, change_script, amount, output_qty = 1)
+        @unspent_outputs = unspent_outputs
+        @to_script = to_script
+        @change_script = change_script
+        @amount = amount
+        @output_qty = output_qty
+      end
+
+      def split_output_amount
+        split_amounts = []
+        output_qty.times{|index|
+          if index == output_qty - 1
+            value = amount / output_qty + amount % output_qty
+          else
+            value = amount / output_qty
+          end
+          split_amounts << value
+        }
+        split_amounts
+      end
+    end
+
+  end
+end

data/lib/openassets/util.rb

@@ -0,0 +1,165 @@
+require 'bigdecimal'
+module OpenAssets
+  module Util
+    extend ::Bitcoin::Util
+    include ::Bitcoin::Util
+
+    # namespace of Open Asset
+    OA_NAMESPACE = 19
+
+    # version byte for Open Assets Address
+    OA_VERSION_BYTE = 23
+    OA_VERSION_BYTE_TESTNET = 115
+
+    # convert bitcoin address to open assets address
+    # @param [String] btc_address The Bitcoin address.
+    # @return [String] The Open Assets Address.
+    def address_to_oa_address(btc_address)
+      begin
+        btc_hex = Bitcoin::Base58.decode(btc_address)
+        btc_hex = '0' +btc_hex if btc_hex.size==47
+        address = btc_hex[0..-9] # bitcoin address without checksum
+        named_addr = OA_NAMESPACE.to_s(16) + address
+        oa_checksum = Bitcoin.calc_checksum(named_addr)
+        Bitcoin::Base58.encode(named_addr + oa_checksum)
+      rescue ArgumentError
+        nil # bech32 format fails to decode. TODO define OA address for segwit
+      end
+    end
+
+    # convert open assets address to bitcoin address
+    # @param [String] oa_address The Open Assets Address.
+    # @return [String] The Bitcoin address.
+    def oa_address_to_address(oa_address)
+      decode_address = Bitcoin::Base58.decode(oa_address)
+      btc_addr = decode_address[2..-9]
+      btc_checksum = Bitcoin.calc_checksum(btc_addr)
+      Bitcoin::Base58.encode(btc_addr + btc_checksum)
+    end
+
+    # generate asset ID from public key.
+    def generate_asset_id(pub_key)
+      pubkey_hash_to_asset_id(hash160(pub_key))
+    end
+
+    def pubkey_hash_to_asset_id(pubkey_hash)
+      # gen P2PKH script hash
+      # P2PKH script = OP_DUP OP_HASH160 <PubKeyHash> OP_EQUALVERIFY OP_CHECKSIG
+      # （76=OP_DUP, a9=OP_HASH160, 14=Bytes to push, 88=OP_EQUALVERIFY, ac=OP_CHECKSIG）
+      hash_to_asset_id(hash160(["76", "a9", "14", pubkey_hash, "88", "ac"].join))
+    end
+
+    def script_to_asset_id(script)
+      hash_to_asset_id(hash160(script))
+    end
+
+    def hash_to_asset_id(hash)
+      hash = oa_version_byte.to_s(16) + hash # add version byte to script hash
+      Bitcoin::Base58.encode(hash + Bitcoin.calc_checksum(hash)) # add checksum & encode
+    end
+
+    # LEB128 encode
+    def encode_leb128(value)
+      LEB128.encode_unsigned(value).read.bth
+    end
+
+    # LEB128 decode
+    def decode_leb128(value)
+      results = []
+      sio = StringIO.new
+      value.htb.each_byte{|b|
+        sio.putc(b)
+        if b < 128
+          results << LEB128.decode_unsigned(sio)
+          sio = StringIO.new
+        end
+      }
+      results
+    end
+
+    def to_bytes(string)
+      string.each_char.each_slice(2).map{|v|v.join}
+    end
+
+    # Convert satoshi to coin.
+    # @param [Integer] satoshi The amount of satoshi unit.
+    # @return [String] The amount of coin.
+    def satoshi_to_coin(satoshi)
+      "%.8f" % (satoshi / 100000000.0)
+    end
+
+    # Convert coin unit to satoshi.
+    # @param [String] coin The amount of bitcoin
+    # @return [String] The amount of satoshi.
+    def coin_to_satoshi(coin)
+      BigDecimal(coin) * BigDecimal(100000000)
+    end
+
+    # validate bitcoin address
+    def validate_address(addresses)
+      addresses.each{|a|
+        raise ArgumentError, "#{a} is invalid bitcoin address. " unless Bitcoin.valid_address?(a)
+      }
+    end
+
+    # validate asset ID
+    def valid_asset_id?(asset_id)
+      return false if asset_id.nil? || asset_id.length != 34
+      decoded = Bitcoin::Base58.decode(asset_id)
+      return false if  decoded[0,2].to_i(16) != oa_version_byte
+      p2pkh_script_hash = decoded[2..-9]
+      p2pkh_script_hash.htb.bytesize == 20
+    end
+
+    # read variable integer
+    # @param [String] data reading data
+    # @param [Integer] offset the position when reading from data.
+    # @return [[Integer, Integer]]  decoded integer value and the reading byte length.
+    # https://en.bitcoin.it/wiki/Protocol_documentation#Variable_length_integer
+    def read_var_integer(data, offset = 0)
+      raise ArgumentError, "data is nil." unless data
+      packed = [data].pack('H*')
+      return [nil, 0] if packed.bytesize < 1+offset
+      bytes = packed.bytes[offset..(offset + 9)] # 9 is variable integer max storage length.
+      first_byte = bytes[0]
+      if first_byte < 0xfd
+        [first_byte, offset + 1]
+      elsif first_byte == 0xfd
+        [calc_var_integer_val(bytes[1..2]), offset + 3]
+      elsif first_byte == 0xfe
+        [calc_var_integer_val(bytes[1..4]), offset + 5]
+      elsif first_byte == 0xff
+        [calc_var_integer_val(bytes[1..8]), offset + 9]
+      end
+    end
+
+    # read leb128 value
+    # @param [String] data reading data
+    # @param [Integer] offset start position when reading from data.
+    # @return [[Integer, Integer]]  decoded integer value and the reading byte length.
+    def read_leb128(data, offset = 0)
+      bytes = [data].pack('H*').bytes
+      result = 0
+      shift = 0
+      while true
+        return [nil, offset] if bytes.length < 1 + offset
+        byte = bytes[offset..(offset + 1)][0]
+        result |= (byte & 0x7f) << shift
+        break if byte & 0x80 == 0
+        shift += 7
+        offset += 1
+      end
+      [result, offset + 1]
+    end
+
+    private
+    def oa_version_byte
+      Bitcoin.chain_params.mainnet? ? OA_VERSION_BYTE : OA_VERSION_BYTE_TESTNET
+    end
+
+    def calc_var_integer_val(byte_array)
+      byte_array.each_with_index.inject(0){|sum, pair| pair[1] == 0 ? pair[0] : sum + pair[0]*(256**pair[1])}
+    end
+    
+  end
+end

data/lib/openassets/version.rb

@@ -0,0 +1,3 @@
+module OpenAssets
+  VERSION = '1.0.0'
+end

data/openassets.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openassets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openassets"
+  spec.version       = OpenAssets::VERSION
+  spec.authors       = ["azuchi"]
+  spec.email         = ["azuchi@chaintope.com"]
+
+  spec.summary       = %q{The implementation of the Open Assets Protocol for Ruby.}
+  spec.description   = %q{The implementation of the Open Assets Protocol for Ruby.}
+  spec.homepage      = "https://github.com/chaintope/openassetsrb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "bitcoinrb", ">= 0.3.2"
+  spec.add_runtime_dependency "ffi", "~>1.9.8"
+  spec.add_runtime_dependency "rest-client", "2.0.2"
+  spec.add_runtime_dependency "httpclient"
+  spec.add_runtime_dependency "sqlite3"
+  spec.add_runtime_dependency "leb128", '~> 1.0.0'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "travis"
+
+end

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: openassets
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- azuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitcoinrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.8
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: leb128
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The implementation of the Open Assets Protocol for Ruby.
+email:
+- azuchi@chaintope.com
+executables:
+- openassets
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/openassets
+- lib/openassets.rb
+- lib/openassets/api.rb
+- lib/openassets/cache.rb
+- lib/openassets/cache/output_cache.rb
+- lib/openassets/cache/sqlite_base.rb
+- lib/openassets/cache/ssl_certificate_cache.rb
+- lib/openassets/cache/transaction_cache.rb
+- lib/openassets/error.rb
+- lib/openassets/medhod_filter.rb
+- lib/openassets/protocol.rb
+- lib/openassets/protocol/asset_definition.rb
+- lib/openassets/protocol/asset_definition_loader.rb
+- lib/openassets/protocol/http_asset_definition_loader.rb
+- lib/openassets/protocol/marker_output.rb
+- lib/openassets/protocol/output_type.rb
+- lib/openassets/protocol/transaction_output.rb
+- lib/openassets/provider.rb
+- lib/openassets/provider/api_error.rb
+- lib/openassets/provider/bitcoin_core_provider.rb
+- lib/openassets/provider/block_chain_provider_base.rb
+- lib/openassets/send_asset_param.rb
+- lib/openassets/send_bitcoin_param.rb
+- lib/openassets/transaction.rb
+- lib/openassets/transaction/dust_output_error.rb
+- lib/openassets/transaction/insufficient_asset_quantity_error.rb
+- lib/openassets/transaction/insufficient_funds_error.rb
+- lib/openassets/transaction/spendable_output.rb
+- lib/openassets/transaction/transaction_build_error.rb
+- lib/openassets/transaction/transaction_builder.rb
+- lib/openassets/transaction/transfer_parameters.rb
+- lib/openassets/util.rb
+- lib/openassets/version.rb
+- openassets.gemspec
+homepage: https://github.com/chaintope/openassetsrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The implementation of the Open Assets Protocol for Ruby.
+test_files: []