steem-ruby 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25b2e7d4eb5445c89b02aac685677e49a0c551c8
-  data.tar.gz: 9b5f21517af8ea96a85c751d0a470463cff09ea7
+SHA256:
+  metadata.gz: 57f84dd9185bb2ad616730cb370450ff56816706a8ad5b26d452bf3a7921cd68
+  data.tar.gz: 59934f9af8d4e20da692c06b9d8b55b71c54aaead980bec892c400ef100cc77c
 SHA512:
-  metadata.gz: d960cab6d69f53dc73366084c85bb98ca4534829f225306125ca517b4adb391d108483836be355659d32143058daa19b7fa2685bfa4dd2a8b192677cb786e272
-  data.tar.gz: ba077e084d71823040fb8470aa5793439356f8d7002da3763b60a4c4939d3655ff78a41ae920a98a8b15709a035b1c0ef9f39a296207675f296213201f2fbb6c
+  metadata.gz: f909db06bc8e7db70da6180d385e0527e6153134b2535e275e6864f9c21511506bb93ae685fee51187024819dd9ad243939efa88213f29af8b51d28c6826290b
+  data.tar.gz: 1b9d47fbb3775b639c53fc767f4a71a7d19578ca848f9f196ce1fd53ffe09d2b4eabc90ce70404a9deb523b448d0e2c70ceff53f2058b708e1b9d6be7dd983a2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steem-ruby (0.9.2)
+    steem-ruby (0.9.3)
       bitcoin-ruby (~> 0.0, >= 0.0.18)
       ffi (~> 1.9, >= 1.9.23)
       hashie (~> 3.5, >= 3.5.7)
@@ -21,7 +21,7 @@ GEM
     docile (1.3.1)
     ffi (1.9.25)
     hashdiff (0.3.7)
-    hashie (3.5.7)
+    hashie (3.6.0)
     json (2.1.0)
     little-plugger (1.1.4)
     logging (2.2.2)
@@ -70,4 +70,4 @@ DEPENDENCIES
   yard (~> 0.9, >= 0.9.12)
 
 BUNDLED WITH
-   1.16.1
+   1.16.5

data/lib/steem/api.rb

@@ -70,9 +70,24 @@ module Steem
       end
     end
     
-    # Override this if you want to use your own client.
+    # Override this if you want to just use your own client.  Otherwise, inject
+    # the default using:
+    #
+    #     Steem::Api.register default_rpc_client_class: MyClient
     def self.default_rpc_client_class
-      DEFAULT_RPC_CLIENT_CLASS
+      if !!@injected_dependencies && !!@injected_dependencies[:default_rpc_client_class]
+        @injected_dependencies[:default_rpc_client_class]
+      else
+        DEFAULT_RPC_CLIENT_CLASS
+      end
+    end
+    
+    # Used for dependency injection.  Currently, the only key supported is:
+    # 
+    # `default_rpc_client_class`
+    def self.register(register)
+      @injected_dependencies ||= {}
+      @injected_dependencies = @injected_dependencies.merge register
     end
     
     def initialize(options = {})

data/lib/steem/broadcast.rb

@@ -31,6 +31,7 @@ module Steem
   # For details on what to pass to these methods, check out the {https://developers.steem.io/apidefinitions/broadcast-ops Steem Developer Portal Broadcast Operations} page.
   class Broadcast
     extend Retriable
+    extend Utils
     
     DEFAULT_MAX_ACCEPTED_PAYOUT = Type::Amount.new(amount: '1000000000', precision: 3, nai: '@@000000013')
     
@@ -509,6 +510,68 @@ module Steem
       process(options.merge(ops: ops), &block)
     end
     
