factom-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c6d1b2e3ca4aecb01e8a6a24cf30f7bfe4c647b
+  data.tar.gz: f06336a6677f61bd94941b0739f872cfbda54dc9
+SHA512:
+  metadata.gz: 3978a3a0c594a36396f57c3f94d318b4c49b85b8e66ec4c2b63b0e23228445f861cb76a539e2e139703bbb1bb3a45b9aa4ce3d7c4bf61f17e775551d0ba261f8
+  data.tar.gz: 52ca7b596e9c543f66faa0e4c0152635e38b36d4770f2d24fd487d606c056cbbb6d9dec5c3123694d10e2df47a45996b778f63a893a7d93d8fcf1fa81a5a928c

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2012, Jan Xie <jan.h.xie@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of Jan Xie nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,75 @@
+# Ruby Client for Factom
+
+A ruby client who talks to `factomd` in [Factom](http://factom.org) project.
+
+## Features
+
+* Encode/decode messages for you
+* Independent, work without `fctwallet` and `factom-cli`
+* No account management, use `factom-cli` for that purpose
+
+## Install
+
+```
+gem i factom-ruby
+```
+
+or
+
+Add it to your Gemfile:
+
+```
+gem 'factom-ruby'
+```
+
+## Usage
+
+```ruby
+require 'factom-ruby'
+
+ec_private_key = '0000000000000000000000000000000000000000000000000000000000000000'
+f = Factom::Client.new('http://factomd.node.ip:8088', ec_private_key)
+
+#################
+# get some info #
+#################
+
+p f.properties
+p f.fee
+
+################
+# get balances #
+################
+
+fa_address = 'FAblahblah...' # Factoid address
+fa_pubkey = f.address_to_pubkey fa_address
+p f.fa_balance_in_decimal(fa_pubkey)
+
+f.ec_address # EntryCredit address, calculated automatically from ec_private_key
+p f.ec_balance_in_decimal # default to balance on f.ec_address
+
+###########################################################################
+# create a new chain, remember to choose a unique chain names combination #
+###########################################################################
+
+resp = f.commit_chain %w(three body problem), "the world belongs to ???"
+puts "resp code: #{resp.code} body: #{resp.body}"
+resp = f.reveal_chain %w(three body problem), "the world belongs to ???"
+puts "resp code: #{resp.code} body: #{resp.body}"
+
+######################
+# submit a new entry #
+######################
+
+resp = f.commit_entry(some_chain_id, %w(chapter1), "once upon a time ...")
+puts "resp code: #{resp.code} body: #{resp.body}"
+resp = f.reveal_entry(some_chain_id, %w(chapter1), "once upon a time ...")
+puts "resp code: #{resp.code} body: #{resp.body}"
+```
+
+Check [examples](examples/) directory for more examples.
+
+## License
+
+[MIT License](LICENSE)
+

data/lib/factom-ruby.rb

@@ -0,0 +1 @@
+require_relative 'factom-ruby/client'

data/lib/factom-ruby/client.rb

@@ -0,0 +1,275 @@
+require 'bigdecimal'
+require 'bitcoin'
+require 'digest'
+require 'json'
+require 'rbnacl'
+require 'rest-client'
+
+module Factom
+  module APIv1
+    GetBalanceFailed = "Failed to get balance!"
+
+    VERSION = '00'.freeze
+
+    DENOMINATION_FACTOID = 100000000
+    DENOMINATION_ENTRY_CREDIT = 1
+
+    def height
+      json = get "/v1/directory-block-height/"
+      json['Height']
+    end
+
+    def head
+      json = get "/v1/directory-block-head/"
+      json['KeyMR']
+    end
+
+    def block(keymr)
+      get "/v1/directory-block-by-keymr/#{keymr}"
+    end
+
+    def chain_head(id)
+      json = get "/v1/chain-head/#{id}"
+      json['ChainHead']
+    end
+
+    def entry_block(keymr)
+      get "/v1/entry-block-by-keymr/#{keymr}"
+    end
+
+    def raw_data(hash)
+      get "/v1/get-raw-data/#{hash}"
+    end
+
+    def entry(hash)
+      decode_entry get "/v1/entry-by-hash/#{hash}"
+    end
+
+    def fee
+      json = get "/v1/factoid-get-fee/"
+      json['Fee']
+    end
+
+    def properties
+      get "/v1/properties/"
+    end
+
+    def fa_balance(pubkey)
+      json = get "/v1/factoid-balance/#{pubkey}"
+      raise GetBalanceFailed unless json['Success']
+      json['Response']
+    end
+
+    def fa_balance_in_decimal(pubkey)
+      BigDecimal.new(fa_balance(pubkey)) / DENOMINATION_FACTOID
+    end
+
+    def ec_balance(pubkey=ec_public_key)
+      json = get "/v1/entry-credit-balance/#{pubkey}"
+      raise GetBalanceFailed unless json['Success']
+      json['Response']
+    end
+
+    def ec_balance_in_decimal(pubkey=ec_public_key)
+      BigDecimal.new(ec_balance(pubkey)) / DENOMINATION_ENTRY_CREDIT
+    end
+
+    # Params:
+    # chain_names - chain name combination, must be unique globally. It's
+    #               first entry's external ids actually.
+    # content     - content of first entry
+    def commit_chain(chain_names, content)
+      params = { 'CommitChainMsg' => get_chain_commit(chain_names, content) }
+      raw_post "/v1/commit-chain/", params.to_json, content_type: :json
+    end
+
+    def reveal_chain(chain_names, content)
+      chain_id = get_chain_id chain_names
+      ext_ids  = chain_names
+
+      params = { 'Entry' => build_entry(chain_id, ext_ids, content) }
+      raw_post "/v1/reveal-chain/", params.to_json, content_type: :json
+    end
+
+    def commit_entry(chain_id, ext_ids, content)
+      params = { 'CommitEntryMsg' => get_entry_commit(chain_id, ext_ids, content) }
+      # TODO: will factom make response return json, for a better world?
+      raw_post "/v1/commit-entry/", params.to_json, content_type: :json
+    end
+
+    def reveal_entry(chain_id, ext_ids, content)
+      params = { 'Entry' => build_entry(chain_id, ext_ids, content) }
+      # TODO: the same, replace raw_post with post
+      raw_post "/v1/reveal-entry/", params.to_json, content_type: :json
+    end
+
+    private
+
+    def get_chain_commit(chain_names, content)
+      timestamp = (Time.now.to_f*1000).floor
+      ts = [ timestamp ].pack('Q>').unpack('H*').first
+
+      chain_id = get_chain_id chain_names
+      chain_id_hash = get_chain_id_hash chain_id
+
+      first_entry = build_entry chain_id, chain_names, content
+      first_entry_hash = get_entry_hash first_entry
+
+      weld = get_weld chain_id, first_entry_hash
+      fee = [ calculate_fee(first_entry)+10 ].pack('C').unpack('H*').first
+
+      sign "#{VERSION}#{ts[4..-1]}#{chain_id_hash}#{weld}#{first_entry_hash}#{fee}"
+    end
+
+    def get_chain_id_hash(chain_id)
+      sha256d [chain_id].pack("H*")
+    end
+
+    def get_chain_id(chain_names)
+      pre_id = chain_names.map {|name| Digest::SHA256.digest(name) }.join
+      Digest::SHA256.hexdigest(pre_id)
+    end
+
+    def get_weld(chain_id, entry_hash)
+      sha256d [entry_hash+chain_id].pack("H*")
+    end
+
+    def get_entry_commit(chain_id, ext_ids, content)
+      timestamp = (Time.now.to_f*1000).floor
+      ts = [ timestamp ].pack('Q>').unpack('H*').first
+
+      entry = build_entry(chain_id, ext_ids, content)
+      entry_hash = get_entry_hash entry
+
+      fee = [ calculate_fee(entry) ].pack('C').unpack('H*').first
+
+      sign "#{VERSION}#{ts[4..-1]}#{entry_hash}#{fee}"
+    end
+
+    def get_entry_hash(entry)
+      sha512 = Digest::SHA512.hexdigest([entry].pack('H*')) + entry
+      Digest::SHA256.hexdigest [sha512].pack('H*')
+    end
+
+    def build_entry(chain_id, ext_ids, content)
+      len = 0
+      ext_ids_hex = []
+      content_hex = content.unpack('H*').first
+
+      ext_ids.each do |id|
+        len += id.size + 2
+        ext_ids_hex.push uint16_to_hex(id.size)
+        ext_ids_hex.push id.unpack('H*').first
+      end
+
+      "#{VERSION}#{chain_id}#{uint16_to_hex(len)}#{ext_ids_hex.join}#{content_hex}"
+    end
+
+    def decode_entry(json)
+      json['ExtIDs'] = json['ExtIDs'].map {|bin| [bin].pack('H*') }
+      json['Content'] = [ json['Content'] ].pack('H*')
+      json
+    end
+
+    def calculate_fee(entry)
+      fee = entry.size / 2 # count of entry bytes
+      fee -= 35 # header doesn't count
+      fee = (fee+1023)/1024 # round up and divide, rate = 1 EC/KiB
+
+      # fee only occupy 1 byte in commit message
+      # but the hard limit is 10kB actually, much less than 255
+      raise "entry is too large!" if fee > 255
+
+      fee
+    end
+
+    def uint16_to_hex(i)
+      [i].pack('n').unpack('H*').first
+    end
+
+  end
+
+  class Client
+    attr :endpoint
+
+    PREFIX_FA = 'FA'.freeze
+    PREFIX_EC = 'EC'.freeze
+    ADDRESS_PREFIX = {
+      PREFIX_FA => '5fb1',
+      PREFIX_EC => '592a'
+    }.freeze
+
+    def initialize(endpoint, ec_private_key, version='v1')
+      @endpoint = endpoint.gsub(/\/\z/, '')
+      @ec_private_key = ec_private_key =~ /\A#{PREFIX_EC}/ ? address_to_pubkey(ec_private_key) : ec_private_key
+      self.instance_eval { extend ::Factom.const_get("API#{version}", false) }
+    end
+
+    def raw_get(path, params={}, options={})
+      uri = "#{endpoint}#{path}"
+      options = {accept: :json}.merge(options)
+      options[:params] = params
+
+      RestClient.get uri, options
+    end
+
+    def get(path, params={}, options={})
+      JSON.parse raw_get(path, params, options)
+    end
+
+    def raw_post(path, params={}, options={})
+      uri = "#{endpoint}#{path}"
+      options = {accept: :json}.merge(options)
+
+      RestClient.post uri, params, options
+    end
+
+    def ec_public_key
+      @ec_public_key ||= signing_key.verify_key.to_s.unpack('H*').first
+    end
+
+    def ec_address
+      @ec_address ||= pubkey_to_address ADDRESS_PREFIX[PREFIX_EC], ec_public_key
+    end
+
+    # to pubkey in hex, 32 bytes
+    def address_to_pubkey(addr)
+      return unless addr.size == 52
+
+      prefix = ADDRESS_PREFIX[addr[0,2]]
+      return unless prefix
+
+      v = Bitcoin.decode_base58(addr)
+      return if v[0,4] != prefix
+
+      bytes = [v[0, 68]].pack('H*')
+      return if v[68, 8] != sha256d(bytes)[0, 8]
+
+      v[4, 64]
+    end
+
+    def pubkey_to_address(prefix, pubkey)
+      return unless pubkey.size == 64 # 32 bytes in hex
+
+      addr = "#{prefix}#{pubkey}"
+      bytes = [addr].pack('H*')
+
+      Bitcoin.encode_base58 "#{addr}#{sha256d(bytes)[0,8]}"
+    end
+
+    def sha256d(bytes)
+      Digest::SHA256.hexdigest(Digest::SHA256.digest(bytes))
+    end
+
+    # ed25519 private key
+    def signing_key
+      @signing_key ||= RbNaCl::SigningKey.new([@ec_private_key].pack('H*'))
+    end
+
+    def sign(message)
+      sig = signing_key.sign([message].pack('H*')).unpack('H*').first
+      "#{message}#{ec_public_key}#{sig}"
+    end
+
+  end
+end

data/lib/factom-ruby/version.rb

@@ -0,0 +1,3 @@
+module Factom
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: factom-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jan Xie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitcoin-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Ruby client consumes Factom (factom.org) API.
+email:
+- jan.h.xie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/factom-ruby.rb
+- lib/factom-ruby/client.rb
+- lib/factom-ruby/version.rb
+homepage: https://github.com/janx/factom-ruby
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client consumes Factom (factom.org) API.
+test_files: []