glueby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b977d0a922975117e46c6777bf07fb13ad89d03bee8d9785ddec04e311f9c4
-  data.tar.gz: 5b0472f6ca379fcffd7dac8adcb8fe508237ae8fcf184c1372ba721c4104f13f
+  metadata.gz: 572e6f36cf1b1df86b93fcd264ce1a537769588a43cbe8bac5ad3d6d9df21f44
+  data.tar.gz: 4516f08781b324f76846057cfe4722552bc413e7f9518d68b038c7bc16f03f79
 SHA512:
-  metadata.gz: 1e2e21b82fe9fcb5ac8433d8f5952718624d7900b09f2ecf789163c3037a26a6b1939dbeb03dcccbf0051e890947f1612fc933c75d8093a3e74d26756ea43642
-  data.tar.gz: 8c6d28c5432a9e8a7d56072bf6398453da18d69ef564225987649ce6bf91e751ff40b42dba9c23d652a3a2b755539b919ad0c98ae83da6607c35b3a78b7f0fd1
+  metadata.gz: b04613b40d622b24e14fb45440ea974905daeea6726c4a44c9e458eabe9ea552e1b8a5ad581a7ea19ab8824216f001b95c49101fdefaf2bc424a39c2fdf23d07
+  data.tar.gz: 1e6a50bf51dd39249c5b2746e27831ca2b63da7bb02090ba2f04b978bfa172dc0372885774986cbbf94f07ccca11d82194b1d104c467d232e0916adab50c2308

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+
+    steps:
+      - run: docker pull tapyrus/tapyrusd:edge
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "docker-api", "~> 2.1.0"

data/README.md

@@ -1,4 +1,5 @@
-# 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)
+# Glueby [![Ruby](https://github.com/chaintope/glueby/actions/workflows/ruby.yml/badge.svg)](https://github.com/chaintope/glueby/actions/workflows/ruby.yml) [![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.
 
@@ -30,8 +31,10 @@ Glueby has below features.
 
 ```ruby
 
-config = {adapter: 'core', schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
-Glueby::Wallet.configure(config)
+Glurby.configure do |config|
+  config.wallet_adapter = :activerecord
+  config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
+end
 
 wallet = Glueby::Wallet.create
 timestamp = Glueby::Contract::Timestamp.new(wallet: wallet, content: "\x01\x02\x03")
@@ -110,10 +113,12 @@ bin/rails glueby:contract:install
 
 Install task creates a file `glueby.rb` in `config/initializers` directory like this.
 
-```
+```ruby
 # 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)
+Glueby.configure do |config|
+  config.wallet_adapter = :activerecord
+  config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
+end
 ```
 
 If you use timestamp feature, use `glueby:contract:timestamp` generator.