+    # Create a claimed account.
+    #     options = {
+    #       wif: wif,
+    #       params: {
+    #         creator: creator_account_name,
+    #         new_account_name: new_account_name,
+    #         owner: {
+    #           weight_threshold: 1,
+    #           account_auths: [],
+    #           key_auths: [[owner_public_key, 1]],
+    #         },
+    #         active: {
+    #           weight_threshold: 1,
+    #           account_auths: [],
+    #           key_auths: [[active_public_key, 1]],
+    #         },
+    #         posting: {
+    #           weight_threshold: 1,
+    #           account_auths: [],
+    #           key_auths: [[posting_public_key, 1]],
+    #         },
+    #         memo_key: memo_public_key,
+    #         json_metadata: '{}'
+    #       }
+    #     }
+    # 
+    #     Steem::Broadcast.create_claimed_account(options)
+    # 
+    # @param options [Hash] options
+    # @option options [String] :wif Active wif
+    # @option options [Hash] :params
+    #   * :creator (String)
+    #   * :new_account_name (String)
+    #   * :owner (Hash)
+    #   * :active (Hash)
+    #   * :posting (Hash)
+    #   * :memo_key (String)
+    #   * :metadata (Hash) Metadata of the account, becomes `json_metadata`.
+    #   * :json_metadata (String) String version of `metadata` (use one or the other).
+    #   * :extensions (Array) (optional)
+    # @option options [Boolean] :pretend Just validate, do not broadcast.
+    # @see https://developers.steem.io/apidefinitions/broadcast-ops#broadcast_ops_create_claimed_account
+    def self.create_claimed_account(options, &block)
+      required_fields = %i(creator new_account_name owner active posting memo_key json_metadata)
+      params = options[:params]
+      
+      if !!params[:metadata] && !!params[:json_metadata]
+        raise Steem::ArgumentError, 'Assign either metadata or json_metadata, not both.'
+      end
+      
+      metadata = params.delete(:metadata) || {}
+      metadata ||= (JSON[params[:json_metadata]] || nil) || {}
+      params[:json_metadata] = metadata.to_json
+      
+      check_required_fields(params, *required_fields)
+      
+      params[:extensions] ||= []
+      ops = [[:account_create, params]]
+      
+      process(options.merge(ops: ops), &block)
+    end
+    
     # Update an account.
     #     options = {
     #       wif: wif,
@@ -611,6 +674,65 @@ module Steem
       process(options.merge(ops: ops), &block)
     end
     
+    # Extensible replacement for #witness_update that supports additional
+    # properties added since HF20 and beyond.
+    #
+    #     options = {
+    #       wif: wif,
+    #       params: {
+    #         owner: witness_account_name,
+    #         props: {
+    #           account_creation_fee: '0.000 STEEM',
+    #           maximum_block_size: 131072,
+    #           sbd_interest_rate: 1000,
+    #           account_subsidy_budget: 50000,
+    #           account_subsidy_decay: 330782,
+    #           sbd_exchange_rate: '1.000 STEEM',
+    #           url: "https://steemit.com",
+    #           new_signing_key: 'STM8LoQjQqJHvotqBo7HjnqmUbFW9oJ2theyqonzUd9DdJ7YYHsvD'
+    #         }
+    #       }
+    #     }
+    # 
+    #     Steem::Broadcast.witness_set_properties(options)
+    #
+    # @param options [Hash] options
+    # @option options [String] :wif Active wif
+    # @option options [Hash] :params
+    #   * :owner (String)
+    #   * :props (String)
+    # @option options [Boolean] :pretend Just validate, do not broadcast.
+    # @see https://developers.steem.io/apidefinitions/broadcast-ops#broadcast_ops_witness_set_properties
+    # @see https://github.com/steemit/steem/blob/master/doc/witness_parameters.md
+    def self.witness_set_properties(options, &block)
+      required_fields = %i(owner props)
+      params = options[:params]
+      check_required_fields(params, *required_fields)
+      
+      if !!(account_creation_fee = params[:props][:account_creation_fee] rescue nil)
+        params[:props][:account_creation_fee] = normalize_amount(options.merge amount: account_creation_fee, serialize: true)
+      end
+      
+      if !!(sbd_exchange_rate = params[:props][:sbd_exchange_rate] rescue nil)
+        params[:props][:sbd_exchange_rate] = normalize_amount(options.merge amount: sbd_exchange_rate, serialize: true)
+      end
+      
+      %i(account_creation_fee sbd_exchange_rate url new_signing_key).each do |key|
+        next unless !!params[:props][key]
+        
+        val = params[:props][key]
+          
+        params[:props][key] = hexlify val unless val =~ /^[0-9A-F]+$/i
+      end
+      
+      params[:props] = params[:props].to_a
+      
+      params[:extensions] ||= []
+      ops = [[:witness_set_properties, params]]
+      
+      process(options.merge(ops: ops), &block)
+    end
+    
     # All accounts with a VFS (Vesting Fund Shares) can vote for or against any
     # witness.
     # 
