counterparty_ruby 0.9.0

data/lib/counterparty_ruby.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'rest_client'
+require 'open-uri'
+require 'bitcoin'
+
+require 'counterparty/raw_tx'
+require 'counterparty/version'
+require 'counterparty/resource'
+require 'counterparty/resources'
+require 'counterparty/connection'
+
+# The main module, under which all classes in the library are defined.
+module Counterparty
+  # One XCP, in units of Satoshi
+  ONE_XCP = 100_000_000 
+  
+  # One BTC, in units of Satoshi
+  ONE_BTC = 100_000_000 
+
+  # This exception is typically raised by errors related to the params and/or
+  # request format
+  class JsonResponseError < StandardError; end
+
+  # This exception comes from an error relating to a proper request, but an 
+  # inability to complete the request via the counterpartyd api
+  class ResponseError < StandardError
+    attr_reader :data_type
+    attr_reader :data_args
+    attr_reader :data_message
+    attr_reader :code
+    attr_reader :message_class
+
+    def initialize(json)
+      @message_class, @code = json['message'], json['code']
+
+      json['data'].each_pair do |(k,v)|
+        instance_variable_set '@data_%s' % k, v
+      end if json.has_key? 'data'
+
+      super
+    end
+
+    def message
+      '%s: %s' % [@message_class,@data_message]
+    end
+  end
+  
+  class << self
+    # Sets/Gets the default connection object
+    attr_writer :connection
+
+    # Returns the current default connection object, or creates a new test-mode
+    # connection, if none has been defined
+    def connection
+      @connection || Connection.new
+    end
+
+    # Establishes the default connection for new objects as being the default 
+    # counterparty production mode port/user/ip
+    def production!
+      @connection = Connection.new 4000
+    end
+
+    # Establishes the default connection for new objects as being the default 
+    # counterparty test mode port/user/ip
+    def test!
+      @connection = Connection.new
+    end
+  end
+end

data/spec/config.yml

@@ -0,0 +1,3 @@
+source_address: msCXwsPVbv1Q1pc5AjXd5TdVwy3a1fSYB2
+source_privkey: cP7ufwcbZujaa1qkKthLbVZUaP88RS5r9awyXerJE5rAEMTRVmzc
+spend_destination: msj42CCGruhRsFrGATiUuh25dtxYtnpbTx

data/spec/connection_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Counterparty::Connection do
+  describe "#new" do
+    # It should default to the test network parameters
+    subject{Counterparty::Connection.new}
+
+    its(:host){ should eq('localhost') }
+    its(:port){ should eq(14000) }
+    its(:username){ should eq('rpc') }
+    its(:password){ should eq('1234') }
+    its(:api_url){ should eq('http://rpc:1234@localhost:14000/api/') }
+  end
+end

data/spec/exceptions_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Counterparty::ResponseError do
+  include_context 'globals'
+
+  let(:bad_issuance) do
+    Counterparty::Issuance.new source: source_address,
+      asset: 'THISASSETNAMEISFARTOOLONGANDINVALID', 
+      quantity: 1000, description: "my asset is uncool",
+      allow_unconfirmed_inputs: true
+  end
+
+  it "should fail on to_raw_tx" do
+    expect{ bad_issuance.to_raw_tx }.to raise_error Counterparty::ResponseError
+  end
+
+  it "should fail on save!" do
+    expect{ bad_issuance.save! }.to raise_error Counterparty::ResponseError
+  end
+
+  subject do
+    begin
+      bad_issuance.save!
+    rescue => error
+      error
+    end
+  end
+
+  its(:data_type) { should eq('AssetNameError') }
+  its(:data_args) { should eq(["long asset names must be numeric"]) }
+  its(:data_message) { should eq("long asset names must be numeric") }
+  its(:code) { should eq(-32000) }
+  its(:message) { should eq("Server error: long asset names must be numeric") }
+end
+
+describe Counterparty::JsonResponseError do
+  pending
+end

