glueby 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d988a55f8acc63e5c2abb8f30ab88030a19c8e42212e372a8eeea6a2c5f3b27d
-  data.tar.gz: 9cee6ba595dd3ba576d1190350396a4c55923c58620a529ec0ff55cc4249b69b
+  metadata.gz: fbaba6627d1c34e6a2de2a3861016995481ad53163764a057c25fca123a8750b
+  data.tar.gz: 209020a3b503ac44cc9d4ef51e95d7ce71f17af59b92ffe3bb4863b4ae750604
 SHA512:
-  metadata.gz: 610751093275239e15a70726033be9a3eb4ca65e65c1b86874f09471f4391fbc764463f76da36619b7429dac7c2b70b1f6596e2e3b2eacb397f11029018fb8e1
-  data.tar.gz: c48b89c3b4a61f652b051642420f1d8b3aa08ad3d90f8807ec8803f63d64e675a924a56990f42fc3d4201d6a90c99fa8101f423bbe66143ae735efdfae758cbf
+  metadata.gz: 559e4f224359df179cafc4f20c19f3f7c9723f6411103532ad6fd7d9727b5063c369b44e4e6c7872bc49d9355ec0cedd4f720c195302546cab7a5e5b429f6676
+  data.tar.gz: b4a4a1641820f23513ea56e1c240db966bcb9b0d62fd463d54f08e09f454125cdca4a087bc8db8c9b0181cd867ee667ec1b2bf5fbe1b95329541b3dd5fe2538b

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,8 +1,31 @@
-# 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.
+Glueby is a smart contract library on the [Tapyrus blockchain](https://github.com/chaintope/tapyrus-core). This is 
+designed as you can use without any deep blockchain understanding.
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+
+Glueby has below features.
+
+1. Wallet
+   You can manage wallets for application users. This wallet feature is a foundation of Contracts below to specify tx
+   sender and so on.  
+   You can choose two sorts of wallet implementation :activerecord and :core. :activerecord is implemented using
+   ActiveRecord on RDB. :core uses the wallet that bundled with Tapyrus Core.
+   
+2. Contracts  
+   You can use some smart contracts easily  
+   - [Timestamp](#Timestamp): Record any data as a timestamp to a tapyrus blockchain.
+   - [Payment](./lib/glueby/contract/payment.rb): Transfer TPC.
+   - [Token](./lib/glueby/contract/token.rb): Issue, transfer and burn colored coin.
+
+3. Sync blocks with your application   
+   You can use BlockSyncer when you need to synchronize the state of an application with the state of a blockchain.  
+   See more details at [BlockSyncer](./lib/glueby/block_syncer.rb).
+
+4. Take over tx sender's fees  
+   FeeProvider module can bear payments of sender's fees. You should provide funds for fees to FeeProvider before use.  
+   See how to set up at [Use fee provider mode](#use-fee-provider-mode)
 
 ## Installation
 
@@ -20,18 +43,102 @@ Or install it yourself as:
 
     $ gem install glueby
 
-## Usage
+### Setup for Ruby on Rails application development
 
-Glueby has below features.
+1. Add this line to your application's Gemfile
+
+    ```ruby
+    gem 'glueby'
+    ```
+
+    and then execute 
+    
+        $ bundle install
+
+2. Run installation rake task
+
+        $ rails glueby:contract:install
+
+3. Run Tapyrus Core as dev mode
+
+    We recommend to run as a Docker container. 
+    Docker image is here.
+
+    * [tapyus/tapyrusd](https://hub.docker.com/repository/docker/tapyrus/tapyrusd)
+
+    Starts tapryusd container
+
+        $ docker run -d --name 'tapyrus_node_dev' -p 12381:12381 -e GENESIS_BLOCK_WITH_SIG='0100000000000000000000000000000000000000000000000000000000000000000000002b5331139c6bc8646bb4e5737c51378133f70b9712b75548cb3c05f9188670e7440d295e7300c5640730c4634402a3e66fb5d921f76b48d8972a484cc0361e66ef74f45e012103af80b90d25145da28c583359beb47b21796b2fe1a23c1511e443e7a64dfdb27d40e05f064662d6b9acf65ae416379d82e11a9b78cdeb3a316d1057cd2780e3727f70a61f901d10acbe349cd11e04aa6b4351e782c44670aefbe138e99a5ce75ace01010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff0100f2052a010000001976a91445d405b9ed450fec89044f9b7a99a4ef6fe2cd3f88ac00000000' tapyrus/tapyrusd:edge
+
+4. Modify the glueby configuration
+
+    ```ruby
+    # Use tapyrus dev network
+    Tapyrus.chain_params = :dev
+    Glueby.configure do |config|
+      config.wallet_adapter = :activerecord
+      # Modify rpc connection info in config/initializers/glueby.rb that is created in step 3.
+      config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'rpcuser', password: 'rpcpassword' }
+    end
+    ```
+
+5. Generate db migration files for wallet feature
+
+    These are essential if you use `config.wallet_adapter = :activerecord` configuration. 
+
+        $ rails g glueby:contract:block_syncer
+        $ rails g glueby:contract:wallet_adapter
 
-- [Timestamp](#Timestamp)
+    If you want to use reissuable token or timestamp, you need to do below generators.
 
-### Timestamp
+        $ rails g glueby:contract:reissuable_token
+        $ rails g glueby:contract:timestamp
+
+    Then, run the migrations.
+
+        $ rails db:migrate
+
+### Provide initial TPC (Tapyrus Coin) to wallets
+
+To use contracts, wallets need to have TPC and it can be provided from coinbase tx.
+
+1. Create a wallet and get receive address 
+
+    ```ruby
+    wallet = Glueby::Wallet.create
+    wallet.balances # => {}
+    address = wallet.internal_wallet.receive_address
+    puts address
+    ```
+
+2. Generate a block
+
+    Set an address you got in previous step to `[Your address]`
+
+        $ docker exec tapyrus_node_dev tapyrus-cli -conf=/etc/tapyrus/tapyrus.conf generatetoaddress 1 "[Your address]" "cUJN5RVzYWFoeY8rUztd47jzXCu1p57Ay8V7pqCzsBD3PEXN7Dd4"
+
+3. Sync blocks if you use `:activerecord` wallet adapter
+
+    You don't need to do this if you are using `:core` wallet_adapter.
+
+        $ rails glueby:contract:block_syncer:start
+
+   Here the wallet created in step 1 have 50 TPC and you can see like this:
+
+    ```ruby
+    wallet.balances # =>  {""=>5000000000}
+    ```
+
+    TPC amount is shown as tapyrus unit. 1 TPC = 100000000 tapyrus.
+
+## Timestamp
 
 ```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")
@@ -96,7 +203,7 @@ We can see the timestamp transaction using getrawblockchain command
 }
 ```
 
-#### Rails support
+### Rails support
 
 Glueby supports ruby on rails integration.
 
@@ -110,10 +217,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.
@@ -150,11 +259,110 @@ bin/rails glueby:contract:timestamp:create
 broadcasted (id=1, txid=8d602ca8ebdd50fa70b5ee6bc6351965b614d0a4843adacf9f43fedd7112fbf4)
 ```
 
-Run `glueby:contract:timestamp:confirm` task to confirm the transaction and update status(unconfirmed -> confirmded).
+Run `glueby:block_syncer:start` task to confirm the transaction and update status(unconfirmed -> confirmded).
+
+```
+bin/rails glueby:block_syncer:start
+```
+
+## 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
+Glueby.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.
 
 ```
-bin/rails glueby:contract:timestamp:confirm
-confirmed (id=1, txid=8d602ca8ebdd50fa70b5ee6bc6351965b614d0a4843adacf9f43fedd7112fbf4)
+$ 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

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

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

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

@@ -1,3 +1,5 @@
 # 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

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

@@ -1,15 +1,16 @@
 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
+      t.string     :label, index: true
       t.integer    :purpose
       t.belongs_to :wallet
       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

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