glueby 0.1.0 → 0.2.0

data/lib/glueby/internal/wallet/active_record_wallet_adapter.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Glueby
+  module Internal
+    class Wallet
+      # ActiveRecordWalletAdapter
+      #
+      # This class represents a wallet adapter that use Active Record to manage wallet and utxos.
+      # To use this wallet adapter, you should do the following steps:
+      #
+      # (1) Generate migrations for wallets, keys, utxos tables.
+      # The generator `glueby:contract:wallet_adapter` is available for migration.
+      # ```
+      # rails g glueby:contract:wallet_adapter
+      # ```
+      # this generator generates 3 files to create tables used by ActiveRecordWalletAdatper.
+      # then, migrate them
+      # ```
+      # $ rails db:migrate
+      # ```
+      #
+      # (2) Add configuration for activerecord
+      # ```
+      # config = {adapter: 'activerecord', schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass'}
+      # Glueby::Wallet.configure(config)
+      # ```
+      #
+      # (3) Generate wallet and receive address
+      # ```
+      # alice_wallet = Glueby::Wallet.create
+      # address = alice_wallet.internal_wallet.receive_address
+      # ```
+      # `Glueby::Internal::Wallet#receive_address` returns Base58 encoded Tapyrus address like '1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a'.
+      #
+      # (4) Send TPC to created address and import into wallet.
+      # In general, ActiveRecordWalletAdapter handle only utxos generated by glueby.
+      # So, to start to use wallet, some external utxo should be imported  into the wallet first.
+      # This step should be done by external transaction without Glueby::Wallet, such as 'sendtoaddress' or 'generatetoaddress' RPC command of Tapyrus Core
+      # ```
+      # $ tapyrus-cli sendtoaddress 1CY6TSSARn8rAFD9chCghX5B7j4PKR8S1a 1
+      # 1740af9f65ffd8537bdd06ccfa911bf1f4d6833222807d29c99d72b47838917d
+      # ```
+      #
+      # then, import into wallet by rake task `glueby:contract:wallet_adapter:import_tx` or `glueby:contract:wallet_adapter:import_block`
+      # ```
+      # $ rails "glueby:contract:wallet_adapter:import_tx[1740af9f65ffd8537bdd06ccfa911bf1f4d6833222807d29c99d72b47838917d]""
+      # ```
+      #
+      # (5) You are ready to use ActiveRecordWalletAdatper, check `Glueby::Internal::Wallet#list_unspent` or `Glueby::Wallet#balances`
+      # ```
+      # alice_wallet = Glueby::Wallet.create
+      # alice_wallet.balances
+      # ```
+      class ActiveRecordWalletAdapter < AbstractWalletAdapter
+        def create_wallet
+          wallet_id = SecureRandom.hex(16)
+          wallet = AR::Wallet.create(wallet_id: wallet_id)
+          wallet_id
+        end
+
+        def delete_wallet(wallet_id)
+          AR::Wallet.destroy_by(wallet_id: wallet_id)
+        end
+
+        def load_wallet(wallet_id)
+        end
+
+        def unload_wallet(wallet_id)
+        end
+
+        def wallets
+          AR::Wallet.all.map(&:wallet_id).sort
+        end
+
+        def balance(wallet_id, only_finalized = true)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          utxos = wallet.utxos
+          utxos = utxos.where(status: :finalized) if only_finalized
+          utxos.sum(&:value)
+        end
+
+        def list_unspent(wallet_id, only_finalized = true)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          utxos = wallet.utxos
+          utxos = utxos.where(status: :finalized) if only_finalized
+          utxos.map do |utxo|
+            {
+              txid: utxo.txid,
+              vout: utxo.index,
+              script_pubkey: utxo.script_pubkey,
+              color_id: utxo.color_id,
+              amount: utxo.value,
+              finalized: utxo.status == 'finalized'
+            }
+          end
+        end
+
+        def sign_tx(wallet_id, tx, prevtxs = [])
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          wallet.sign(tx, prevtxs)
+        end
+
+        def broadcast(wallet_id, tx)
+          ::ActiveRecord::Base.transaction do
+            AR::Utxo.destroy_for_inputs(tx)
+            AR::Utxo.create_or_update_for_outputs(tx, status: :broadcasted)
+            Glueby::Internal::RPC.client.sendrawtransaction(tx.to_hex)
+          end
+        end
+
+        def receive_address(wallet_id)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          key = wallet.keys.create(purpose: :receive)
+          key.address
+        end
+
+        def change_address(wallet_id)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          key = wallet.keys.create(purpose: :change)
+          key.address
+        end
+
+        def create_pubkey(wallet_id)
+          wallet = AR::Wallet.find_by(wallet_id: wallet_id)
+          key = wallet.keys.create(purpose: :receive)
+          Tapyrus::Key.new(pubkey: key.public_key)
+        end
+      end
+    end
+  end
+end