data/spec/rawtx_decode_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe RawTx do
+  describe ".double_sha256" do
+    # http://bitcoin.stackexchange.com/questions/2177/how-to-calculate-a-hash-of-a-tx
+    genesis_block = '01000000010000000000000000000000000000000000000000000'+
+      '000000000000000000000FFFFFFFF4D04FFFF001D0104455468652054696D657320'+
+      '30332F4A616E2F32303039204368616E63656C6C6F72206F6E206272696E6B206F6'+
+      '6207365636F6E64206261696C6F757420666F722062616E6B73FFFFFFFF0100F205'+
+      '2A01000000434104678AFDB0FE5548271967F1A67130B7105CD6A828E03909A6796'+
+      '2E0EA1F61DEB649F6BC3F4CEF38C4F35504E51EC112DE5C384DF7BA0B8D578A4C70'+
+      '2B6BF11D5FAC00000000'
+    genesis_double_sha = '4A5E1E4BAAB89F3A32518A88C31BC87F618F76673E2CC77AB2127B7AFDEDA33B'
+
+    pending
+  end
+
+  describe ".nibbles_to_ui" do
+    it "should fail on byte arrays larger than 32 bits" do
+      expect{ RawTx.nibbles_to_ui([1,0,0,0,0]) }.to raise_error(ArgumentError)
+    end
+
+    # Remember that the least significant byte is first here:
+    it ("should convert 0x10 to 1") { expect(RawTx.nibbles_to_ui([1,0])).to eq(1) }
+    it ("should convert 0x01 to 16") { expect(RawTx.nibbles_to_ui([0,1])).to eq(16) }
+    it ("should convert 0xf to 15") { expect(RawTx.nibbles_to_ui([0xf])).to eq(15) }
+    it ("should convert 0x11 to 17") { expect(RawTx.nibbles_to_ui([1,1])).to eq(17) }
+    it ("should convert 0xf1 to 31") { expect(RawTx.nibbles_to_ui([0xf,1])).to eq(31) }
+    it ("should convert 0xff to 255") { expect(RawTx.nibbles_to_ui([0xf,0xf])).to eq(255) }
+  end
+  
+  describe ".bytes_to_base64_s" do
+    it "should convert 0x14FB9C03D97E to FPucA91+" do
+      bytes = [0x14, 0xFB, 0x9C, 0x03, 0xD9, 0x7E]
+      expect(RawTx.bytes_to_base64_s bytes).to eq("FPucA9l+")
+    end
+
+    it "should convert 0x14FB9C03D9 to FPucA9k=" do
+      bytes = [0x14, 0xFB, 0x9C, 0x03, 0xD9]
+      expect(RawTx.bytes_to_base64_s bytes).to eq("FPucA9k=")
+    end
+
+    it "should convert 0x14FB9C03 to FPucAw==" do
+      bytes = [0x14, 0xFB, 0x9C, 0x03]
+      expect(RawTx.bytes_to_base64_s bytes).to eq("FPucAw==")
+    end
+  end
+
+  describe "#to_hash" do
+    # NOTE that these spec values were obtained via:
+    # bitcoind -testnet decoderawtransaction [subject]
+    subject{ RawTx.new(
+      "0100000001ec549bdf53cfb319201d672fc0933500e48505724010dad615a9344b99" +
+      "1721cc010000001976a9148025b288cb325d88bcd7ef5d1ab1f8827778d5ee88acff" +
+      "ffffff03781e0000000000006951210286cdf9ec8742c452bd13299771fe40130124" +
+      "038e2198ffc402204c48cc2d32da21033de0df1555e81783f42e00458d0b542ff293" +
+      "d9d04fbc7704650448ee07728a8a210286b1e4f15de57fd34bde19cf64ad9302e454" +
+      "c4c377677581a951579a124b86e753ae781e00000000000069512102a2cdf9ec8742" +
+      "c452bd2214fe01c9f33b0d0066ed0efb90aa715400038c1c621921034f89bc707587" +
+      "71a393416c21a12b651db3def9851bff574904762b86365caaea210286b1e4f15de5" +
+      "7fd34bde19cf64ad9302e454c4c377677581a951579a124b86e753aec0ba770d0000" +
+      "00001976a9148025b288cb325d88bcd7ef5d1ab1f8827778d5ee88ac00000000").to_hash }
+
+    its(['ver']){should eq(1)}
+    its(['lock_time']){should eq(0)}
+    its(['size']){should eq(338)}
+    its(['vin_sz']){should eq(1)}
+    its(['vout_sz']){should eq(3)}
+
+    its(['vin']) do 
+      # If we're testing to base64, the hash would look like:
+      # RawTx.bytes_to_base64_s(out_hash.scan(/../).collect(&:hex))
+      should eq([
+          { "txid" => "cc2117994b34a915d6da1040720585e4003593c02f671d2019b3cf53df9b54ec",
+            "vout" => 1,
+            "scriptSig" => {
+              "hex" => "76a9148025b288cb325d88bcd7ef5d1ab1f8827778d5ee88ac",
+              "asm" => %w(OP_DUP OP_HASH160 
+                8025b288cb325d88bcd7ef5d1ab1f8827778d5ee OP_EQUALVERIFY 
+                OP_CHECKSIG).join(' ')
+            }, "sequence" => 4294967295 }])
+    end
+
+    its(['vout']) do 
+      should eq( [ 
+        { "value" => 0.00007800, "n" => 0,
+          "scriptPubKey" => {
+            "hex" => "51210286cdf9ec8742c452bd13299771fe40130124038e2198ffc40"+
+              "2204c48cc2d32da21033de0df1555e81783f42e00458d0b542ff293d9d04f"+
+              "bc7704650448ee07728a8a210286b1e4f15de57fd34bde19cf64ad9302e45"+
+              "4c4c377677581a951579a124b86e753ae",
+            "asm" => "1 0286cdf9ec8742c452bd13299771fe40130124038e2198ffc402204c48cc2d32da 033de0df1555e81783f42e00458d0b542ff293d9d04fbc7704650448ee07728a8a 0286b1e4f15de57fd34bde19cf64ad9302e454c4c377677581a951579a124b86e7 3 OP_CHECKMULTISIG" }
+        },
+        { "value" => 0.00007800, "n" => 1,
+          "scriptPubKey" => {
+            "hex" => "512102a2cdf9ec8742c452bd2214fe01c9f33b0d0066ed0efb90aa71"+
+              "5400038c1c621921034f89bc70758771a393416c21a12b651db3def9851bf"+
+              "f574904762b86365caaea210286b1e4f15de57fd34bde19cf64ad9302e454"+
+              "c4c377677581a951579a124b86e753ae",
+            "asm" => "1 02a2cdf9ec8742c452bd2214fe01c9f33b0d0066ed0efb90aa715400038c1c6219 034f89bc70758771a393416c21a12b651db3def9851bff574904762b86365caaea 0286b1e4f15de57fd34bde19cf64ad9302e454c4c377677581a951579a124b86e7 3 OP_CHECKMULTISIG" }
+        },
+        { "value" => 2.25950400, "n" => 2,
+          "scriptPubKey" => {
+            "hex" => "76a9148025b288cb325d88bcd7ef5d1ab1f8827778d5ee88ac",
+            "asm" => "OP_DUP OP_HASH160 8025b288cb325d88bcd7ef5d1ab1f8827778d5ee OP_EQUALVERIFY OP_CHECKSIG" } } ] )
+    end
+  end
+ 
+  describe("#to_hash coinbase") do
+
+    subject{ RawTx.new(
+      "01000000010000000000000000000000000000000000000000000000000000000000" + 
+      "000000ffffffff53038349040d00456c69676975730052d8f72ffabe6d6dd991088d" + 
+      "ecd13e658bbecc0b2b4c87306f637828917838c02a5d95d0e1bdff9b040000000000" +
+      "0000002f73733331312f00906b570400000000e4050000ffffffff01bf2087950000" +
+      "00001976a9145399c3093d31e4b0af4be1215d59b857b861ad5d88ac00000000").to_hash }
+
+    pending
+  end 
+
+end
+

