xrbp 0.2.2 → 0.2.3

data/lib/xrbp/nodestore/protocol/issue.rb

@@ -8,9 +8,24 @@ module XRBP
         @account  = account
       end
 
+      def to_h
+        {:currency => currency, :account => account}
+      end
+
       def xrp?
         self == NodeStore.xrp_issue
       end
+
+      def inspect
+        c = currency == NodeStore.no_currency  ? ''    :
+            currency == NodeStore.xrp_currency ? 'XRP' :
+                                         "#{currency}"
+
+        a = account == Crypto.no_account  ? '' :
+            account == Crypto.xrp_account ? '' :
+                                 "@#{account}"
+        "#{c}#{a}"
+      end
     end # class Issue
 
     def self.xrp_issue

data/lib/xrbp/nodestore/protocol/rate.rb

@@ -1,5 +1,16 @@
 module XRBP
   module NodeStore
+    #  Represents a transfer rate.
+    #
+    # The percent of an amount sent that is charged
+    # to the sender and paid to the issuer.
+    #
+    # https://xrpl.org/transfer-fees.html
+    #
+    # From rippled docs:
+    #   Transfer rates are specified as fractions of 1 billion.
+    #   For example, a transfer rate of 1% is represented as
+    #     1,010,000,000.
     class Rate
       attr_reader :rate
 
@@ -7,12 +18,13 @@ module XRBP
         @rate = rate
       end
 
+      # Rate signifying a 1:1 exchange
       def self.parity
         @parity ||= Rate.new(QUALITY_ONE)
       end
 
       def to_amount
-        STAmount.new :issue    => Issue.no_issue,
+        STAmount.new :issue    => NodeStore.no_issue,
                      :mantissa => rate,
                      :exponent =>   -9
       end

data/lib/xrbp/nodestore/shamap/node_factory.rb

@@ -1,6 +1,8 @@
 module XRBP
   class SHAMap
     module NodeFactory
+      # Create a new node whose type is specified in the binary prefix.
+      #
       # See rippled::SHAMapAbstractNode::make
       def make(node, seq, format, hash, hash_valid)
         node_id = NodeID.new
@@ -22,6 +24,7 @@ module XRBP
 
           s = node[4..-1]
 
+          # Transaction node (no metadata)
           if prefix == NodeStore::Format::HASH_PREFIXES[:tx_id]
             sha512  = OpenSSL::Digest::SHA512.new
             sha512 <<  NodeStore::Format::HASH_PREFIXES[:tx_id]
@@ -38,6 +41,7 @@ module XRBP
 
             return TreeNode.new(tree_node)
 
+          # Leaf node in state tree containing data (account info, order, etc)
           elsif prefix == NodeStore::Format::HASH_PREFIXES[:leaf_node]
             raise "short PLN node" if s.size < 32
 
@@ -55,6 +59,7 @@ module XRBP
 
             return TreeNode.new(tree_node)
 
+          # Inner tree node referencing other nodes
           elsif (prefix == NodeStore::Format::HASH_PREFIXES[:inner_node]) ||
                 (prefix == NodeStore::Format::HASH_PREFIXES[:inner_node_v2])
             len = s.size
@@ -89,8 +94,8 @@ module XRBP
 
             return ret
 
+          # Transaction node (with metadata)
           elsif prefix == NodeStore::Format::HASH_PREFIXES[:tx_node]
-            # transaction with metadata
             raise "short TXN node" if s.size < 32
 
             tx_id = s[-32..-1]

data/lib/xrbp/nodestore/shamap/node_id.rb

@@ -20,7 +20,7 @@ module XRBP
       # Used to calculate inner node hash for
       # tree level:
       #   inner node = lookup key & mask
-      def masks
+      def self.masks
         @masks ||= begin
           masks = Array.new(MASK_SIZE)
 
@@ -41,7 +41,7 @@ module XRBP
 
       # Return mask for current tree depth
       def mask
-        @mask ||= masks[depth]
+        @mask ||= self.class.masks[depth]
       end
 
       # Return branch number of specified hash.

data/lib/xrbp/nodestore/sle/st_amount.rb

@@ -1,9 +1,37 @@
+require_relative './st_amount_arithmatic'
+require_relative './st_amount_comparison'
+require_relative './st_amount_conversion'
+
 module XRBP
   module NodeStore
-    # Serialized Amount Representation
+    # Serialized Amount Representation.
+    #
+    # From rippled docs:
+    #   Internal form:
+    #     1: If amount is zero, then value is zero and offset is -100
+    #     2: Otherwise:
+    #        legal offset range is -96 to +80 inclusive
+    #        value range is 10^15 to (10^16 - 1) inclusive
+    #        amount = value * [10 ^ offset]
+    #
+    #   Wire form:
+    #     High 8 bits are (offset+142), legal range is, 80 to 22 inclusive
+    #     Low 56 bits are value, legal range is 10^15 to (10^16 - 1) inclusive
     class STAmount
