btcruby 0.0.0 → 1.0.0

data/lib/btcruby/diagnostics.rb

@@ -0,0 +1,92 @@
+module BTC
+  class Diagnostics
+
+    # Instance unique for this thread.
+    def self.current
+      Thread.current[:BTCRubyDiagnosticsCurrentInstance] ||= self.new
+    end
+
+    attr_accessor :last_message
+    attr_accessor :last_info
+    attr_accessor :last_item
+
+    # Begins recording of series of messages and returns all recorded events.
+    # If there is no record block on any level, messages are not accumulated,
+    # but only last_message is updated.
+    # Returns a list of all recorded messages.
+    def record(&block)
+      recording_groups << Array.new
+      last_group = nil
+      begin
+        yield
+      ensure
+        last_group = recording_groups.pop
+      end
+      last_group
+    end
+
+    # Prints out every message to a stream.
+    # Default stream is $stderr.
+    # You can nest these calls with different streams and each of them will
+    # receive logged messages.
+    def trace(stream = $stderr, &block)
+      @trace_streams << stream
+      # Use uniq list internally so when nested we don't write the same thing twice.
+      @uniq_trace_streams = @trace_streams.uniq
+      begin
+        yield
+      ensure
+        @trace_streams.pop
+        @uniq_trace_streams = @trace_streams.uniq
+      end
+      self
+    end
+
+    # Adds a diagnostic message.
+    # Use it to record warnings and reasons for errors.
+    # Do not use when the input is nil - code that have produced that nil
+    # could have already recorded a specific message for that.
+    def add_message(message, info: nil)
+      self.last_message = message
+      self.last_info = info
+      self.last_item = Item.new(message, info)
+
+      # add to each recording group
+      recording_groups.each do |group|
+        group << Item.new(message, info)
+      end
+
+      @uniq_trace_streams.each do |stream|
+        stream.puts message
+      end
+
+      return self
+    end
+
+    private
+
+    # Array of arrays
+    attr_accessor :recording_groups
+
+    def initialize
+      @trace_streams = []
+      @uniq_trace_streams = []
+      @recording_groups = []
+    end
+
+    class Item
+      attr_accessor :message
+      attr_accessor :info
+
+      def initialize(message, info)
+        @message = message
+        @info = info
+      end
+
+      def to_s
+        message.to_s
+      end
+    end
+
+  end
+end

data/lib/btcruby/errors.rb

@@ -0,0 +1,8 @@
+module BTC
+  class BTCError < StandardError
+  end
+  class FormatError < BTCError
+  end
+  class MathError < BTCError
+  end
+end

data/lib/btcruby/extensions.rb

@@ -0,0 +1,65 @@
+module BTC
+  module StringExtensions
+
+    # Converts binary string as a private key to a WIF Base58 format.
+    def to_wif(network: nil, public_key_compressed: nil)
+      BTC::WIF.new(private_key: self, network: network, public_key_compressed: public_key_compressed).to_s
+    end
+
+    # Decodes string in WIF format into a binary private key (32 bytes)
+    def from_wif
+      addr = BTC::WIF.new(string: self)
+      addr ? addr.private_key : nil
+    end
+
+    # Converts binary data into hex string
+    def to_hex
+      BTC::Data.hex_from_data(self)
+    end
+
+    # Converts hex string into a binary data
+    def from_hex
+      BTC::Data.data_from_hex(self)
+    end
+
+    # Various hash functions
+    def hash256
+      BTC.hash256(self)
+    end
+
+    def hash160
+      BTC.hash160(self)
+    end
+
+    def sha1
+      BTC.sha1(self)
+    end
+
+    def ripemd160
+      BTC.ripemd160(self)
+    end
+
+    def sha256
+      BTC.sha256(self)
+    end
+
+    def sha512
+      BTC.sha512(self)
+    end
+
+    def hmac_sha256(data: nil, key: nil)
+      raise ArgumentError, "Either data or key must be specified" if !data && !key
+      BTC.hmac_sha256(data: data || self, key: key || self)
+    end
+
+    def hmac_sha512(data: nil, key: nil)
+      raise ArgumentError, "Either data or key must be specified" if !data && !key
+      BTC.hmac_sha512(data: data || self, key: key || self)
+    end
+
+  end
+end
+
+class ::String
+  include BTC::StringExtensions
+end

data/lib/btcruby/hash_functions.rb

@@ -0,0 +1,54 @@
+require 'digest/sha1'
+require 'digest/sha2'
+require 'digest/rmd160'
+require 'digest/hmac'
+
+module BTC
+  
+  # This allows doing `BTC.sha256(...)`
+  module HashFunctions; end
+  include HashFunctions
+  extend self
+
+  module HashFunctions
+
+    def sha1(data)
+      raise ArgumentError, "Data is missing" if !data
+      Digest::SHA1.digest(data)
+    end
+
+    def sha256(data)
+      raise ArgumentError, "Data is missing" if !data
+      Digest::SHA256.digest(data)
+    end
+
+    def sha512(data)
+      raise ArgumentError, "Data is missing" if !data
+      Digest::SHA512.digest(data)
+    end
+
+    def ripemd160(data)
+      raise ArgumentError, "Data is missing" if !data
+      Digest::RMD160.digest(data)
+    end
+
+    def hash256(data)
+      sha256(sha256(data))
+    end
+
+    def hash160(data)
+      ripemd160(sha256(data))
+    end
+
+    def hmac_sha256(data: nil, key: nil)
+      raise ArgumentError, "Data is missing" if !data || !key
+      Digest::HMAC.digest(data, key, Digest::SHA256)
+    end
+
+    def hmac_sha512(data: nil, key: nil)
+      raise ArgumentError, "Data is missing" if !data || !key
+      Digest::HMAC.digest(data, key, Digest::SHA512)
+    end
+
+  end
+end

data/lib/btcruby/hash_id.rb

@@ -0,0 +1,18 @@
+module BTC
+
+  # Transaction ID <-> Transaction Hash conversion
+  # Block ID <-> Block Hash conversion
+
+  # Converts string transaction or block ID into binary hash.
+  def self.hash_from_id(identifier)
+    return nil if !identifier # so we can convert optional ID into optional hash without extra headache
+    BTC::Data.data_from_hex(identifier).reverse
+  end
+
+  # Converts binary hash to hex identifier (as a big-endian 256-bit integer).
+  def self.id_from_hash(hash)
+    return nil if !hash  # so we can convert optional hash into optional ID without extra headache
+    BTC::Data.hex_from_data(hash.reverse)
+  end
+
+end