keoken 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 357cbf1ad803c7daee79a96d0b5abe0da874186305112c34cd3e1bd49420960e
+  data.tar.gz: 0dd555b839dcdc945dc8c8e601cf51918978fca90205242a1c8e7de46f1dace8
+SHA512:
+  metadata.gz: 733de94303f8ef40533231075bd0e8482b9851ad7fdce208012f36b778d6745d8f96aea1255ad7e34540261bcfa0965c2600eb77b6fe0372e0991562e0e414ec
+  data.tar.gz: b374b16d171f9cbc15a2fac64d9c8407a492485b003ae9f5069486c9fda0305293534b871da402975e0c887e238b869c9ec784fdb803fc5deae0d49c613a6d4e

data/.gitignore

@@ -0,0 +1 @@
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    keoken (0.0.1)
+      bitcoin-ruby (~> 0.0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    bitcoin-ruby (0.0.18)
+    byebug (10.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    hashdiff (0.3.2)
+    public_suffix (3.0.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  byebug (~> 10)
+  ffi (~> 1.9)
+  keoken!
+  rake (~> 12)
+  rspec (~> 3)
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.16.4

data/keoken.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keoken/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'keoken'
+  s.version       = Keoken::VERSION
+  s.date          = '2019-01-24'
+  s.summary       = 'Keoken protocol implemented in Ruby'
+  s.description   = 'Provides an interface to Keoken protocol'
+  s.authors       = ['Bitex']
+  s.email         = 'developers@bitex.la'
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage      = 'http://rubygems.org/gems/keoken'
+  s.license       = 'MIT'
+
+  s.add_dependency 'bitcoin-ruby', '~> 0.0.18'
+
+  s.add_development_dependency "bundler", "~> 1.11"
+  s.add_development_dependency "rake", "~> 12"
+  s.add_development_dependency "rspec", "~> 3"
+  s.add_development_dependency "webmock", "~> 2.3"
+  s.add_development_dependency "byebug", "~> 10"
+  s.add_development_dependency "ffi", "~> 1.9"
+end

data/lib/keoken/bitprim/config.yaml

@@ -0,0 +1,7 @@
+Bitprim:
+  node:
+    testnet:
+      url: https://tbch.blockdozer.com/insight-api/
+    mainnet:
+      url: https://bch.blockdozer.com/insight-api/
+

data/lib/keoken/bitprim/transaction.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require 'net/http'
+
+module Keoken
+  module Bitprim
+    class Transaction
+      attr_reader :raw
+
+      def initialize(raw)
+        @raw = raw
+      end
+
+      def send_tx
+        uri = URI("#{root_url}tx/send")
+        req = Net::HTTP::Post.new(uri)
+        req.set_form_data(rawtx: @raw)
+
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(req)
+        end
+
+        return res.value if res != Net::HTTPSuccess
+      end
+
+      private
+
+      def root_url
+        file = YAML.load_file('lib/keoken/bitprim/config.yaml')
+        if ENV['KEOKEN_NODE'] == 'PRODUCTION'
+          file['Bitprim']['node']['mainnet']['url']
+        else
+          file['Bitprim']['node']['testnet']['url']
+        end
+      end
+    end
+  end
+end

data/lib/keoken/errors/id_not_found.rb

@@ -0,0 +1,7 @@
+module Keoken
+  class IdNotFound < StandardError
+    def initialize(msg='Missing id')
+      super
+    end
+  end
+end

data/lib/keoken/errors/name_not_found.rb

@@ -0,0 +1,8 @@
+module Keoken
+  class NameNotFound < StandardError
+    def initialize(msg='Missing name')
+      super
+    end
+  end
+end
+

data/lib/keoken/extensions/bitcoin/script.rb

@@ -0,0 +1,5 @@
+class Bitcoin::Script
+  def self.to_custom_script(data=nil)
+    [data].pack("H*")
+  end
+end

data/lib/keoken/token.rb

@@ -0,0 +1,50 @@
+module Keoken
+  class Token
+    attr_accessor :hex, :name, :id
+
+    def initialize(options = {})
+      @name = options[:name]
+      @id = options[:id]
+    end
+
+    def create(amount)
+      raise Keoken::NameNotFound unless @name
+      data_script =
+        [Keoken::VERSION_NODE,
+        Keoken::TYPE_CREATE_ASSET,
+        name_to_hex(@name),
+        Keoken::PREFIX_BYTE_AMOUNT[0..(Keoken::AMOUNT_SIZE - amount.to_s.length - 1)] + amount.to_s].flatten.join
+      
+      data_length = data_script.htb.bytesize.to_s(16)
+
+      @hex = [Bitcoin::Script::OP_RETURN.to_s(16),
+              Keoken::PREFIX_SIZE,
+              Keoken::PREFIX,
+              data_length].join + data_script
+      self
+    end
+
+    def send_amount(amount)
+      raise Keoken::IdNotFound unless @id
+      data_script =
+       [Keoken::VERSION_NODE,
+        Keoken::TYPE_SEND_TOKEN,
+        Keoken::PREFIX_BYTE_ASSET_ID[0..(Keoken::ASSET_ID_SIZE - @id.to_s.length - 1)] + @id.to_s,
+        Keoken::PREFIX_BYTE_AMOUNT[0..(Keoken::AMOUNT_SIZE - amount.to_s.length - 1)] + amount.to_s].flatten.join
+
+      data_length = data_script.htb.bytesize.to_s(16)
+
+      @hex = [Bitcoin::Script::OP_RETURN.to_s(16),
+              Keoken::PREFIX_SIZE,
+              Keoken::PREFIX,
+              data_length].join + data_script
+      self
+    end
+
+    private
+    def name_to_hex(name)
+      asset_bytes = name.bytes.map{|n| n.to_s(16)}
+      asset_bytes + ['00']
+    end
+  end
+end

data/lib/keoken/transaction/token.rb

@@ -0,0 +1,60 @@
+module Keoken
+  module Transaction
+    class Token
+      attr_accessor :to_json, :raw
+      extend Bitcoin::Builder
+
+      def self.create(tx_id, position, input_script, input_amount, output_amount, key, script)
+        token = self.new
+        tx = build_tx do |t|
+          t.input do |i| 
+            i.prev_out(tx_id, position, input_script.htb, input_amount, 0)
+            i.signature_key(key)
+          end
+          t.output do |o|
+            o.value output_amount
+            o.script do |s|
+              s.recipient(key.addr)
+            end
+          end
+          t.output do |o|
+            o.value 0
+            o.to(script, :custom)
+          end
+        end
+        token.to_json = tx.to_json
+        token.raw = tx.to_payload.bth
+        token
+      end
+
+      def self.send_amount(tx_id, position, input_script, input_amount, output_amount, output_amount_to_addr2, key, script)
+        token = self.new
+        tx = build_tx do |t|
+          t.input do |i| 
+            i.prev_out(tx_id, position, script.htb, input_amount, 0)
+            i.signature_key(key)
+          end
+          t.output do |o|
+            o.value output_amount_to_addr2
+            o.script do |s|
+              s.recipient(key2.addr)
+            end
+          end
+          t.output do |o|
+            o.value output_amount
+            o.script do |s|
+              s.recipient(key.addr)
+            end
+          end
+          t.output do |o|
+            o.value 0
+            o.to(script, :custom)
+          end
+        end
+        token.to_json = tx.to_json
+        token.raw = tx.to_payload.bth
+        token
+      end
+    end
+  end
+end

data/lib/keoken/version.rb

@@ -0,0 +1,3 @@
+module Keoken
+  VERSION = "0.0.1"
+end

data/lib/keoken.rb

@@ -0,0 +1,20 @@
+require 'bitcoin'
+
+require 'keoken/extensions/bitcoin/script'
+require 'keoken/token'
+require 'keoken/transaction/token'
+require 'keoken/bitprim/transaction'
+require 'keoken/errors/id_not_found'
+require 'keoken/errors/name_not_found'
+
+module Keoken
+  PREFIX_SIZE = '04'
+  PREFIX = '00004b50'
+  VERSION_NODE = '0000'
+  TYPE_CREATE_ASSET = '0000'
+  TYPE_SEND_TOKEN = '0001'
+  PREFIX_BYTE_AMOUNT = '0000000000000000'
+  AMOUNT_SIZE = 16
+  PREFIX_BYTE_ASSET_ID = '00000000'
+  ASSET_ID_SIZE = 8
+end

data/spec/keoken_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Keoken do
+  it 'has a version number' do
+    expect(Keoken::VERSION).not_to be nil
+  end
+
+  it 'defines keoken constants' do
+    expect(Keoken::PREFIX_SIZE).not_to be nil
+    expect(Keoken::PREFIX).not_to be nil
+    expect(Keoken::VERSION_NODE).not_to be nil
+    expect(Keoken::TYPE_CREATE_ASSET).not_to be nil
+    expect(Keoken::TYPE_SEND_TOKEN).not_to be nil
+    expect(Keoken::PREFIX_BYTE_AMOUNT).not_to be nil
+    expect(Keoken::AMOUNT_SIZE).not_to be nil
+    expect(Keoken::PREFIX_BYTE_ASSET_ID).not_to be nil
+    expect(Keoken::ASSET_ID_SIZE).not_to be nil
+  end
+
+  it 'creates the test-keoken token' do
+    token = Keoken::Token.new(name: 'test-keoken')
+    token.create(1_000_000)
+    expect(token.hex).to(
+      eq('6a0400004b501800000000746573742d6b656f6b656e000000000001000000')
+    )
+  end
+
+  it 'raise an error when name is not provided' do
+    token = Keoken::Token.new
+    expect { token.create(1_000_000) }.to raise_error(Keoken::NameNotFound)
+  end
+
+  it 'raise an error when id is not provided' do
+    token = Keoken::Token.new
+    expect { token.send_amount(1_000_000) }.to raise_error(Keoken::IdNotFound)
+  end
+
+  it 'send 1_000_000 to token with 34 id' do
+    token = Keoken::Token.new(id: 34)
+    token.send_amount(1_000_000)
+    expect(token.hex).to(
+      eq('6a0400004b501000000001000000340000000001000000')
+    )
+  end
+
+  describe 'creates bitcoin transaction' do
+    before(:each) do
+      Bitcoin.network = :testnet3
+      token = Keoken::Token.new(name: 'test-keoken')
+      token.create(1_000_000)
+      tx_id = 'aa699dc5ddf598a50dc2cb2cb2729629cb9d2d865df38e4367d13f81ef55f96e'
+      input_script = '76a9147bb97684cc43e2f8ea0ed1d50dddce3ebf80063888ac'
+      position = 0
+      script = token.hex
+      input_amount = 5_0000_0000
+      output_amount = 4_9991_0000
+      key = Bitcoin::Key.from_base58("cShKfHoHVf6iKKZym18ip1MJFQFxJwbcLxW53MQikxdDsGd2oxBU")
+      @transaction_token = Keoken::Transaction::Token.create(tx_id, position, input_script, input_amount, output_amount, key, script)
+    end
+
+    it 'format to_json' do
+      json = JSON.parse(@transaction_token.to_json)
+      expect(json['out']).to(
+        eq(
+          [
+            {
+              "value" => "4.99910000",
+              "scriptPubKey" => "OP_DUP OP_HASH160 7bb97684cc43e2f8ea0ed1d50dddce3ebf800638 OP_EQUALVERIFY OP_CHECKSIG"
+            },
+            {
+              "value" => "0.00000000",
+              "scriptPubKey" => "OP_RETURN 00004b50 00000000746573742d6b656f6b656e000000000001000000"
+            }
+          ]
+        )
+      )
+    end
+
+    it 'raw transaction' do
+      raw = @transaction_token.raw
+      expect(raw).to start_with('01000000016ef955ef813fd167438ef35d862d9dcb299672b22ccbc20da598f5ddc59d69aa00000000')
+      expect(raw).to end_with('6a0400004b501800000000746573742d6b656f6b656e00000000000100000000000000')
+    end
+
+    it 'broadcast transaction' do
+      stub_request(:post, 'http://tbch.blockdozer.com:443/insight-api/tx/send')
+        .with(:body => {"rawtx"=> /01000000016ef955ef813fd167438ef35d862d9dcb/},
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Content-Type' => 'application/x-www-form-urlencoded',
+              'Host' => 'tbch.blockdozer.com',
+              'User-Agent' => 'Ruby'
+            })
+        .to_return(status: 200, body: '', headers: {})
+      transaction = Keoken::Bitprim::Transaction.new(@transaction_token.raw)
+      expect(transaction.send_tx).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'keoken'
+require 'webmock/rspec'
+require 'byebug'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: keoken
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bitex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-24 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.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.18
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Provides an interface to Keoken protocol
+email: developers@bitex.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- keoken.gemspec
+- lib/keoken.rb
+- lib/keoken/bitprim/config.yaml
+- lib/keoken/bitprim/transaction.rb
+- lib/keoken/errors/id_not_found.rb
+- lib/keoken/errors/name_not_found.rb
+- lib/keoken/extensions/bitcoin/script.rb
+- lib/keoken/token.rb
+- lib/keoken/transaction/token.rb
+- lib/keoken/version.rb
+- spec/keoken_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/keoken
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Keoken protocol implemented in Ruby
+test_files: []