data/spec/resource_create_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+# NOTE: Most of these examples are from: 
+# https://github.com/CounterpartyXCP/counterpartyd/blob/master/docs/API.rst#id8
+# The tests have to run in the specified order, as we populate our test account
+# before running test operations
+describe Counterparty do
+  include_context 'globals'
+
+  before(:all) { Counterparty.test! }
+
+  # TODO: deprecate?
+  #it "Ensure test account has BTC" do
+    #expect(bitcoin.getreceivedbyaddress(source_address)).to be > 0
+  #end
+
+  describe "Ensure test account has XCP" do
+    subject do
+      Counterparty::Balance.find( filters: 
+        { field: 'address', op: '==', value: source_address} 
+      ).find{|b| b.asset == 'XCP' }
+    end
+
+    its(:quantity){ should be > Counterparty::ONE_XCP }
+  end
+
+  # Send 1 XCP (specified in satoshis) from one address to another (you must have 
+  # the sending address in your bitcoind wallet and it will be broadcast as a 
+  # multisig transaction
+  describe "#do_send" do
+    subject do 
+      Counterparty::Send.new source: source_address, destination: destination_address, 
+        asset: "XCP", quantity: Counterparty::ONE_XCP, 
+        allow_unconfirmed_inputs: true
+    end
+
+    its(:to_raw_tx) { should_not be_empty }
+    its(:save!) { should_not be_empty }
+  end
+
+  describe "#do_issuance" do
+    subject do
+      Counterparty::Issuance.new source: source_address, asset: unique_asset_name, 
+        quantity: 1000, description: "my asset is cool", divisible: true, 
+        allow_unconfirmed_inputs: true
+    end
+
+    its(:to_raw_tx) { should_not be_empty }
+    its(:save!) { should_not be_empty }
+  end
+
+  describe "signed #create_broadcast" do
+    subject do
+      # We want the save(private_key) syntax here
+      Counterparty::Broadcast.new source: source_address, fee_fraction: 0.05,
+        text: "Price of gold, 12AM UTC March1. 1=inc 2=dec/const", value: 2.0,
+        timestamp: 1418926641, 
+        allow_unconfirmed_inputs: true
+    end
+
+    its(:to_raw_tx) { should_not be_empty }
+
+    it "should persist using a provided key" do
+      # TODO: Make this work
+      expect(subject.save!(source_privkey)).to_not be_empty
+    end
+  end
+
+end

