keoken 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 357cbf1ad803c7daee79a96d0b5abe0da874186305112c34cd3e1bd49420960e
-  data.tar.gz: 0dd555b839dcdc945dc8c8e601cf51918978fca90205242a1c8e7de46f1dace8
+  metadata.gz: 782c4d244e16d0450b38609eef276677ab18611484c9d14730e58b86166cdbe5
+  data.tar.gz: aff0fe1e961ad359bc7bc511887def5b64e1730c6d09ac5832d3d99554fca9c7
 SHA512:
-  metadata.gz: 733de94303f8ef40533231075bd0e8482b9851ad7fdce208012f36b778d6745d8f96aea1255ad7e34540261bcfa0965c2600eb77b6fe0372e0991562e0e414ec
-  data.tar.gz: b374b16d171f9cbc15a2fac64d9c8407a492485b003ae9f5069486c9fda0305293534b871da402975e0c887e238b869c9ec784fdb803fc5deae0d49c613a6d4e
+  metadata.gz: ac6cfd0f0f6dcc6c996bee549872a2e45401d4556e24ee9fe82df75da3aafeceaab0fdd50867e6f63475b9262c2f89fac4c40a22ff9aa6117f0572b99f3eb1d7
+  data.tar.gz: 89859960e7cf722382d71117e93e3ed1a20ebfa6ce5a9abc9d32e8f2292a767e4a6ce5e3de8d0ce6d159560969b5bb9a1fbe1568bfcfc82de5493b6253d1cab2

data/README.md