data/lib/glueby/internal/wallet/errors.rb

@@ -0,0 +1,11 @@
+module Glueby
+  module Internal
+    class Wallet
+      module Errors
+        class ShouldInitializeWalletAdapter < StandardError; end
+        class WalletUnloaded < StandardError; end
+        class WalletAlreadyLoaded < StandardError; end
+      end
+    end
+  end
+end

data/lib/glueby/internal/wallet/tapyrus_core_wallet_adapter.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'bigdecimal'
+
+module Glueby
+  module Internal
+    class Wallet
+      class TapyrusCoreWalletAdapter < AbstractWalletAdapter
+        module Util
+          module_function
+
+          # Convert TPC to tapyrus. 1 TPC is 10**8 tapyrus.
+          # @param [String] tpc
+          # @return [Integer] tapyrus
+          #
+          # Example) "0.00000010" to 10.
+          def tpc_to_tapyrus(tpc)
+            (BigDecimal(tpc) * 10**8).to_i
+          end
+        end
+
+        include Glueby::Internal::Wallet::TapyrusCoreWalletAdapter::Util
+
+        WALLET_PREFIX = 'wallet-'
+        ADDRESS_TYPE = 'legacy'
+
+        RPC_WALLET_ERROR_ERROR_CODE = -4 # Unspecified problem with wallet (key not found etc.)
+        RPC_WALLET_NOT_FOUND_ERROR_CODE = -18 # Invalid wallet specified
+
+        def create_wallet
+          wallet_id = SecureRandom.hex(16)
+          RPC.client.createwallet(wallet_name(wallet_id))
+          wallet_id
+        end
+
+        # On TapyrusCoreWallet, there are no way to delete real wallet via RPC.
+        # So, here just unload.
+        def delete_wallet(wallet_id)
+          unload_wallet(wallet_id)
+        end
+
+        def load_wallet(wallet_id)
+          RPC.client.loadwallet(wallet_name(wallet_id))
+        rescue RuntimeError => ex
+          json = JSON.parse(ex.message)
+          if json.is_a?(Hash) && json['code'] == RPC_WALLET_ERROR_ERROR_CODE && /Duplicate -wallet filename specified/ =~ ex.message
+            raise Errors::WalletAlreadyLoaded, "Wallet #{wallet_id} has been already loaded."
+          else
+            raise ex
+          end
+        end
+
+        def unload_wallet(wallet_id)
+          RPC.client.unloadwallet(wallet_name(wallet_id))
+        end
+
+        def wallets
+          RPC.client.listwallets.map do |wallet_name|
+            match = /\A#{WALLET_PREFIX}(?<wallet_id>[0-9A-Fa-f]{32})\z/.match(wallet_name)
+            next unless match
+
+            match[:wallet_id]
+          end.compact
+        end
+
+        def balance(wallet_id, only_finalized = true)
+          perform_as(wallet_id) do |client|
+            confirmed = tpc_to_tapyrus(client.getbalance)
+            return confirmed if only_finalized
+
+            confirmed + tpc_to_tapyrus(client.getunconfirmedbalance)
+          end
+        end
+
+        def list_unspent(wallet_id, only_finalized = true)
+          perform_as(wallet_id) do |client|
+            min_conf = only_finalized ? 1 : 0
+            res = client.listunspent(min_conf)
+
+            res.map do |i|
+              script = Tapyrus::Script.parse_from_payload(i['scriptPubKey'].htb)
+              color_id = if script.cp2pkh? || script.cp2sh?
+                Tapyrus::Color::ColorIdentifier.parse_from_payload(script.chunks[0].pushed_data).to_hex
+              end
+              {
+                txid: i['txid'],
+                vout: i['vout'],
+                script_pubkey: i['scriptPubKey'],
+                color_id: color_id,
+                amount: tpc_to_tapyrus(i['amount']),
+                finalized: i['confirmations'] != 0
+              }
+            end
+          end
+        end
+
+        def sign_tx(wallet_id, tx, prevtxs = [])
+          perform_as(wallet_id) do |client|
+            res = client.signrawtransactionwithwallet(tx.to_hex, prevtxs)
+            if res['complete']
+              Tapyrus::Tx.parse_from_payload(res['hex'].htb)
+            else
+              raise res['errors'].to_json
+            end
+          end
+        end
+
+        def broadcast(wallet_id, tx)
+          perform_as(wallet_id) do |client|
+            client.sendrawtransaction(tx.to_hex)
+          end
+        end
+
+        def receive_address(wallet_id)
+          perform_as(wallet_id) do |client|
+            client.getnewaddress('', ADDRESS_TYPE)
+          end
+        end
+
+        def change_address(wallet_id)
+          perform_as(wallet_id) do |client|
+            client.getrawchangeaddress(ADDRESS_TYPE)
+          end
+        end
+
+        def create_pubkey(wallet_id)
+          perform_as(wallet_id) do |client|
+            address = client.getnewaddress('', ADDRESS_TYPE)
+            info = client.getaddressinfo(address)
+            Tapyrus::Key.new(pubkey: info['pubkey'])
+          end
+        end
+
+        private
+
+        def perform_as(wallet_id)
+          RPC.perform_as(wallet_name(wallet_id)) do |client|
+            begin
+              yield(client)
+            rescue RuntimeError => ex
+              json = JSON.parse(ex.message)
+              if json.is_a?(Hash) && json['code'] == RPC_WALLET_NOT_FOUND_ERROR_CODE
+                raise Errors::WalletUnloaded, "The wallet #{wallet_id} is unloaded. You should load before use it."
+              else
+                raise ex
+              end
+            end
+          end
+        end
+
+        def wallet_name(wallet_id)
+          "#{WALLET_PREFIX}#{wallet_id}"
+        end
+      end
+    end
+  end
+end

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
 module Glueby
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/glueby/wallet.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Glueby
+  class Wallet
+    attr_reader :internal_wallet
+
+    class << self
+      def create
+        new(Glueby::Internal::Wallet.create)
+      end
+
+      def load(wallet_id)
+        new(Glueby::Internal::Wallet.load(wallet_id))
+      end
+
+      def configure(config)
+        case config[:adapter]
+        when 'core'
+          Glueby::Internal::RPC.configure(config)
+          Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::TapyrusCoreWalletAdapter.new
+        when 'activerecord'
+          Glueby::Internal::RPC.configure(config)
+          Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::ActiveRecordWalletAdapter.new
+        else
+          raise 'Not implemented'
+        end
+      end
+    end
+
+    def id
+      @internal_wallet.id
+    end
+
+    # @return [HashMap] hash of balances which key is color_id or empty string, and value is amount
+    def balances
+      utxos = @internal_wallet.list_unspent
+      utxos.inject({}) do |balances, output|
+        key = output[:color_id] || ''
+        balances[key] ||= 0
+        balances[key] += output[:amount]
+        balances
+      end
+    end
+
+    private
+
+    def initialize(internal_wallet)
+      @internal_wallet = internal_wallet
+    end
+  end
+end