-      # see: https://github.com/ripple/rippled/blob/b53fda1e1a7f4d09b766724274329df1c29988ab/src/ripple/protocol/STAmount.h#L67
-      MIN_VAL = 1000000000000000
+      include Arithmatic
+      include Comparison
+      include Conversion
+
+      # DEFINES FROM STAmount.h
+
+      MIN_OFFSET = -96
+      MAX_OFFSET = 80
+
+      MIN_VAL    = 1000000000000000
+      MAX_VAL    = 9999999999999999
+      NOT_NATIVE = 0x8000000000000000
+      POS_NATIVE = 0x4000000000000000
+      MAX_NATIVE = 100000000000000000
 
       attr_reader :mantissa, :exponent, :neg
       attr_accessor :issue
@@ -19,7 +47,8 @@ module XRBP
         return STAmount.new(:issue => NodeStore.no_issue) if rate == 0
 
         mantissa = rate & ~(255 << (64 - 8))
-        exponent = (rate >> (64 - 8)) - 100
+
+        exponent = (rate >> (64 - 8)).to_int32 - 100
 
         return STAmount.new(:issue    => NodeStore.no_issue,
                             :mantissa => mantissa,
@@ -31,195 +60,31 @@ module XRBP
         @mantissa = args[:mantissa] || 0
         @exponent = args[:exponent] || 0
         @neg      = !!args[:neg]
-      end
 
-      def native?
-        @issue.xrp?
-      end
-
-      def zero?
-        @mantissa == 0
-      end
-
-      def clear
-        # see: https://github.com/ripple/rippled/blob/b53fda1e1a7f4d09b766724274329df1c29988ab/src/ripple/protocol/STAmount.h#L224
-        @exponent = native? ? 0 : -100
-
-        @neg = false
-        @mantissa = 0
-      end
-
-      def negate!
-        return if zero?
-        @neg = !@neg
-      end
-
-      def sn_value
-        neg ? (-mantissa) : mantissa
+        canonicalize
       end
 
       ###
 
-      # In drops!
-      def xrp_amount
-        neg ? (-value) : value
-      end
-
-      alias :drops :xrp_amount
-
-      def iou_amount
-        (neg ? -1 : 1) * mantissa * 10 ** (exponent-97)
-      end
-
-      ###
-
-      def +(v)
-        e1 = exponent
-        e2 = v.exponent
-
-        m1 = mantissa
-        m2 = v.mantissa
-
-        m1 *= -1 if   neg
-        m2 *= -1 if v.neg
-
-        while e1 < e2
-          m1 /= 10
-          e1 += 1
-        end
-
-        while e2 < e1
-          m2 /= 10
-          e2 += 1
-        end
-
-        m = m1 + m2
-        return STAmount.new :issue => issue if m >= -10 && m <= 10
-        return STAmount.new :mantissa => m,
-                            :exponent => e1,
-                            :issue    => issue if m >= 0
-        return STAmount.new :mantissa => -m,
-                            :exponent => e1,
-                            :issue    => issue
-      end
-
-      def -(v)
-        self + (-v)
-      end
-
-      def /(v)
-        if v.is_a?(Rate)
-          return self if v == Rate.parity
-          return self / v.to_amount
-        end
-
-        raise "divide by zero" if v.zero?
-        return STAmount.new :issue => issue
-
-        nm = mantissa
-        dm = v.mantissa
-
-        ne = exponent
-        de = v.exponent
-
-        if native?
-          while nm < MIN_VAL
-            nm *= 10
-            ne -= 1
-          end
-        end
-
-        if v.native?
-          while dm < MIN_VAL
-            dm *= 10
-            de -= 1
-          end
-        end
-
-        # see note: https://github.com/ripple/rippled/blob/b53fda1e1a7f4d09b766724274329df1c29988ab/src/ripple/protocol/impl/STAmount.cpp#L1075
-        STAmount.new :issue => issue,
-                     :mantissa => (nm * 10**17)/dm,
-                     :exponent => (ne - de - 17),
-                     :neg      => (neg != v.neg)
-      end
-
-      def *(o)
-        return STAmount.new :issue => issue if zero? || o.zero?
-
-        if native?
-          min = sn_value < o.sn_value ?   sn_value : o.sn_value
-          max = sn_value < o.sn_value ? o.sn_value :   sn_value
-
-          return STAmount.new :mantissa => min * max
-        end
-
-        m1 =   mantissa
-        m2 = o.mantissa
-        e1 =   exponent
-        e2 = o.exponent
-
-        if native?
-          while nm < MIN_VAL
-            m1 *= 10
-            e1 -= 1
-          end
-        end
-
-        if o.native?
-          while dm < MIN_VAL
-            m2 *= 10
-            e2 -= 1
-          end
-        end
-
-        # see note: https://github.com/ripple/rippled/blob/b53fda1e1a7f4d09b766724274329df1c29988ab/src/ripple/protocol/impl/STAmount.cpp#L1131
-        STAmount.new :issue => issue,
-                     :mantissa => (m1 * m2)/(10**14),
-                     :exponent => (e1 + e2 + 14),
-                     :neg      => (neg != o.neg)
-      end
-
-      def -@
-        STAmount.new(:mantissa => mantissa,
-                     :exponent => exponent,
-                     :issue    => issue,
-                     :neg      => !neg)
-      end
-
-      def <(o)
-        return neg if neg && !o.neg
-        if mantissa == 0
-          return false if o.neg
-          return o.mantissa != 0
-        end
-
-        return false if o.mantissa == 0
-        return  neg  if exponent > o.exponent
-        return !neg  if exponent < o.exponent
-        return  neg  if mantissa > o.mantissa
-        return !neg  if mantissa < o.mantissa
-
-        return false
+      def native?
+        @issue && @issue.xrp?
       end
 
-      def >=(o)
-        !(self < o)
+      def zero?
+        @mantissa == 0
       end
 
-      def >(o)
-        self >= o && self != o
-      end
+      def inspect
+        return "0" if zero?
 
-      def ==(o)
-             neg == o.neg      &&
-        mantissa == o.mantissa &&
-        exponent == o.exponent
+        i = issue.inspect
+        i = i == '' ? '' : "(#{i})"
+        (native? ? xrp_amount : iou_amount.to_f).to_s +
+        (native? ?         "" : i)
       end
 
-      def <=>(o)
-        return  0 if self == o
-        return -1 if self  < o
-        return  1 if self  > o
+      def to_s
+        inspect
       end
     end # class STAmount
   end # module NodeStore

data/lib/xrbp/nodestore/sle/st_amount_arithmatic.rb

@@ -0,0 +1,126 @@
+module XRBP
+  module NodeStore
+    class STAmount
+      module Arithmatic
+        def +(v)
+          return self + STAmount.new(:mantissa => v) if v.kind_of?(Numeric)
+
+          e1 = exponent
+          e2 = v.exponent
+
+          m1 = mantissa
+          m2 = v.mantissa
+
+          m1 *= -1 if   neg
+          m2 *= -1 if v.neg
+
+          while e1 < e2
+            m1 /= 10
+            e1 += 1
+          end
+
+          while e2 < e1
+            m2 /= 10
+            e2 += 1
+          end
+
+          m = m1 + m2
+          return STAmount.new :issue => issue if m >= -10 && m <= 10
+          return STAmount.new :mantissa => m,
+                              :exponent => e1,
+                              :issue    => issue if m >= 0
+          return STAmount.new :mantissa => -m,
+                              :exponent => e1,
+                              :issue    => issue
+        end
+
+        def -(v)
+          self + (-v)
+        end
+
+        def /(v)
+          return self / STAmount.new(:mantissa => v) if v.kind_of?(Numeric)
+
+          if v.is_a?(Rate)
+            return self if v == Rate.parity
+            return self / v.to_amount
+          end
+
+          raise "divide by zero" if v.zero?
+          return STAmount.new :issue => issue if zero?
+
+          nm = mantissa
+          dm = v.mantissa
+
+          ne = exponent
+          de = v.exponent
+
+          if native?
+            while nm < MIN_VAL
+              nm *= 10
+              ne -= 1
+            end
+          end
+
+          if v.native?
+            while dm < MIN_VAL
+              dm *= 10
+              de -= 1
+            end
+          end
+
+          # see note: https://github.com/ripple/rippled/blob/b53fda1e1a7f4d09b766724274329df1c29988ab/src/ripple/protocol/impl/STAmount.cpp#L1075
+          STAmount.new :issue => issue,
+                       :mantissa => (nm * 10**17)/dm + 5,
+                       :exponent => (ne - de - 17),
+                       :neg      => (neg != v.neg)
+        end
+
+        def *(o)
+          return self * STAmount.new(:mantissa => o) if o.kind_of?(Numeric)
+
+          return STAmount.new :issue => issue if zero? || o.zero?
+
+          if native? && o.native?
+            min = sn_value < o.sn_value ?   sn_value : o.sn_value
+            max = sn_value < o.sn_value ? o.sn_value :   sn_value
+
+            return STAmount.new :mantissa => min * max
+          end
+
+          m1 =   mantissa
+          m2 = o.mantissa
+          e1 =   exponent
+          e2 = o.exponent
+
+          if native?
+            while nm < MIN_VAL
+              m1 *= 10
+              e1 -= 1
+            end
+          end
+
+          if o.native?
+            while dm < MIN_VAL
+              m2 *= 10
+              e2 -= 1
+            end
+          end
+
+          # see note: https://github.com/ripple/rippled/blob/b53fda1e1a7f4d09b766724274329df1c29988ab/src/ripple/protocol/impl/STAmount.cpp#L1131
+          STAmount.new :issue => issue,
+                       :mantissa => (m1 * m2)/(10**14) + 7,
+                       :exponent => (e1 + e2 + 14),
+                       :neg      => (neg != o.neg)
+        end
+
+        def -@
+          STAmount.new(:mantissa => mantissa,
+                       :exponent => exponent,
+                       :issue    => issue,
+                       :neg      => !neg)
+      end
+      end # module Arithmatic
+    end # class STAmount
+  end # module NodeStore
+end # module XRBP