@@ -0,0 +1,95 @@
+# Keoken
+
+Creates BCH tokens and send money between them for the Keoken protocol.
+
+https://www.keoken.io/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keoken'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keoken
+
+## Usage
+
+### Create token and send it to the blockchain
+
+```ruby      
+# It uses bitcoin-ruby, but you can use Trezor or Electrum, the most important command is the script,
+# which you can obtain with token.hex, 
+# then you can send it as an output with a scriptPubKey and a value of 0.
+# In order to crate a token you need two outputs,
+# the change address with an amount less than original (for fees) 
+# and the other one for the script. To send money you need three outputs, 
+# the change address, the address who owns the recipient token and the script.
+
+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)
+transaction = Keoken::Bitprim::Transaction.new(@transaction_token.raw)
+transaction.send_tx
+```
+
+### Send token money and send transaction to the blockchain
+
+```ruby      
+Bitcoin.network = :testnet3
+transaction = Keoken::Bitprim::Transaction.new
+data = transaction.get_assets_by_address('mro9aqn4xCzXVS7jRFFuzT2ERKonvPdSDAs')
+token = Keoken::Token.new(id: data[0]['asset_id'])
+token.send_amount(500_000)
+tx_id = 'aa699dc5ddf598a50dc2cb2cb2729629cb9d2d865df38e4367d13f81ef55f96e'
+input_script = '76a9147bb97684cc43e2f8ea0ed1d50dddce3ebf80063888ac'
+position = 0
+script = token.hex
+input_amount = 5_0000_0000
+output_amount = 4_9991_0000
+output_amount_address = 20_000
+output_address = 'mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi'
+key = Bitcoin::Key.from_base58("cShKfHoHVf6iKKZym18ip1MJFQFxJwbcLxW53MQikxdDsGd2oxBU")
+@transaction_token = Keoken::Transaction::Token.send_amount(tx_id,
+                                                            position,
+                                                            input_script,
+                                                            input_amount,
+                                                            output_amount,
+                                                            output_amount_address,
+                                                            output_address,
+                                                            key,
+                                                            script)
+transaction = Keoken::Bitprim::Transaction.new(@transaction_token.raw)
+transaction.send_tx
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bitex-la/keoken-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/keoken/bitprim/config.yaml

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

data/lib/keoken/bitprim/transaction.rb

@@ -1,30 +1,34 @@
+require 'json'
 require 'yaml'
 require 'net/http'
 
 module Keoken
   module Bitprim
     class Transaction
-      attr_reader :raw
+      def send_tx(raw)
+        uri = URI("#{root_node_url}/tx/send")
+        request = Net::HTTP::Post.new(uri)
+        request.set_form_data(rawtx: raw)
 
-      def initialize(raw)
-        @raw = raw
+        response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(request)
+        end
+
+        response.value
       end
 
-      def send_tx
-        uri = URI("#{root_url}tx/send")
-        req = Net::HTTP::Post.new(uri)
-        req.set_form_data(rawtx: @raw)
+      def get_assets_by_address(address)
+        uri = URI("#{root_keoken_url}/get_assets_by_address")
+        params = { address: address }
+        uri.query = URI.encode_www_form(params)
+        response = Net::HTTP.get_response(uri)
 
-        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
-          http.request(req)
-        end
-
-        return res.value if res != Net::HTTPSuccess
+        JSON.parse(response.body.tr('\'', '"'))
       end
 
       private
 
-      def root_url
+      def root_node_url
         file = YAML.load_file('lib/keoken/bitprim/config.yaml')
         if ENV['KEOKEN_NODE'] == 'PRODUCTION'
           file['Bitprim']['node']['mainnet']['url']
@@ -32,6 +36,15 @@ module Keoken
           file['Bitprim']['node']['testnet']['url']
         end
       end
+
+      def root_keoken_url
+        file = YAML.load_file('lib/keoken/bitprim/config.yaml')
+        if ENV['KEOKEN_NODE'] == 'PRODUCTION'
+          file['Bitprim']['keoken']['mainnet']['url']
+        else
+          file['Bitprim']['keoken']['testnet']['url']
+        end
+      end
     end
   end
 end

data/lib/keoken/token.rb

@@ -11,10 +11,9 @@ module Keoken
       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
-      
+         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),
@@ -27,10 +26,10 @@ module Keoken
     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
+        [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)
 
@@ -42,6 +41,7 @@ module Keoken
     end
 
     private
+
     def name_to_hex(name)
       asset_bytes = name.bytes.map{|n| n.to_s(16)}
       asset_bytes + ['00']

data/lib/keoken/transaction/token.rb

@@ -27,17 +27,17 @@ module Keoken
         token
       end
 
-      def self.send_amount(tx_id, position, input_script, input_amount, output_amount, output_amount_to_addr2, key, script)
+      def self.send_amount(tx_id, position, input_script, input_amount, output_amount, output_amount_to_addr2, 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)
+          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_to_addr2
             o.script do |s|
-              s.recipient(key2.addr)
+              s.recipient(addr2)
             end
           end
           t.output do |o|

data/lib/keoken/version.rb

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

data/spec/keoken_spec.rb

@@ -43,7 +43,7 @@ describe Keoken do
     )
   end
 
-  describe 'creates bitcoin transaction' do
+  describe 'creates token' do
     before(:each) do
       Bitcoin.network = :testnet3
       token = Keoken::Token.new(name: 'test-keoken')
@@ -93,8 +93,96 @@ describe Keoken do
               'User-Agent' => 'Ruby'
             })
         .to_return(status: 200, body: '', headers: {})
-      transaction = Keoken::Bitprim::Transaction.new(@transaction_token.raw)
-      expect(transaction.send_tx).to be_nil
+      transaction = Keoken::Bitprim::Transaction.new
+      expect(transaction.send_tx(@transaction_token.raw)).to be_nil
+    end
+  end
+
+  describe 'send money token' do
+    before(:each) do
+      Bitcoin.network = :testnet3
+      token = Keoken::Token.new(id: 21)
+      token.send_amount(500_000)
+      tx_id = 'aa699dc5ddf598a50dc2cb2cb2729629cb9d2d865df38e4367d13f81ef55f96e'
+      input_script = '76a9147bb97684cc43e2f8ea0ed1d50dddce3ebf80063888ac'
+      position = 0
+      script = token.hex
+      input_amount = 5_0000_0000
+      output_amount = 4_9991_0000
+      output_amount_address = 20_000
+      output_address = 'mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi'
+      key = Bitcoin::Key.from_base58("cShKfHoHVf6iKKZym18ip1MJFQFxJwbcLxW53MQikxdDsGd2oxBU")
+      @transaction_token = Keoken::Transaction::Token.send_amount(tx_id,
+                                                                  position,
+                                                                  input_script,
+                                                                  input_amount,
+                                                                  output_amount,
+                                                                  output_amount_address,
+                                                                  output_address,
+                                                                  key,
+                                                                  script)
+    end
+
+    it 'format to_json' do
+      json = JSON.parse(@transaction_token.to_json)
+      expect(json['out']).to(
+        eq(
+          [
+            {
+              "value" => "0.00020000",
+              "scriptPubKey" => "OP_DUP OP_HASH160 4c2791f07c046ef21d688f12296f91ad7b44d2bb OP_EQUALVERIFY OP_CHECKSIG"
+            },
+            {
+              "value"=>"4.99910000",
+              "scriptPubKey"=> "OP_DUP OP_HASH160 7bb97684cc43e2f8ea0ed1d50dddce3ebf800638 OP_EQUALVERIFY OP_CHECKSIG"
+            },
+            {
+              "value" => "0.00000000",
+              "scriptPubKey" => "OP_RETURN 00004b50 00000001000000210000000000500000"
+            }
+          ]
+        )
+      )
+    end
+
+    it 'raw transaction' do
+      raw = @transaction_token.raw
+      expect(raw).to start_with('01000000016ef955ef813fd167438ef35d862d9dcb299672b22ccbc20da598f5ddc59d69aa00000000')
+      expect(raw).to end_with('6a0400004b50100000000100000021000000000050000000000000')
+    end
+  end
+
+  describe 'get assets' do
+    before(:each) do
+      Bitcoin.network = :testnet3
+    end
+
+    it 'get assets by address mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi' do
+      body_response = "[{'amount': 100000, 'asset_creator': 'mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi', 'asset_id': 123, 'asset_name': 'keoken-token'}]"
+      stub_request(:get, 'https://explorer.testnet.keoken.io/api/get_assets_by_address?address=mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi')
+        .with(
+          headers: {
+            'Accept' => '*/*',
+            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+            'Host' => 'explorer.testnet.keoken.io',
+            'User-Agent' => 'Ruby'
+          }
+        )
+        .to_return(status: 200, body: body_response, headers: {})
+
+      transaction = Keoken::Bitprim::Transaction.new
+      assets = transaction.get_assets_by_address('mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi')
+
+      expect(assets).to eq(
+        [
+          {
+            'amount' => 100_000,
+            'asset_creator' => 'mnTd41YZ1e1YqsaPNJh3wkeSUrFvp1guzi',
+            'asset_id' => 123,
+            'asset_name' => 'keoken-token'
+          }
+        ]
+      )
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keoken
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bitex
@@ -118,6 +118,7 @@ files:
 - ".rspec"
 - Gemfile
 - Gemfile.lock
+- README.md
 - keoken.gemspec
 - lib/keoken.rb
 - lib/keoken/bitprim/config.yaml