data/spec/resource_read_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+# NOTE: Most of these examples are from: 
+# https://github.com/CounterpartyXCP/counterpartyd/blob/master/docs/API.rst#id8
+describe Counterparty do
+  include_context 'globals'
+
+  before(:all) { Counterparty.production! }
+ 
+  # Get all burns between blocks 280537 and 280539 where greater than .2 BTC was 
+  # burned, sorting by tx_hash (ascending order) With this (and the rest of the 
+  # examples below) we use positional arguments, instead of keyword-based arguments
+  describe "#get_burns" do
+    burn_params = {
+        order_by: 'tx_hash', 
+        order_dir: 'asc', 
+        start_block: 280537, 
+        end_block: 280539 }
+
+    subject{ Counterparty::Burn.find burn_params }
+
+    it("should equal get_burns") do
+      expect(subject).to eq(Counterparty.connection.get_burns(burn_params))
+    end
+
+    its('length'){ should eq(10) }
+    its('first') do
+      should eq(Counterparty::Burn.new( 
+        tx_index: 1096, 
+        source: '1ADpYypUcnbezuuYpCyRCY7G4KD6a9YXiF', 
+        block_index: 280537, 
+        earned: 129754545455, 
+        status: "valid",
+        burned: 100000000, 
+        tx_hash: '6e905ec73870d6c6cdc8f4e64767ec41f74c8f07a24cc7c54811134f5b6aa6a7' 
+        ) )
+    end
+  end
+  
+  # Fetch all balances for all assets for both of two addresses, using keyword-
+  # based arguments
+  describe "#get_balances" do
+    balance_params = { filters: { 
+      field: 'address', op: '==', value: "14qqz8xpzzEtj6zLs3M1iASP7T4mj687yq" } }
+
+    subject{ Counterparty::Balance.find balance_params }
+
+    it("should equal get_balances") do
+      expect(subject).to eq(Counterparty.connection.get_balances(balance_params))
+    end
+
+    its('length'){ should eq(1) }
+    its('first') do
+      should eq(Counterparty::Balance.new(
+        quantity: 0, 
+        asset: "XCP", 
+        address: "14qqz8xpzzEtj6zLs3M1iASP7T4mj687yq" ) )
+    end
+  end
+
+  # Fetch all debits for > 2 XCP between blocks 280537 and 280539, sorting the 
+  # results by quantity (descending order)
+  describe "#get_debits" do
+    debit_params = {
+      filters: [
+          {field: 'asset', op: '==', value: "XCP"},
+          {field: 'quantity', op: '>', value: 200000000} 
+          ],
+      filterop: 'AND',
+      order_by: 'quantity',
+      order_dir: 'desc'}
+
+    subject{ Counterparty::Debit.find debit_params }
+
+    it("should equal get_debits") do
+      expect(subject).to eq(Counterparty.connection.get_debits(debit_params))
+    end
+
+    its('length'){ should eq(1000) }
+    its('first') do
+      should eq(Counterparty::Debit.new(
+        block_index: 318845,
+        asset: "XCP",
+        address: "1FxhdSid1TUfzfTyveMcsUhF3ePjRK6qqa",
+        action: "send",
+        event: "64c26f4dc12fbbdbead62962a9428d4a6b17a44c061d202ff525e2f513cd34e8",
+        quantity: 6184957374430
+      ) )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$:<< File.join(File.dirname(__FILE__), '..','lib')
+
+require 'yaml'
+require 'rspec/its'
+require 'counterparty_ruby'
+
+shared_context 'globals' do
+  let(:config) do
+    YAML.load File.open([File.dirname(__FILE__),'config.yml'].join('/')).read
+  end
+
+  let(:source_address) { config['source_address'] }
+  let(:source_privkey) { config['source_privkey'] }
+  let(:destination_address) { config['spend_destination'] }
+
+  # Since asset names have to be unique, we try our best to create a unique
+  # one here. This asset is composed of the timestamp, plus the machine
+  # name we're running on. Be advised this might be a small privacy breach 
+  # forsensitive operations.
+  # There might be some collisions here due to my not handling fixed-width
+  # integers greater than 26. I don't think I care about that right now
+  let!(:unique_asset_name) do
+    base26_time = Time.now.strftime('%y %m %d %H %M %S').split(' ').collect{|c| c.to_i.to_s(26)}
+    alpha_encode = base26_time.join.tr((('0'..'9').to_a+('a'..'q').to_a).join, ('A'..'Z').to_a.join)
+
+    [alpha_encode,`hostname`.upcase.tr('^A-Z','')].join[0...12]
+  end
+end
+

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: counterparty_ruby
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris DeRose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bitcoin-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is designed to abstract communications with the counterpartyd
+  api server in an ActiveRecord-esque object model
+email:
+- chris@chrisderose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- counterparty_ruby.gemspec
+- lib/counterparty/connection.rb
+- lib/counterparty/raw_tx.rb
+- lib/counterparty/resource.rb
+- lib/counterparty/resources.rb
+- lib/counterparty/version.rb
+- lib/counterparty_ruby.rb
+- spec/config.yml
+- spec/connection_spec.rb
+- spec/exceptions_spec.rb
+- spec/rawtx_decode_spec.rb
+- spec/resource_create_spec.rb
+- spec/resource_read_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brighton36/counterparty_ruby
+licenses:
+- LGPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An ActiveRecord-esque abstraction of the Counterparty API
+test_files:
+- spec/config.yml
+- spec/connection_spec.rb
+- spec/exceptions_spec.rb
+- spec/rawtx_decode_spec.rb
+- spec/resource_create_spec.rb
+- spec/resource_read_spec.rb
+- spec/spec_helper.rb