xrbp 0.2.2 → 0.2.3

data/spec/xrbp/nodestore/fees_spec.rb

@@ -0,0 +1,3 @@
+describe XRBP::NodeStore::Fees do
+  it "returns account reserve"
+end

data/spec/xrbp/nodestore/ledger_access.rb

@@ -6,10 +6,95 @@ shared_examples "ledger access" do |opts={}|
   let(:iou1) { {:currency => 'USD', :account => issuer} }
   let(:iou2) { {:currency => 'EUR', :account => issuer} }
 
-  let(:order1) { { :ledger_entry_type=>:offer, :flags=>131072, :sequence=>219, :previous_txn_lgr_seq=>47926685, :book_node=>0, :owner_node=>0, :previous_txn_id=>"e43add1bd4ac2049e0d9de6bc279b7fd95a99c8de2c4694a4a7623f6d9aaae29", :book_directory=>"7e5f614417c2d0a7cefeb73c4aa773ed5b078de2b5771f6d56038d7ea4c68000", :taker_pays=>XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 2459108753792364, :exponent => 83), :taker_gets => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 2459108753792364, :exponent => 82), :account=>"rnixnrMHHvR7ejMpJMRCWkaNrq3qREwMDu", :taker_gets_funded=> XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B")), :taker_pays_funded => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B")) } }
-  let(:order2) { { :ledger_entry_type=>:offer, :flags=>131072, :sequence=>19, :previous_txn_lgr_seq=>43166305, :book_node=>0, :owner_node=>0, :previous_txn_id=>"b63b2ecd124fe6b02bc2998929517266bd221a02fee51dde4992c1bcb7e86cd3", :book_directory=>"7e5f614417c2d0a7cefeb73c4aa773ed5b078de2b5771f6d56038d7ea4c68000", :taker_pays=>XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 3520000000000000, :exponent => 83), :taker_gets => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 3520000000000000, :exponent => 82), :account=>"rKwjWCKBaASEvtHCxtvReNd2i9n8DxSihk", :taker_gets_funded=>XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B")), :taker_pays_funded => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B")) }  }
+  let(:order1) { {
+    :ledger_entry_type=>:offer,
+    :flags=>131072,
+    :sequence=>219,
+    :previous_txn_lgr_seq=>47926685,
+    :book_node=>0,
+    :owner_node=>0,
+    :previous_txn_id=>"e43add1bd4ac2049e0d9de6bc279b7fd95a99c8de2c4694a4a7623f6d9aaae29",
+    :book_directory=>"7e5f614417c2d0a7cefeb73c4aa773ed5b078de2b5771f6d56038d7ea4c68000",
+    :taker_pays=>XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 2459108753792364, :exponent => -14),
+    :taker_gets => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 2459108753792364, :exponent => -15),
+    :account=>"rnixnrMHHvR7ejMpJMRCWkaNrq3qREwMDu",
+    :owner_funds => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", XRBP::Crypto.no_account), :mantissa => 2872409153061363, :exponent => -15),
+    :quality => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore.no_issue, :mantissa => 1000000000000000, :exponent => -14),
+  } }
+
+  let(:order2) { {
+    :ledger_entry_type=>:offer,
+    :flags=>131072,
+    :sequence=>19,
+    :previous_txn_lgr_seq=>43166305,
+    :book_node=>0,
+    :owner_node=>0,
+    :previous_txn_id=>"b63b2ecd124fe6b02bc2998929517266bd221a02fee51dde4992c1bcb7e86cd3",
+    :book_directory=>"7e5f614417c2d0a7cefeb73c4aa773ed5b078de2b5771f6d56038d7ea4c68000",
+    :taker_pays=>XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 3520000000000000, :exponent => -14),
+    :taker_pays_funded=>XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("USD", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 3516160294182094, :exponent => -14),
+    :taker_gets => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"), :mantissa => 3520000000000000, :exponent => -15), :account=>"rKwjWCKBaASEvtHCxtvReNd2i9n8DxSihk",
+    :taker_gets_funded => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", XRBP::Crypto.no_account), :mantissa => 3516160294182094, :exponent => -15), :account=>"rKwjWCKBaASEvtHCxtvReNd2i9n8DxSihk",
+    :owner_funds => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore::Issue.new("EUR", XRBP::Crypto.no_account), :mantissa => 3523192614770459, :exponent => -15),
+    :quality => XRBP::NodeStore::STAmount.new(:issue => XRBP::NodeStore.no_issue, :mantissa => 1000000000000000, :exponent => -14),
+  } }
+
   let(:order_book) { [order1, order2] }
 