data/lib/tasks/glueby/contract/timestamp.rake

@@ -11,12 +11,12 @@ module Glueby
           timestamps.each do |t|
             begin
               ::ActiveRecord::Base.transaction do
-                tx = create_tx(t.prefix, t.content_hash, Glueby::Contract::FixedFeeProvider.new)
-                signed_tx = sign_tx(tx)
-                t.update(txid: signed_tx.txid, status: :unconfirmed)
+                wallet = Glueby::Wallet.load(t.wallet_id)
+                tx = create_tx(wallet, t.prefix, t.content_hash, Glueby::Contract::FixedFeeProvider.new)
+                t.update(txid: tx.txid, status: :unconfirmed)
 
-                broadcast_tx(signed_tx)
-                puts "broadcasted (id=#{t.id}, txid=#{signed_tx.txid})"
+                wallet.internal_wallet.broadcast(tx)
+                puts "broadcasted (id=#{t.id}, txid=#{tx.txid})"
               end
             rescue => e
               puts "failed to broadcast (id=#{t.id}, reason=#{e.message})"

data/lib/tasks/glueby/contract/wallet_adapter.rake

@@ -0,0 +1,42 @@
+module Glueby
+  module Contract
+    module Task
+      module WalletAdapter
+        def import_block(block_hash)
+          block = Glueby::Internal::RPC.client.getblock(block_hash, 0)
+          block = Tapyrus::Block.parse_from_payload(block.htb)
+          block.transactions.each { |tx| import_tx(tx.txid) }
+        end
+
+        def import_tx(txid)
+          tx = Glueby::Internal::RPC.client.getrawtransaction(txid)
+          tx = Tapyrus::Tx.parse_from_payload(tx.htb)
+          Glueby::Internal::Wallet::AR::Utxo.destroy_for_inputs(tx)
+          Glueby::Internal::Wallet::AR::Utxo.create_or_update_for_outputs(tx)
+        end
+      end
+    end
+  end
+end
+
+namespace :glueby do
+  namespace :contract do
+    namespace :wallet_adapter do
+      include Glueby::Contract::Task::WalletAdapter
+
+      desc 'import block into database'
+      task :import_block, [:block_hash] => [:environment] do |_, args|
+        block_hash = args[:block_hash]
+
+        ::ActiveRecord::Base.transaction { import_block(block_hash) }
+      end
+
+      desc 'import transaction into database'
+      task :import_tx, [:txid] => [:environment] do |_, args|
+        txid = args[:txid]
+
+        ::ActiveRecord::Base.transaction { import_tx(txid) }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glueby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.6
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -72,22 +72,42 @@ files:
 - bin/console
 - bin/setup
 - glueby.gemspec
