glueby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593ee57bb01d23f91f508e851efa30d3fbbeda69232ebde715abc242fe609f02
-  data.tar.gz: 6444c5e75e4fe70f3dca80c65546b340968577c0b7e7a82e21b5b8eb6836ab47
+  metadata.gz: d988a55f8acc63e5c2abb8f30ab88030a19c8e42212e372a8eeea6a2c5f3b27d
+  data.tar.gz: 9cee6ba595dd3ba576d1190350396a4c55923c58620a529ec0ff55cc4249b69b
 SHA512:
-  metadata.gz: 899894c6b9e24800f562f6360ea00b568c8bd333dccfbde038e9cdff1c75f8fa10e27086737f2df5547710b401a455c5f9adb766a7a27a1b1dbbc9585df6e0d3
-  data.tar.gz: bee37a6f3267f476a562f6c2d1c75424d549573d3fd4177b4a0811c1a866e87e7ac0f2f73fdca477814ee9d9fda797b0b6ba423ddd67efedca1ccdb987045022
+  metadata.gz: 610751093275239e15a70726033be9a3eb4ca65e65c1b86874f09471f4391fbc764463f76da36619b7429dac7c2b70b1f6596e2e3b2eacb397f11029018fb8e1
+  data.tar.gz: c48b89c3b4a61f652b051642420f1d8b3aa08ad3d90f8807ec8803f63d64e675a924a56990f42fc3d4201d6a90c99fa8101f423bbe66143ae735efdfae758cbf

data/.ruby-gemset

@@ -1 +1 @@
-tapyrusrb
+glueby

data/.ruby-version

@@ -1 +1 @@
-2.7.0
+ruby-3.0.0

data/.travis.yml

@@ -2,5 +2,6 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.1.4
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0

data/README.md

@@ -1,4 +1,4 @@
-# Glueby
+# Glueby [![Build Status](https://travis-ci.org/chaintope/glueby.svg?branch=master)](https://travis-ci.org/chaintope/glueby) [![Gem Version](https://badge.fury.io/rb/glueby.svg)](https://badge.fury.io/rb/glueby) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/glueby`. To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -22,12 +22,19 @@ Or install it yourself as:
 
 ## Usage
 