@@ -157,6 +162,106 @@ bin/rails glueby:contract:timestamp:confirm
 confirmed (id=1, txid=8d602ca8ebdd50fa70b5ee6bc6351965b614d0a4843adacf9f43fedd7112fbf4)
 ```
 
+## Use fee provider mode
+
+Glueby contracts have two different way of fee provisions.
+
+1. `:sender_pays_itself`
+2. `:fee_provider_bears`
+
+The first one: `:sender_pays_itself`, is the default behavior.
+In the second Fee Provider mode, the Fee Provider module pays a fee instead of the transaction's sender.
+
+### Fee Provider Specification
+
+* Fee Provider pays fixed amount fee, and it is configurable.
+* Fee Provider needs to have enough funds into their wallet.
+* Fee Provider is managed to keep some number of UTXOs that have fixed fee value by rake tasks.
+
+### Setting up Fee Provider
+
+1. Set like below
+
+```ruby
+Glurby.configure do |config|
+  # Use FeeProvider to supply inputs for fees on each transaction that is created on Glueby.
+  config.fee_provider_bears!
+  config.fee_provider_config = {
+    # The fee that Fee Provider pays on each transaction.
+    fixed_fee: 1000,
+    # Fee Provider tries to keep the number of utxo in utxo pool as this size using `glueby:fee_provider:manage_utxo_pool` rake task
+    utxo_pool_size: 20 
+  }
+end
+```
+
+2. Deposit TPC into Fee Provider's wallet
+
+Get an address from the wallet.
+
+```
+$ bundle exec rake glueby:fee_provider:address
+mqYTLdLCUCCZkTkcpbVx1GqpvV1gK4euRD
+```
+
+Send TPC to the address.
+
+If you use `Glueby::Contract::Payment` to the sending, you can do like this:
+
+```ruby
+Glueby::Contract::Payment.transfer(sender: sender, receiver_address: 'mqYTLdLCUCCZkTkcpbVx1GqpvV1gK4euRD', amount: 1_000_000)
+```
+
+3. Manage UTXO pool
+
+The Fee Provider's wallet has to keep some UTXOs with `fixed_fee` amount for paying fees using `manage_utxo_pool` rake task below.
+This rake task tries to split UTOXs up to `utxo_pool_size`. If the pool has more than `utxo_pool_size` UTXOs, it does nothing.
+
+```
+$ bundle exec rake glueby:fee_provider:manage_utxo_pool
+Status: Ready
+TPC amount: 999_000
+UTXO pool size: 20
+
+Configuration:
+  fixed_fee = 1_000
+  utxo_pool_size = 20
+```
+
+This shows that the UTXO pool has 20 UTXOs with `fixed_fee` amount for paying fees and has other UTXOs that never use for paying fees.
+The sum of all the UTXOs that includes both kinds of UTXO is 999_000 tapyrus.
+
+If the wallet doesn't have enough amount, the rake task shows an error like:
+
+```
+$ bundle exec rake glueby:fee_provider:manage_utxo_pool
+Status: Insufficient Amount
+TPC amount: 15_000
+UTXO pool size: 15
+
+1. Please replenishment TPC which is for paying fee to FeeProvider. 
+   FeeProvider needs 21000 tapyrus at least for paying 20 transaction fees. 
+   FeeProvider wallet's address is '1DBgMCNBdjQ1Ntz1vpwx2HMYJmc9kw88iT'
+2. Then create UTXOs for paying in UTXO pool with 'rake glueby:fee_provider:manage_utxo_pool'
+
+Configuration:
+  fixed_fee = 1_000
+  utxo_pool_size = 20
+```
+
+If you want to get the status information, you can use the `status` task.
+
+```
+$ bundle exec rake glueby:fee_provider:status
+Status: Ready
+TPC amount: 999_000
+UTXO pool size: 20
+
+Configuration:
+  fixed_fee = 1_000
+  utxo_pool_size = 20
+```
+
 ## 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.

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', '>= 0.2.6'
+  spec.add_runtime_dependency 'tapyrus', '>= 0.2.9'
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'sqlite3'
 end

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

@@ -0,0 +1,26 @@
+module Glueby
+  module Contract
+    class ReissuableTokenGenerator < 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_reissuable_token")
+          ::Kernel.warn "Migration already exists: create_reissuable_token"
+        else
+          migration_template(
+            "reissuable_token_table.rb.erb",
+            "db/migrate/create_reissuable_token.rb",
+            migration_version: migration_version,
+            table_options: table_options,
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 class CreateKey < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :keys<%= table_options %> do |t|
+    create_table :glueby_keys<%= table_options %> do |t|
       t.string     :private_key
       t.string     :public_key
       t.string     :script_pubkey
@@ -9,7 +9,7 @@ class CreateKey < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :keys, [:script_pubkey], unique: true
-    add_index :keys, [:private_key], unique: true
+    add_index :glueby_keys, [:script_pubkey], unique: true
+    add_index :glueby_keys, [:private_key], unique: true
   end
 end

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

@@ -0,0 +1,10 @@
+class CreateReissuableToken < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :glueby_reissuable_tokens<%= table_options %> do |t|
+      t.string  :color_id, null: false
+      t.string  :script_pubkey, null: false
+      t.timestamps
+    end
+    add_index :glueby_reissuable_tokens, [:color_id], unique: true
+  end
+end

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

@@ -1,11 +1,11 @@
 class CreateSystemInformation < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :system_informations<%= table_options %> do |t|
+    create_table :glueby_system_informations<%= table_options %> do |t|
       t.string  :info_key
       t.string  :info_value
       t.timestamps
     end
-    add_index  :system_informations, [:info_key], unique: true
+    add_index  :glueby_system_informations, [:info_key], unique: true
 
     Glueby::AR::SystemInformation.create(info_key: "synced_block_number", info_value: "0")
   end

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

@@ -1,6 +1,6 @@
 class CreateTimestamp < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :timestamps<%= table_options %> do |t|
+    create_table :glueby_timestamps<%= table_options %> do |t|
       t.string   :txid
       t.integer  :status
       t.string   :content_hash

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

@@ -1,6 +1,6 @@
 class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :utxos<%= table_options %> do |t|
+    create_table :glueby_utxos<%= table_options %> do |t|
       t.string     :txid
       t.integer    :index
       t.bigint     :value
@@ -10,6 +10,6 @@ class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :utxos, [:txid, :index], unique: true
+    add_index :glueby_utxos, [:txid, :index], unique: true
   end
 end

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

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

data/lib/glueby.rb

@@ -7,6 +7,13 @@ module Glueby
   autoload :Wallet, 'glueby/wallet'
   autoload :Internal, 'glueby/internal'
   autoload :AR, 'glueby/active_record'
+  autoload :FeeProvider, 'glueby/fee_provider'
+  autoload :Configuration, 'glueby/configuration'
+
+  # Add prefix to activerecord table names
+  def self.table_name_prefix
+    'glueby_'
+  end
 
   begin
     class Railtie < ::Rails::Railtie
@@ -15,10 +22,28 @@ module Glueby
         load "tasks/glueby/contract/timestamp.rake"
         load "tasks/glueby/contract/wallet_adapter.rake"
         load "tasks/glueby/contract/block_syncer.rake"
+        load "tasks/glueby/fee_provider.rake"
       end
     end
   rescue
     # Rake task is unavailable
     puts "Rake task is unavailable"
   end
+
+  # Returns the global [Configuration](RSpec/Core/Configuration) object.
+  def self.configuration
+    @configuration ||= Glueby::Configuration.new
+  end
+
+  # Yields the global configuration to a block.
+  # @yield [Configuration] global configuration
+  #
+  # @example
+  #     Glueby.configure do |config|
+  #       config.wallet_adapter = :activerecord
+  #       config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
+  #     end
+  def self.configure
+    yield configuration if block_given?
+  end
 end

data/lib/glueby/configuration.rb

@@ -0,0 +1,62 @@
+module Glueby
+  # Global configuration on runtime
+  #
+  # The global configuration treats configurations for all modules in Glueby.
+  #
+  # @example
+  #     Glueby.configure do |config|
+  #       config.wallet_adapter = :activerecord
+  #       config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
+  #     end
+  class Configuration
+
+    attr_reader :fee_provider_bears
+    alias_method :fee_provider_bears?, :fee_provider_bears
+
+    def initialize
+      @fee_provider_bears = false
+    end
+
+    # Specify wallet adapter.
+    # @param [Symbol] adapter - The adapter type :activerecord or :core is currently supported.
+    def wallet_adapter=(adapter)
+      case adapter
+      when :core
+        Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::TapyrusCoreWalletAdapter.new
+      when :activerecord
+        Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::ActiveRecordWalletAdapter.new
+      else
+        raise 'Not implemented'
+      end
+    end
+
+    # Specify connection information to Tapyrus Core RPC.
+    # @param [Hash] config
+    # @option config [String] :schema - http or https
+    # @option config [String] :host - The host of the RPC endpoint
+    # @option config [Integer] :port - The port of the RPC endpoint
+    # @Option config [String] :user - The user for Basic Authorization of the RPC endpoint
+    # @Option config [String] :password - The password for Basic Authorization of the RPC endpoint
+    def rpc_config=(config)
+      Glueby::Internal::RPC.configure(config)
+    end
+
+    # Use This to enable to use FeeProvider to supply inputs for fees on each transaction that is created on Glueby.
+    def fee_provider_bears!
+      @fee_provider_bears = true
+    end
+
+    # Use This to disable to use FeeProvider
+    def disable_fee_provider_bears!
+      @fee_provider_bears = false
+    end
+
+    # Specify FeeProvider configuration.
+    # @param [Hash] config
+    # @option config [Integer] :fixed_fee - The fee that Fee Provider pays on each transaction.
+    # @option config [Integer] :utxo_pool_size - Fee Provider tries to keep the number of utxo in utxo pool as this size using `glueby:fee_provider:manage_utxo_pool` rake task
+    def fee_provider_config=(config)
+      FeeProvider.configure(config)
+    end
+  end
+end

data/lib/glueby/contract.rb

@@ -1,8 +1,8 @@
 module Glueby
   module Contract
     autoload :Errors, 'glueby/contract/errors'
-    autoload :FeeProvider, 'glueby/contract/fee_provider'
-    autoload :FixedFeeProvider, 'glueby/contract/fee_provider'
+    autoload :FeeEstimator, 'glueby/contract/fee_estimator'
+    autoload :FixedFeeEstimator, 'glueby/contract/fee_estimator'
     autoload :Payment, 'glueby/contract/payment'
     autoload :Timestamp, 'glueby/contract/timestamp'
     autoload :Token, 'glueby/contract/token'

data/lib/glueby/contract/active_record.rb

@@ -3,6 +3,7 @@ require 'active_record'
 module Glueby
   module Contract
     module AR
+      autoload :ReissuableToken, 'glueby/contract/active_record/reissuable_token'
       autoload :Timestamp, 'glueby/contract/active_record/timestamp'
     end
   end