@@ -1084,6 +1206,28 @@ module Steem
       process(options.merge(ops: ops), &block)
     end
     
+    # @param options [Hash] options
+    # @option options [String] :wif Active wif
+    # @option options [Hash] :params
+    #   * :creator (String)
+    #   * :fee (String)
+    #   * :extensions (Array)
+    # @option options [Boolean] :pretend Just validate, do not broadcast.
+    # @see https://developers.steem.io/apidefinitions/broadcast-ops#broadcast_ops_claim_account
+    def self.claim_account(options, &block)
+      required_fields = %i(creator fee)
+      params = options[:params]
+      
+      check_required_fields(params, *required_fields)
+      
+      params[:fee] = normalize_amount(options.merge amount: params[:fee])
+      params[:extensions] ||= []
+      
+      ops = [[:claim_account, params]]
+      
+      process(options.merge(ops: ops), &block)
+    end
+        
     # @param options [Hash] options
     # @option options [Array<Array<Hash>] :ops Operations to process.
     # @option options [Boolean] :pretend Just validate, do not broadcast.
@@ -1131,6 +1275,8 @@ module Steem
     def self.normalize_amount(options)
       if !!options[:app_base]
         Type::Amount.to_h(options[:amount])
+      elsif !!options[:serialize]
+        Type::Amount.to_s(options[:amount])
       else
         Type::Amount.to_s(options[:amount])
       end

data/lib/steem/transaction_builder.rb

@@ -28,9 +28,10 @@ module Steem
     
     attr_accessor :app_base, :database_api, :block_api, :expiration, :operations
     attr_writer :wif
-    attr_reader :signed
+    attr_reader :signed, :testnet
     
     alias app_base? app_base
+    alias testnet? testnet
     
     def initialize(options = {})
       @app_base = !!options[:app_base] # default false
@@ -47,6 +48,7 @@ module Steem
       
       @wif = [options[:wif]].flatten
       @signed = false
+      @testnet = !!options[:testnet]
       
       if !!(trx = options[:trx])
         trx = case trx
@@ -78,11 +80,16 @@ module Steem
       @signatures = options[:signatures] || []
       @chain = options[:chain] || :steem
       @error_pipe = options[:error_pipe] || STDERR
-      @chain_id = case @chain
+      @chain_id = options[:chain_id]
+      @chain_id ||= case @chain
       when :steem then NETWORKS_STEEM_CHAIN_ID
       when :test then NETWORKS_TEST_CHAIN_ID
       else; raise UnsupportedChainError, "Unsupported chain: #{@chain}"
       end
+      
+      if testnet? && @chain_id == NETWORKS_STEEM_CHAIN_ID
+        raise UnsupportedChainError, "Unsupported testnet chain id: #{@chain_id}"
+      end
     end
     
     def inspect

data/lib/steem/type/amount.rb

@@ -13,6 +13,10 @@ module Steem
         new(amount).to_s
       end
       
+      def self.to_bytes(amount)
+        new(amount).to_bytes
+      end
+      
       def initialize(value)
         super(:amount, value)
         

data/lib/steem/version.rb

@@ -1,4 +1,4 @@
 module Steem
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
   AGENT_ID = "steem-ruby/#{VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steem-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Anthony Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -385,7 +385,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Steem Ruby Client