+  it "provides access to ledger state map"
+
+  it "provides access to ledger tx map"
+
+  it "provides access to ledger info"
+
+  describe "#global_frozen?" do
+    context "account globally frozen in ledger" do
+      it "returns true"
+    end
+
+    context "account not globally frozen in ledger" do
+      it "returns false"
+    end
+  end
+
+  describe "#frozen?" do
+    context "account trust line frozen" do
+      it "returns true"
+    end
+
+    context "account trust line not frozen" do
+      it "returns false"
+    end
+  end
+
+  describe "#account_holds" do
+    it "returns balance of account iou trust line"
+
+    context "currency == 'XRP'" do
+      it "returns liquid xrp"
+    end
+  end
+
+  describe "#xrp_liquid" do
+    context "account not found" do
+      it "returns zero amount minus reserve"
+    end
+
+    it "returns xrp account balance minus reserve"
+
+    context "fix1141 in effect" do
+      it "confines owner account"
+    end
+  end
+
+  describe "#confine_owner_account" do
+    it "adjusts and returns amount"
+  end
+
+  describe "#transfer_rate" do
+    it "returns transfer rate for specified issuer"
+  end
+
   it "provides access to order book" do
     actual = ledger.order_book(iou1, iou2)
     expect(actual).to eq(order_book)

data/spec/xrbp/nodestore/protocol/indexes_spec.rb

@@ -0,0 +1,43 @@
+describe XRBP::NodeStore::Indexes do
+  it "returns quality for base" do
+    base = 57159940697819848473151736347809673846048755675063285491534159019684120657920.byte_string
+    described_class.get_quality(base).should eq(6197953087261802496)
+  end
+
+  it "returns next quality for base" do
+    base = 57159940697819848473151736347809673846048755675063285491534159019684120657920.byte_string
+     nxt = 57159940697819848473151736347809673846048755675063285491552605763757830209536
+    described_class.get_quality_next(base).to_bn.should eq(nxt)
+  end
+
+  it "returns directory node index"
+
+  it "returns page index"
+
+  it "returns account index" do
+    account = "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
+    described_class.account(account).to_bn.should eq(83149858826312963445632044328430706857892442949720032032422519427184563347763)
+  end
+
+  context "account > issuer" do
+    it "returns trust line index" do
+      account = "rnixnrMHHvR7ejMpJMRCWkaNrq3qREwMDu"
+          iou = {:currency=>"EUR", :account=>"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"}
+      described_class.line(account, iou).to_bn.should eq(45370088078399581796930875479259405419767996706903582207576813674682296859050)
+    end
+  end
+
+  context "account < issuer" do
+    it "returns trust line index" do
+      account = "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
+          iou = {:currency=>"EUR", :account=>"rnixnrMHHvR7ejMpJMRCWkaNrq3qREwMDu"}
+      described_class.line(account, iou).to_bn.should eq(45370088078399581796930875479259405419767996706903582207576813674682296859050)
+    end
+  end
+
+  it "returns order book index" do
+     input = {:currency=>"USD", :account=>"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"}
+    output = {:currency=>"EUR", :account=>"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"}
+    described_class.order_book(input, output).to_bn.should eq(57159940697819848473151736347809673846048755675063285491527961066596858855424)
+  end
+end

data/spec/xrbp/nodestore/protocol/rate_spec.rb

@@ -0,0 +1,12 @@
+describe XRBP::NodeStore::Rate do
+  it "is convertable to an amount" do
+    rate = described_class.new 2000000000
+    amount = rate.to_amount
+
+    amount.issue.should be(XRBP::NodeStore.no_issue)
+    amount.mantissa.should eq(2000000000000000)
+    amount.exponent.should eq(-15)
+
+    amount.iou_amount.should eq(2)
+  end
+end

data/spec/xrbp/nodestore/shamap/inner_node_spec.rb