-- lib/generators/glueby/initializer_generator.rb
-- lib/generators/glueby/templates/initializer.rb.erb
-- lib/generators/glueby/templates/timestamp_table.rb.erb
-- lib/generators/glueby/timestamp_generator.rb
+- lib/generators/glueby/contract/initializer_generator.rb
+- lib/generators/glueby/contract/templates/initializer.rb.erb
+- lib/generators/glueby/contract/templates/key_table.rb.erb
+- lib/generators/glueby/contract/templates/timestamp_table.rb.erb
+- lib/generators/glueby/contract/templates/utxo_table.rb.erb
+- lib/generators/glueby/contract/templates/wallet_table.rb.erb
+- lib/generators/glueby/contract/timestamp_generator.rb
+- lib/generators/glueby/contract/wallet_adapter_generator.rb
 - lib/glueby.rb
 - lib/glueby/contract.rb
 - lib/glueby/contract/active_record.rb
 - lib/glueby/contract/active_record/timestamp.rb
 - lib/glueby/contract/errors.rb
 - lib/glueby/contract/fee_provider.rb
-- lib/glueby/contract/rpc.rb
+- lib/glueby/contract/payment.rb
 - lib/glueby/contract/timestamp.rb
+- lib/glueby/contract/token.rb
 - lib/glueby/contract/tx_builder.rb
+- lib/glueby/generator.rb
+- lib/glueby/generator/migrate_generator.rb
+- lib/glueby/internal.rb
+- lib/glueby/internal/rpc.rb
+- lib/glueby/internal/wallet.rb
+- lib/glueby/internal/wallet/abstract_wallet_adapter.rb
+- lib/glueby/internal/wallet/active_record.rb
+- lib/glueby/internal/wallet/active_record/key.rb
+- lib/glueby/internal/wallet/active_record/utxo.rb
+- lib/glueby/internal/wallet/active_record/wallet.rb
+- lib/glueby/internal/wallet/active_record_wallet_adapter.rb
+- lib/glueby/internal/wallet/errors.rb
+- lib/glueby/internal/wallet/tapyrus_core_wallet_adapter.rb
 - lib/glueby/version.rb
+- lib/glueby/wallet.rb
 - lib/tasks/glueby/contract.rake
 - lib/tasks/glueby/contract/timestamp.rake
+- lib/tasks/glueby/contract/wallet_adapter.rake
 homepage: https://github.com/chaintope/glueby
 licenses:
 - MIT
@@ -110,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A Ruby library of smart contracts that can be used on Tapyrus.