voilkruby 0.0.1

data/lib/voilkruby/mixins/acts_as_poster.rb

@@ -0,0 +1,124 @@
+module VoilkRuby
+  module Mixins
+    module ActsAsPoster
+      # Creates a post operation.
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     options = {
+      #       title: 'This is my fancy post title.',
+      #       body: 'This is my fancy post body.',
+      #       tags: %w(thess are my fancy tags)
+      #     }
+      #     voilk.post(options)
+      #     voilk.broadcast!
+      #
+      # @param options [::Hash] options
+      # @option options [String] :title Title of the post.
+      # @option options [String] :body Body of the post.
+      # @option options [::Array<String>] :tags Tags of the post.
+      # @option options [String] :permlink (automatic) Permlink of the post, defaults to formatted title.
+      # @option options [String] :parent_permlink (automatic) Parent permlink of the post, defaults to first tag.
+      # @option options [String] :parent_author (optional) Parent author of the post (only used if reply).
+      # @option options [String] :max_accepted_payout (1000000.000 VSD) Maximum accepted payout, set to '0.000 VSD' to deline payout
+      # @option options [Integer] :percent_voilk_dollars (5000) Percent VOILK Dollars is used to set 50/50 or 100% VOILK Power
+      # @option options [Integer] :allow_votes (true) Allow votes for this post.
+      # @option options [Integer] :allow_curation_rewards (true) Allow curation rewards for this post.
+      def post(options = {})
+        tags = [options[:tags] || []].flatten
+        title = options[:title].to_s
+        permlink = options[:permlink] || title.downcase.gsub(/[^a-z0-9\-]+/, '-')
+        parent_permlink = options[:parent_permlink] || tags[0]
+        
+        raise ChainError, 'At least one tag is required or set the parent_permlink directy.' if parent_permlink.nil?
+        
+        body = options[:body]
+        parent_author = options[:parent_author] || ''
+        max_accepted_payout = options[:max_accepted_payout] || default_max_acepted_payout
+        percent_voilk_dollars = options[:percent_voilk_dollars]
+        allow_votes = options[:allow_votes] || true
+        allow_curation_rewards = options[:allow_curation_rewards] || true
+        self_vote = options[:self_vote]
+        
+        tags.insert(0, parent_permlink)
+        tags = tags.compact.uniq
+        
+        metadata = {
+          app: VoilkRuby::AGENT_ID
+        }
+        metadata[:tags] = tags if tags.any?
+        
+        @operations << {
+          type: :comment,
+          parent_permlink: parent_permlink,
+          author: account_name,
+          permlink: permlink,
+          title: title,
+          body: body,
+          json_metadata: metadata.to_json,
+          parent_author: parent_author
+        }
+        
+        if (!!max_accepted_payout &&
+            max_accepted_payout != default_max_acepted_payout
+          ) || !!percent_voilk_dollars || !allow_votes || !allow_curation_rewards
+          @operations << {
+            type: :comment_options,
+            author: account_name,
+            permlink: permlink,
+            max_accepted_payout: max_accepted_payout,
+            percent_voilk_dollars: percent_voilk_dollars,
+            allow_votes: allow_votes,
+            allow_curation_rewards: allow_curation_rewards,
+            extensions: []
+          }
+        end
+        
+        vote(self_vote, account_name, permlink) if !!self_vote
+        
+        self
+      end
+      
+      # Create a vote operation and broadcasts it right away.
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     options = {
+      #       title: 'This is my fancy post title.',
+      #       body: 'This is my fancy post body.',
+      #       tags: %w(thess are my fancy tags)
+      #     }
+      #     voilk.post!(options)
+      #
+      # @see post
+      def post!(options = {}); post(options).broadcast!(true); end
+      
+      # Create a delete_comment operation.
+      #
+      # Examples:
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.delete_comment('permlink')
+      #     voilk.broadcast!
+      #
+      # @param permlink
+      def delete_comment(permlink)
+        @operations << {
+          type: :delete_comment,
+          author: account_name,
+          permlink: permlink
+        }
+        
+        self
+      end
+      
+      # Create a delete_comment operation and broadcasts it right away.
+      #
+      # Examples:
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.delete_comment!('permlink')
+      #
+      # @see delete_comment
+      def delete_comment!(permlink); delete_comment(permlink).broadcast!(true); end
+    end
+  end
+end

data/lib/voilkruby/mixins/acts_as_voter.rb

@@ -0,0 +1,50 @@
+module VoilkRuby
+  module Mixins
+    module ActsAsVoter
+      # Create a vote operation.
+      #
+      # Examples:
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.vote(10000, 'author', 'permlink')
+      #     voilk.broadcast!
+      #
+      # ... or ...
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.vote(10000, '@author/permlink')
+      #     voilk.broadcast!
+      #
+      # @param weight [Integer] value between -10000 and 10000.
+      # @param args [author, permlink || slug] pass either `author` and `permlink` or string containing both like `@author/permlink`.
+      def vote(weight, *args)
+        author, permlink = normalize_author_permlink(args)
+        
+        @operations << {
+          type: :vote,
+          voter: account_name,
+          author: author,
+          permlink: permlink,
+          weight: weight
+        }
+        
+        self
+      end
+      
+      # Create a vote operation and broadcasts it right away.
+      #
+      # Examples:
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.vote!(10000, 'author', 'permlink')
+      #
+      # ... or ...
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.vote!(10000, '@author/permlink')
+      #
+      # @see vote
+      def vote!(weight, *args); vote(weight, *args).broadcast!(true); end
+    end
+  end
+end

data/lib/voilkruby/mixins/acts_as_wallet.rb

@@ -0,0 +1,67 @@
+module VoilkRuby
+  module Mixins
+    module ActsAsWallet
+      # Create a claim_reward_balance operation.
+      #
+      # Examples:
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.claim_reward_balance(reward_vsd: '100.000 VSD')
+      #     voilk.broadcast!
+      #
+      # @param options [::Hash] options
+      # @option options [String] :reward_voilk The amount of VOILK to claim, like: `100.000 VOILK`
+      # @option options [String] :reward_vsd The amount of VSD to claim, like: `100.000 VSD`
+      # @option options [String] :reward_coins The amount of COINS to claim, like: `100.000000 COINS`
+      def claim_reward_balance(options)
+        reward_voilk = options[:reward_voilk] || '0.000 VOILK'
+        reward_vsd = options[:reward_vsd] || '0.000 VSD'
+        reward_coins = options[:reward_coins] || '0.000000 COINS'
+        
+        @operations << {
+          type: :claim_reward_balance,
+          account: account_name,
+          reward_voilk: reward_voilk,
+          reward_vsd: reward_vsd,
+          reward_coins: reward_coins
+        }
+        
+        self
+      end
+      
+      # Create a claim_reward_balance operation and broadcasts it right away.
+      #
+      # Examples:
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.claim_reward_balance!(reward_vsd: '100.000 VSD')
+      #
+      # @see claim_reward_balance
+      def claim_reward_balance!(permlink); claim_reward_balance(permlink).broadcast!(true); end
+      
+      # Create a transfer operation.
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your active wif')
+      #     voilk.transfer(amount: '1.000 VSD', to: 'account name', memo: 'this is a memo')
+      #     voilk.broadcast!
+      #
+      # @param options [::Hash] options
+      # @option options [String] :amount The amount to transfer, like: `100.000 VOILK`
+      # @option options [String] :to The account receiving the transfer.
+      # @option options [String] :memo ('') The memo for the transfer.
+      def transfer(options = {})
+        @operations << options.merge(type: :transfer, from: account_name)
+        
+        self
+      end
+      
+      # Create a transfer operation and broadcasts it right away.
+      #
+      #     voilk = VoilkRuby::Chain.new(chain: :voilk, account_name: 'your account name', wif: 'your wif')
+      #     voilk.transfer!(amount: '1.000 VSD', to: 'account name', memo: 'this is a memo')
+      #
+      # @see transfer
+      def transfer!(options = {}); transfer(options).broadcast!(true); end
+    end
+  end
+end

data/lib/voilkruby/network_broadcast_api.rb

@@ -0,0 +1,7 @@
+module VoilkRuby
+  class NetworkBroadcastApi < Api
+    def api_name
+      :network_broadcast_api
+    end
+  end
+end

data/lib/voilkruby/operation.rb

@@ -0,0 +1,101 @@
+module VoilkRuby
+  class Operation
+    include OperationIds
+    include OperationTypes
+    include Utils
+    
+    def initialize(options = {})
+      opt = options.dup
+      @type = opt.delete(:type)
+      
+      opt.each do |k, v|
+        instance_variable_set("@#{k}", type(@type, k, v))
+      end
+      
+      @use_condenser_namespace = if options.keys.include? :use_condenser_namespace
+        options.delete(:use_condenser_namespace)
+      else
+        true
+      end
+      
+      unless Operation::known_operation_names.include? @type
+        raise OperationError, "Unsupported operation type: #{@type}"
+      end
+    end
+    
+    def to_bytes
+      bytes = [id(@type.to_sym)].pack('C')
+      
+      Operation::param_names(@type.to_sym).each do |p|
+        next unless defined? p
+        
+        v = instance_variable_get("@#{p}")
+        bytes += v.to_bytes and next if v.respond_to? :to_bytes
+        
+        bytes += case v
+        when Symbol then pakStr(v.to_s)
+        when String then pakStr(v)
+        when Integer then paks(v)
+        when TrueClass then pakC(1)
+        when FalseClass then pakC(0)
+        when ::Array then pakArr(v)
+        when ::Hash then pakHash(v)
+        when NilClass then next
+        else
+          raise OperationError, "Unsupported type: #{v.class}"
+        end
+      end
+      
+      bytes
+    end
+    
+    def payload
+      params = {}
+      
+      Operation::param_names(@type.to_sym).each do |p|
+        next unless defined? p
+        
+        v = instance_variable_get("@#{p}")
+        next if v.nil?
+        next if v.class == VoilkRuby::Type::Future
+        
+        params[p] = case v
+        when VoilkRuby::Type::Beneficiaries then [[0, v.to_h]]
+        when VoilkRuby::Type::Amount
+          if use_condenser_namespace?
+            v.to_s
+          else
+            v.to_a
+          end
+        else; v
+        end
+      end
+      
+      [@type, params]
+    end
+  private
+    def self.broadcast_operations_json_path
+      @broadcast_operations_json_path ||= "#{File.dirname(__FILE__)}/broadcast_operations.json"
+    end
+    
+    def self.broadcast_operations
+      @broadcast_operations ||= JSON[File.read broadcast_operations_json_path]
+    end
+
+    def self.known_operation_names
+      broadcast_operations.map { |op| op["operation"].to_sym }
+    end
+    
+    def self.param_names(type)
+      broadcast_operations.each do |op|
+        if op['operation'].to_sym == type.to_sym
+          return op['params'].map(&:to_sym)
+        end
+      end
+    end
+    
+    def use_condenser_namespace?
+      @use_condenser_namespace
+    end    
+  end
+end

data/lib/voilkruby/operation_ids.rb

@@ -0,0 +1,98 @@
+module VoilkRuby
+  module OperationIds
+    # These IDS are derrived from:
+    # https://github.com/voilknetwork/voilk/blob/127a441fbac2f06804359968bda83b66e602c891/libraries/protocol/include/voilk/protocol/operations.hpp
+    
+    IDS = [
+      :vote_operation,
+      :comment_operation,
+      
+      :transfer_operation,
+      :transfer_to_coining_operation,
+      :withdraw_coining_operation,
+      
+      :limit_order_create_operation,
+      :limit_order_cancel_operation,
+      
+      :feed_publish_operation,
+      :convert_operation,
+      
+      :account_create_operation,
+      :account_update_operation,
+      
+      :witness_update_operation,
+      :account_witness_vote_operation,
+      :account_witness_proxy_operation,
+      
+      :pow_operation,
+      
+      :custom_operation,
+      
+      :report_over_production_operation,
+      
+      :delete_comment_operation,
+      :custom_json_operation,
+      :comment_options_operation,
+      :set_withdraw_coining_route_operation,
+      :limit_order_create2_operation,
+      :claim_account_operation,
+      :create_claimed_account_operation,
+      :request_account_recovery_operation,
+      :recover_account_operation,
+      :change_recovery_account_operation,
+      :escrow_transfer_operation,
+      :escrow_dispute_operation,
+      :escrow_release_operation,
+      :pow2_operation,
+      :escrow_approve_operation,
+      :transfer_to_savings_operation,
+      :transfer_from_savings_operation,
+      :cancel_transfer_from_savings_operation,
+      :custom_binary_operation,
+      :decline_voting_rights_operation,
+      :reset_account_operation,
+      :set_reset_account_operation,
+      :claim_reward_balance_operation,
+      :delegate_coining_shares_operation,
+      :account_create_with_delegation_operation,
+      :witness_set_properties_operation,
+      
+      # SMT operations
+      :claim_reward_balance2_operation,
+      
+      :smt_setup_operation,
+      :smt_cap_reveal_operation,
+      :smt_refund_operation,
+      :smt_setup_emissions_operation,
+      :smt_set_setup_parameters_operation,
+      :smt_set_runtime_parameters_operation,
+      :smt_create_operation,
+      
+      # virtual operations below this point
+      :fill_convert_request_operation,
+      :author_reward_operation,
+      :curation_reward_operation,
+      :comment_reward_operation,
+      :liquidity_reward_operation,
+      :interest_operation,
+      :fill_coining_withdraw_operation,
+      :fill_order_operation,
+      :shutdown_witness_operation,
+      :fill_transfer_from_savings_operation,
+      :hardfork_operation,
+      :comment_payout_update_operation,
+      :return_coining_delegation_operation,
+      :comment_benefactor_reward_operation,
+      :producer_reward_operation,
+      :clear_null_account_balance_operation
+    ]
+    
+    def id(op)
+      if op.to_s =~ /_operation$/
+        IDS.find_index op
+      else
+        IDS.find_index "#{op}_operation".to_sym
+      end
+    end
+  end
+end