@@ -0,0 +1,44 @@
+describe XRBP::SHAMap::InnerNode do
+  context "no branches" do
+    it "is empty"
+
+    it "always returns true empty_branch?"
+
+    it "always returns nil child hash"
+
+    it "always returns nil child"
+  end
+
+  context "child branches" do
+    before(:each) do
+    end
+
+    it "is not empty"
+
+    context "querying for non-empty child" do
+      it "returns false empty_branch?"
+
+      it "it returns child hash"
+
+      it "returns child"
+    end
+
+    context "querying for empty child" do
+      it "returns true empty_branch?"
+
+      it "returns nil child hash"
+
+      it "returns nil child"
+    end
+
+    context "querying for invalid branch" do
+      it "always return true empty_child?"
+
+      it "raises error when retrieving child hash"
+
+      it "raises error when retrieving child"
+    end
+  end
+
+  it "updates hash"
+end # describe XRBP::SHAMap::InnerNode

data/spec/xrbp/nodestore/shamap/node_factory_spec.rb

@@ -0,0 +1,9 @@
+describe XRBP::SHAMap::Node do
+  it "makes tx_id node"
+
+  it "makes leaf_node node"
+
+  it "makes inner_node node"
+
+  it "makes tx_node node"
+end # describe XRBP::SHAMap::Node

data/spec/xrbp/nodestore/shamap/node_id_spec.rb

@@ -0,0 +1,6 @@
+describe XRBP::SHAMap::NodeID do
+  it "returns masks for depth"
+  it "returns mask for depth"
+  it "returns branch for given hash"
+  it "returns child node id for given branch"
+end # describe XRBP::SHAMap::NodeID

data/spec/xrbp/nodestore/shamap/node_spec.rb

@@ -0,0 +1,25 @@
+describe XRBP::SHAMap::Node do
+  it "is not a tree_node?" do
+    expect(described_class.new).to_not be_a_tree_node
+  end
+
+  it "is not an inner?" do
+    expect(described_class.new).to_not be_an_inner
+  end
+
+  it "does not allow hash to be updated" do
+    expect { described_class.new.update_hash }.to raise_error("abstract: must be called on a subclass")
+  end
+
+  context "leaf type" do
+    it "is a leaf?" do
+      expect(described_class.new(:type => :transaction_nm)).to be_a_leaf
+    end
+  end
+
+  context "non leaf type" do
+    it "is not a leaf?" do
+      expect(described_class.new(:type => :infer)).to_not be_a_leaf
+    end
+  end
+end # describe XRBP::SHAMap::Node

data/spec/xrbp/nodestore/shamap_spec.rb

@@ -0,0 +1,144 @@
+describe XRBP::SHAMap do
+  describe "#each" do
+    it "iterates over all SHAMap items"
+  end
+
+  describe "#succ" do
+    it "returns next key in tree greater than specified one"
+
+    context "next item is map end" do
+      it "returns nil"
+    end
+
+    context "next item is >= last" do
+      it "returns nil"
+    end
+  end
+
+  describe "#read" do
+    it "returns SLE read from database"
+
+    context "specified key is zero" do
+      it "raises error"
+    end
+
+    context "not found" do
+      it "returns nil"
+    end
+  end
+
+  describe "#peek_item" do
+    it "returns item corresponding to database key"
+
+    context "item not found" do
+      it "returns nil"
+    end
+  end
+
+  describe "#peek_first_item" do
+    it "returns first item below root and stack"
+
+    context "no item" do
+      it "returns nil"
+    end
+  end
+
+  describe "#peek_next_item" do
+    it "returns next item in map"
+
+    context "specified stack is empty" do
+      it "raises error"
+    end
+
+    context "top of stack is not leaf" do
+      it "raises error"
+    end
+  end
+
+  describe "#fetch_node" do
+    it "retrieves node from db"
+
+    context "node not found" do
+      it "raises error"
+    end
+  end
+
+  describe "#fetch_node_nt" do
+    it "retrieves node from db"
+
+    context "node not found" do
+      it "does not raise error"
+    end
+  end
+
+  describe "#fetch_root" do
+    it "sets @root database node and returns true"
+
+    context "root already set" do
+      it "returns true"
+    end
+
+    context "node not found" do
+      it "returns false"
+    end
+  end
+
+  describe "#find_key" do
+    it "finds node corresponding to key in map"
+
+    context "key not found" do
+      it "returns nil"
+    end
+  end
+
+  describe "#fetch_node_from_db" do
+    it "retrieves key from nodestore"
+    it "creates corresponding node"
+  end
+
+  describe "#upper_bound" do
+    it "returns first item in tree with key > given key"
+  end
+
+  describe "#walk_towards_key" do
+    it "returns path stack of node traversal to key"
+  end
+
+  describe "#descend_throw" do
+    it "descends to parent branch"
+
+    context "could not descend to non-empty branch" do
+      it "raises error"
+    end
+  end
+
+  describe "#descend" do
+    it "retrieve cached child node at parent branch"
+
+    context "parent branch child node not set" do
+      it "fetches and returns node"
+
+      context "not not able to be retrieved" do
+        it "returns nil"
+      end
+
+      context "node is inconsistent" do
+        it "returns nil"
+      end
+
+      it "stores child in parent"
+    end
+  end
+
+  describe "#first_below" do
+    it "returns first leaf node at or below the specified node"
+  end
+
+  describe "#cdir_first" do
+    it "returns the first directory index in the node specified by index"
+  end
+
+  describe "#cdir_next" do
+    it "returns the next directory index in the node specified by index"
+  end
+end # describe XRBP::SHAMap