+Glueby has below features.
+
+- [Timestamp](#Timestamp)
+
+### Timestamp
+
 ```ruby
 
-config = {schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
-Glueby::Contract::RPC.configure(config)
+config = {adapter: 'core', schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
+Glueby::Wallet.configure(config)
 
-timestamp = Glueby::Contract::Timestamp.new(content: "\x01\x02\x03")
+wallet = Glueby::Wallet.create
+timestamp = Glueby::Contract::Timestamp.new(wallet: wallet, content: "\x01\x02\x03")
 timestamp.save!
 # "a01eace94ce6cdc30f389609de8a7584a4e208ee82fec33a2f5875b7cee47097"
 
@@ -89,26 +96,28 @@ We can see the timestamp transaction using getrawblockchain command
 }
 ```
 
-### Rails support
+#### Rails support
 
-Gruby supports ruby on rails integration.
+Glueby supports ruby on rails integration.
 
 To use in rails, Add dependency to Gemfile.
 
 Then invoke install task.
+
 ```
 bin/rails glueby:contract:install
 ```
 
 Install task creates a file `glueby.rb` in `config/initializers` directory like this.
+
 ```
-require 'tapyrus'
 # Edit configuration for connection to tapyrus core
-config = {schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
-Glueby::Contract::RPC.configure(config)
+config = {adapter: 'core', schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
+Glueby::Wallet.configure(config)
 ```
 
 If you use timestamp feature, use `glueby:contract:timestamp` generator.
+
 ```
 bin/rails g glueby:contract:timestamp
     create  db/migrate/20200613065511_create_timestamp.rb
@@ -122,13 +131,15 @@ bin/rails db:migrate
 Now, Glueby::Contract::AR::Timestamp model is available
 
 ```ruby
-irb(main):001:0> t = Glueby::AR::Contract::Timestamp.new(content:"\x01010101", prefix: "app")
-   (0.4ms)  SELECT sqlite_version(*)
-=> #<Glueby::AR::Contract::Timestamp id: nil, txid: nil, vout: nil, status: "init", content_hash: "9ccc644b03a88358a754962903a659a2d338767ee61674dde5...", prefix: "app">
-irb(main):002:0> t.save
+irb(main):001:0> wallet = Glueby::Wallet.create
+=> #<Glueby::Wallet:0x00007fe8333f7d98 @internal_wallet=#<Glueby::Internal::Wallet:0x00007fe8333f7dc0 @id="70a58204a7f4cb10d973b762f17fdb4b">>
+irb(main):003:0> t = Glueby::Contract::AR::Timestamp.new(wallet_id: wallet.id, content:"\x01010101", prefix: "app")
+   (0.5ms)  SELECT sqlite_version(*)
+=> #<Glueby::Contract::AR::Timestamp id: nil, txid: nil, status: "init", content_hash: "9ccc644b03a88358a754962903a659a2d338767ee61674dde5...", prefix: "app", wallet_id: "70a58204a7f4cb10d973b762f17fdb4b">
+irb(main):004:0> t.save
    (0.1ms)  begin transaction
-  Glueby::AR::Contract::Timestamp Create (0.7ms)  INSERT INTO "timestamps" ("status", "content_hash", "prefix") VALUES (?, ?, ?)  [["status", 0], ["content_hash", "9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d"], ["prefix", "app"]]
-   (2.3ms)  commit transaction
+  Glueby::Contract::AR::Timestamp Create (0.4ms)  INSERT INTO "timestamps" ("status", "content_hash", "prefix", "wallet_id") VALUES (?, ?, ?, ?)  [["status", 0], ["content_hash", "9ccc644b03a88358a754962903a659a2d338767ee61674dde5434702a6256e6d"], ["prefix", "app"], ["wallet_id", "70a58204a7f4cb10d973b762f17fdb4b"]]
+   (2.1ms)  commit transaction
 => true
 ```
 
@@ -140,12 +151,12 @@ broadcasted (id=1, txid=8d602ca8ebdd50fa70b5ee6bc6351965b614d0a4843adacf9f43fedd
 ```
 
 Run `glueby:contract:timestamp:confirm` task to confirm the transaction and update status(unconfirmed -> confirmded).
+
 ```
 bin/rails glueby:contract:timestamp:confirm
 confirmed (id=1, txid=8d602ca8ebdd50fa70b5ee6bc6351965b614d0a4843adacf9f43fedd7112fbf4)
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -156,7 +167,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/glueby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tapyrus-contractrb/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/glueby.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'tapyrus'
+  spec.add_runtime_dependency 'tapyrus', '>= 0.2.6'
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'sqlite3'
 end

data/lib/generators/glueby/contract/templates/initializer.rb.erb

@@ -0,0 +1,3 @@
+# Edit configuration for connection to tapyrus core
+config = {adapter: 'core', schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
+Glueby::Wallet.configure(config)

data/lib/generators/glueby/contract/templates/key_table.rb.erb

@@ -0,0 +1,15 @@
+class CreateKey < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :keys<%= table_options %> do |t|
+      t.string     :private_key
+      t.string     :public_key
+      t.string     :script_pubkey
+      t.integer    :purpose
+      t.belongs_to :wallet
+      t.timestamps
+    end
+
+    add_index :keys, [:script_pubkey], unique: true
+    add_index :keys, [:private_key], unique: true
+  end
+end

data/lib/generators/glueby/{templates → contract/templates}/timestamp_table.rb.erb

@@ -5,6 +5,7 @@ class CreateTimestamp < ActiveRecord::Migration<%= migration_version %>
       t.integer  :status
       t.string   :content_hash
       t.string   :prefix
+      t.string   :wallet_id
     end
   end
-end
+end

data/lib/generators/glueby/contract/templates/utxo_table.rb.erb

@@ -0,0 +1,15 @@
+class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :utxos<%= table_options %> do |t|
+      t.string     :txid
+      t.integer    :index
+      t.bigint     :value
+      t.string     :script_pubkey
+      t.integer    :status
+      t.belongs_to :key, null: true
+      t.timestamps
+    end
+
+    add_index :utxos, [:txid, :index], unique: true
+  end
+end

data/lib/generators/glueby/contract/templates/wallet_table.rb.erb

@@ -0,0 +1,10 @@
+class CreateWallet < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :wallets<%= table_options %> do |t|
+      t.string :wallet_id
+      t.timestamps
+    end
+
+    add_index :wallets, [:wallet_id], unique: true
+  end
+end

data/lib/generators/glueby/contract/timestamp_generator.rb

@@ -0,0 +1,26 @@
+module Glueby
+  module Contract
+    class TimestampGenerator < Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      include Glueby::Generator::MigrateGenerator
+      extend Glueby::Generator::MigrateGenerator::ClassMethod
+
+      source_root File.expand_path('templates', __dir__)
+
+      def create_migration_file
+        migration_dir = File.expand_path("db/migrate")
+
+        if self.class.migration_exists?(migration_dir, "create_timestamp")
+          ::Kernel.warn "Migration already exists: create_timestamp"
+        else
+          migration_template(
+            "timestamp_table.rb.erb",
+            "db/migrate/create_timestamp.rb",
+            migration_version: migration_version,
+            table_options: table_options,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/generators/glueby/contract/wallet_adapter_generator.rb

@@ -0,0 +1,46 @@
+module Glueby
+  module Contract
+    class WalletAdapterGenerator < Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      include Glueby::Generator::MigrateGenerator
+      extend Glueby::Generator::MigrateGenerator::ClassMethod
+
+      source_root File.expand_path('templates', __dir__)
+
+      def create_migration_file
+        migration_dir = File.expand_path("db/migrate")
+
+        if self.class.migration_exists?(migration_dir, "create_wallet")
+          ::Kernel.warn "Migration already exists: create_wallet"
+        else
+          migration_template(
+            "wallet_table.rb.erb",
+            "db/migrate/create_wallet.rb",
+            migration_version: migration_version,
+            table_options: table_options,
+          )
+        end
+        if self.class.migration_exists?(migration_dir, "create_key")
+          ::Kernel.warn "Migration already exists: create_key"
+        else
+          migration_template(
+            "key_table.rb.erb",
+            "db/migrate/create_key.rb",
+            migration_version: migration_version,
+            table_options: table_options,
+          )
+        end
+        if self.class.migration_exists?(migration_dir, "create_utxo")
+          ::Kernel.warn "Migration already exists: create_utxo"
+        else
+          migration_template(
+            "utxo_table.rb.erb",
+            "db/migrate/create_utxo.rb",
+            migration_version: migration_version,
+            table_options: table_options,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/glueby.rb

@@ -1,5 +1,22 @@
 require "glueby/version"
+require 'tapyrus'
 
 module Glueby
   autoload :Contract, 'glueby/contract'
-end
+  autoload :Generator, 'glueby/generator'
+  autoload :Wallet, 'glueby/wallet'
+  autoload :Internal, 'glueby/internal'
+
+  begin
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "tasks/glueby/contract.rake"
+        load "tasks/glueby/contract/timestamp.rake"
+        load "tasks/glueby/contract/wallet_adapter.rake"
+      end
+    end
+  rescue
+    # Rake task is unavailable
+    puts "Rake task is unavailable"
+  end
+end

data/lib/glueby/contract.rb

@@ -3,22 +3,11 @@ module Glueby
     autoload :Errors, 'glueby/contract/errors'
     autoload :FeeProvider, 'glueby/contract/fee_provider'
     autoload :FixedFeeProvider, 'glueby/contract/fee_provider'
-    autoload :RPC, 'glueby/contract/rpc'
+    autoload :Payment, 'glueby/contract/payment'
     autoload :Timestamp, 'glueby/contract/timestamp'
+    autoload :Token, 'glueby/contract/token'
     autoload :TxBuilder, 'glueby/contract/tx_builder'
-    autoload :WalletFeature, 'glueby/contract/wallet_feature'
     autoload :AR, 'glueby/contract/active_record'
-
-    begin
-      class Railtie < ::Rails::Railtie
-        rake_tasks do
-          load "tasks/glueby/contract.rake"
-          load "tasks/glueby/contract/timestamp.rake"
-        end
-      end
-    rescue
-      # Rake task is unavailable
-      puts "Rake task is unavailable"
-    end  
+    autoload :Wallet, 'glueby/contract/wallet'
   end
 end

data/lib/glueby/contract/active_record/timestamp.rb

@@ -5,11 +5,14 @@ module Glueby
         include Glueby::Contract::Timestamp::Util
         enum status: { init: 0, unconfirmed: 1, confirmed: 2 }
 
-        # @param [String] content Data to be hashed and stored in blockchain.
-        # @param [String] prefix prefix of op_return data
-        def initialize(content:, prefix: '')
-          @content_hash = Tapyrus.sha256(content).bth
-          super(content_hash: @content_hash, prefix: prefix, status: :init)
+        # @param [Hash] attributes attributes which consist of:
+        # - wallet_id
+        # - content
+        # - prefix(optional)
+        def initialize(attributes = nil)
+          @content_hash = Tapyrus.sha256(attributes[:content]).bth
+          super(wallet_id: attributes[:wallet_id], content_hash: @content_hash,
+                prefix: attributes[:prefix] ? attributes[:prefix] : '', status: :init)
         end
       end
     end

data/lib/glueby/contract/errors.rb

@@ -2,7 +2,13 @@ module Glueby
   module Contract
     module Errors
       class InsufficientFunds < StandardError; end
+      class InsufficientTokens < StandardError; end
+      class InvalidAmount < StandardError; end
+      class InvalidTokenType < StandardError; end
       class TxAlreadyBroadcasted < StandardError; end
+      class UnsupportedTokenType < StandardError; end
+      class UnknownScriptPubkey < StandardError; end
+      class UnsupportedDigestType < StandardError; end
     end
   end
 end

data/lib/glueby/contract/payment.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Glueby
+  module Contract
+    # This class can send TPC between wallets.
+    #
+    # Examples:
+    #
+    # sender = Glueby::Wallet.load("wallet_id")
+    # receiver = Glueby::Wallet.load("wallet_id")
+    #                      or
+    #            Glueby::Wallet.create
+    #
+    # Balance of sender and receiver before send
+    # sender.balances[""]
+    # => 100_000(tapyrus)
+    # receiver.balances[""]
+    # => 0(tapyrus)
+    #
+    # Send
+    # Payment.transfer(sender: sender, receiver: receiver, amount: 10_000)
+    # sender.balances[""]
+    # => 90_000
+    # receiver.balances[""]
+    # => 10_000
+    #
+    class Payment
+      extend Glueby::Contract::TxBuilder
+
+      class << self
+        def transfer(sender:, receiver:, amount:, fee_provider: FixedFeeProvider.new)
+          raise Glueby::Contract::Errors::InvalidAmount unless amount.positive?
+
+          tx = Tapyrus::Tx.new
+          dummy_fee = fee_provider.fee(dummy_tx(tx))
+
+          sum, outputs = sender.internal_wallet.collect_uncolored_outputs(dummy_fee + amount)
+          fill_input(tx, outputs)
+
+          receiver_script = Tapyrus::Script.parse_from_addr(receiver.internal_wallet.receive_address)
+          tx.outputs << Tapyrus::TxOut.new(value: amount, script_pubkey: receiver_script)
+
+          fee = fee_provider.fee(tx)
+
+          fill_change_tpc(tx, sender, sum - fee - amount)
+
+          tx = sender.internal_wallet.sign_tx(tx)
+
+          Glueby::Internal::RPC.client.sendrawtransaction(tx.to_hex)
+        end
+      end
+    end
+  end
+end

data/lib/glueby/contract/timestamp.rb

@@ -11,59 +11,37 @@ module Glueby
       include Glueby::Contract::TxBuilder
 
       module Util
+        include Glueby::Internal::Wallet::TapyrusCoreWalletAdapter::Util
         module_function
 
-        def create_tx(prefix, data_hash, fee_provider)
+        def create_tx(wallet, prefix, data, fee_provider)
           tx = Tapyrus::Tx.new
-          tx.outputs << Tapyrus::TxOut.new(value: 0, script_pubkey: create_script(prefix, data_hash))
+          tx.outputs << Tapyrus::TxOut.new(value: 0, script_pubkey: create_script(prefix, data))
   
-          results = list_unspent
-          fee = fee_provider.fee(tx)
-          sum, outputs = collect_outputs(results, fee)
+          fee = fee_provider.fee(dummy_tx(tx))
+          sum, outputs = wallet.internal_wallet.collect_uncolored_outputs(fee)
           fill_input(tx, outputs)
   
-          change_script = create_change_script
-          fill_change_output(tx, fee, change_script, sum)
-          tx
+          fill_change_tpc(tx, wallet, sum - fee)
+          wallet.internal_wallet.sign_tx(tx)
         end
   
-        def create_payload(prefix, data_hash)
+        def create_payload(prefix, data)
           payload = +''
           payload << prefix
-          payload << data_hash
+          payload << data
           payload
         end
 
-        def create_script(prefix, data_hash)
+        def create_script(prefix, data)
           script = Tapyrus::Script.new
           script << Tapyrus::Script::OP_RETURN
-          script << create_payload(prefix, data_hash)
+          script << create_payload(prefix, data)
           script
         end
 
-        def create_change_script
-          address = Glueby::Contract::RPC.client.getnewaddress
-          decoded = Tapyrus.decode_base58_address(address)
-          Tapyrus::Script.to_p2pkh(decoded[0])
-        end
-
-        def sign_tx(tx)
-          # TODO: Implement SignatureProvider
-          response = Glueby::Contract::RPC.client.signrawtransactionwithwallet(tx.to_payload.bth)
-          Tapyrus::Tx.parse_from_payload(response['hex'].htb)
-        end
-
-        def list_unspent
-          # TODO: Implement UtxoProvider
-          Glueby::Contract::RPC.client.listunspent(0, 999_999)
-        end
-
-        def broadcast_tx(tx)
-          Glueby::Contract::RPC.client.sendrawtransaction(tx.to_payload.bth)
-        end
-
         def get_transaction(tx)
-          Glueby::Contract::RPC.client.getrawtransaction(tx.txid, 1)
+          Glueby::Internal::RPC.client.getrawtransaction(tx.txid, 1)
         end
       end
       include Glueby::Contract::Timestamp::Util
@@ -73,14 +51,23 @@ module Glueby
       # @param [String] content Data to be hashed and stored in blockchain.
       # @param [String] prefix prefix of op_return data
       # @param [Glueby::Contract::FeeProvider] fee_provider
+      # @param [Symbol] digest type which select of:
+      # - :sha256
+      # - :double_sha256
+      # - :none
+      # @raise [Glueby::Contract::Errors::UnsupportedDigestType] if digest unsupport
       def initialize(
+        wallet:,
         content:,
         prefix: '',
-        fee_provider: Glueby::Contract::FixedFeeProvider.new
+        fee_provider: Glueby::Contract::FixedFeeProvider.new,
+        digest: :sha256
       )
+        @wallet = wallet
         @content = content
         @prefix = prefix
         @fee_provider = fee_provider
+        @digest = digest
       end
 
       # broadcast to Tapyrus Core
@@ -90,9 +77,23 @@ module Glueby
       def save!
         raise Glueby::Contract::Errors::TxAlreadyBroadcasted if @txid
 
-        @tx = create_tx(@prefix, Tapyrus.sha256(@content), @fee_provider)
-        @tx = sign_tx(@tx)
-        @txid = broadcast_tx(@tx)
+        @tx = create_tx(@wallet, @prefix, digest_content, @fee_provider)
+        @txid = @wallet.internal_wallet.broadcast(@tx)
+      end
+
+      private
+
+      def digest_content
+        case @digest&.downcase
+        when :sha256
+          Tapyrus.sha256(@content)
+        when :double_sha256
+          Tapyrus.double_sha256(@content)
+        when :none
+          @content
+        else
+          raise Glueby::Contract::Errors::UnsupportedDigestType
+        end
       end
     end
   end