data/spec/xrbp/nodestore/sle/st_amount_arithmatic_spec.rb

@@ -0,0 +1,7 @@
+describe XRBP::NodeStore::STAmount do
+  it "is addable"
+  it "is subtactable"
+  it "is divisable"
+  it "is multiplicable"
+  it "is negatable"
+end # describe XRBP::NodeStore::STAmount

data/spec/xrbp/nodestore/sle/st_amount_comparison_spec.rb

@@ -0,0 +1,11 @@
+describe XRBP::NodeStore::STAmount do
+  it "is < other amount"
+
+  it "is > other amount"
+
+  it "is >= other amount"
+
+  it "is == other amount"
+
+  it "is <=> other amount"
+end # describe XRBP::NodeStore::STAmount

data/spec/xrbp/nodestore/sle/st_amount_conversion_spec.rb

@@ -0,0 +1,64 @@
+describe XRBP::NodeStore::STAmount do
+  it "is negatable"
+
+  it "is convertable to/from wire format" do
+    v = 1000000000000
+    s = described_class.new(:mantissa => v)
+    expect(described_class.from_wire(s.to_wire).to_h).to eq(s.to_h)
+
+    s = described_class.new(:mantissa => v,
+                               :issue => XRBP::NodeStore.xrp_issue)
+    expect(described_class.from_wire(s.to_wire).to_h).to eq(s.to_h)
+  end
+
+  it "can be parsed from string" do
+    s = "12345.6789"
+    expect(described_class.parse(s).iou_amount.to_f).to eq(s.to_f)
+
+    expect { described_class.parse("whatever") }.to raise_error("Number 'whatever' is not valid")
+  end
+
+  context "canonicalize" do
+    context "native amount" do
+      context "zero mantissa" do
+        it "zeros exponent"
+        it "is not negative"
+      end
+
+      it "zeros exponent"
+    end
+
+    context "zero mantissa" do
+      it "sets exponent to -100"
+      it "is not negative"
+    end
+
+    it "increases mantissa to >= MIN_VAL"
+    it "increases mantissa to <= MAX_VAL"
+
+    it "increases exponent to >= MIN_OFFSET"
+    it "descreases exponent to <= MAX_OFFSET"
+
+    context "offset cannot be set appropriately" do
+      it "raises value overflow"
+    end
+
+    context "manitssa out of bounds" do
+      it "raises error"
+    end
+
+    context "exponent out of bounds" do
+      it "raises error"
+    end
+
+    context "invalid mantissa / exponent combination" do
+      it "raises error"
+    end
+  end # describe #canoncialize
+
+  it "clears amount"
+
+  it "returns sn_value"
+  it "returns xrp_amount"
+  it "returns iou_amount"
+end # describe XRBP::NodeStore::STAmount