bytom 1.0.1

data/lib/bytom/api/address.rb

@@ -0,0 +1,66 @@
+module Bytom
+  class Address
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Returns the sub list of all available addresses by account.
+    # 
+    # @param [String] account_alias
+    # @param [String] account_id
+    # @param [Fixnum] from
+    # @param [Fixnum] count
+    #
+    # @return [Hash]
+    #
+    def list_addresses(account_alias:, account_id:, from: 0, count:)
+      params = {
+          account_alias: account_alias,
+          account_id: account_id,
+          from: from,
+          count: count
+      }
+      client.make_request('/list-addresses', 'post', params: params)
+    end
+
+    ##
+    # Verify the address is valid, and judge the address is own.
+    #
+    # @param [String] address
+    #
+    # @return [Hash]
+    #
+    def validate_address(address:)
+      params = {
+          address:  address
+      }
+      client.make_request('/validate-address', 'post', params: params)
+    end
+
+    ##
+    # Query the current mining address.
+    #
+    def get_mining_address
+      client.make_request('/get-mining-address', 'post', params: {})
+    end
+
+    ##
+    # Set the current mining address, no matter whethere the address is a local one. It returns an error message if the address format is incorrect.
+    #
+    # @param [String] mining_address
+    #
+    # @return [Hash]
+    #
+    def set_mining_address(mining_address:)
+      params = {
+          mining_address: mining_address
+      }
+      client.make_request('/set-mining-address', 'post', params: params)
+    end
+
+  end
+end

data/lib/bytom/api/asset.rb

@@ -0,0 +1,63 @@
+module Bytom
+  class Asset
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Create asset definition, it prepares for the issuance of asset.
+    #
+    # @param [String] alias_name
+    # @param [Hash] definition
+    # @param [Array] root_xpubs
+    # @param [Fixnum] quorum
+    # @param [String] issuance_program
+    #
+    # @return [Hash]
+    #
+    def create_asset(alias_name:, definition: {}, root_xpubs: [], quorum: 1, issuance_program: nil)
+      params = {
+          alias: alias_name,
+          definition: definition,
+      }
+      params.merge!(issuance_program: issuance_program) if issuance_program
+      params.merge!(root_xpubs: root_xpubs, quorum: quorum) if not root_xpubs.empty?
+      client.make_request('/create-asset', 'post', params: params)
+    end
+
+    ##
+    # Query detail asset by asset ID.
+    #
+    # @param [String] id
+    #
+    def get_asset(id:)
+      params = {
+          id: id
+      }
+      client.make_request('/get-asset', 'post', params: params)
+    end
+    ##
+    # Returns the list of all available assets.
+    #
+    def list_assets
+      client.make_request('/list-assets', 'post', params: {})
+    end
+
+    ##
+    # Update asset alias by assetID.
+    #
+    # @param [String] id
+    # @param [String] alias_name
+    #
+    def update_asset_alias(id:, alias_name:)
+      params = {
+          id: id,
+          alias: alias_name
+      }
+      client.make_request('/update-asset-alias', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/balances.rb

@@ -0,0 +1,22 @@
+module Bytom
+  class Balances
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+    ##
+    # Returns the list of all available account balances.
+    #
+    # @param [String] account_id
+    # @param [String] account_alias
+    #
+    def list_balances(account_id: nil, account_alias: nil)
+      params = {}
+      params.merge!(account_id: account_id) if account_id
+      params.merge!(account_alias: account_alias) if account_alias
+      client.make_request('/list-balances', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/block.rb

@@ -0,0 +1,76 @@
+module Bytom
+  class Block
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_block_count
+      client.make_request('/get-block-count', 'post', params: {})
+    end
+    ##
+    # Returns the current block hash for blockchain.
+    #
+    def get_block_hash
+      client.make_request('/get-block-hash', 'post', params: {})
+    end
+
+    ##
+    # Returns the detail block by block height or block hash.
+    #
+    # @param [String] block_height optional
+    # @param [String] block_hash optional
+    #
+    def get_block(block_height: nil, block_hash: nil)
+      params = {
+          block_height: block_height,
+          block_hash: block_hash
+      }
+      client.make_request('/get-block', 'post', params: params)
+    end
+
+    ##
+    # Returns the detail block header by block height or block hash.
+    #
+    # @param [String] block_height optional
+    # @param [String] block_hash optional
+    #
+    def get_block_header(block_height: nil, block_hash: nil)
+      params = {
+          block_height: block_height,
+          block_hash: block_hash
+      }
+      client.make_request('/get-block-header', 'post', params: params)
+    end
+
+    ##
+    # Returns the block difficulty by block height or block hash.
+    #
+    # @param [String] block_height optional
+    # @param [String] block_hash optional
+    #
+    def get_difficulty(block_height: nil, block_hash: nil)
+      params = {
+          block_height: block_height,
+          block_hash: block_hash
+      }
+      client.make_request('/get-difficulty', 'post', params: params)
+    end
+
+    ##
+    # Returns the block hash rate by block height or block hash, it returns the current block hash rate when request is empty.
+    # 
+    # @param [String] block_height optional
+    # @param [String] block_hash optional
+    #
+    def get_hash_rate(block_height: nil, block_hash: nil)
+      params = {
+          block_height: block_height,
+          block_hash: block_hash
+      }
+      client.make_request('/get-hash-rate', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/coinbase.rb

@@ -0,0 +1,31 @@
+module Bytom
+  class Coinbase
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Get coinbase arbitrary.
+    #
+    def get_coinbase_arbitrary(params: {})
+      client.make_request('/get-coinbase-arbitrary', 'post', params: params)
+    end
+
+    ##
+    # Set coinbase arbitrary.
+    #
+    # @param [String] arbitrary
+    #
+    # @return [Hash] the abitrary data being appended to coinbase, in hexdecimal format. (The full coinbase data for a block will be `0x00`&block_height&abitrary.)
+    #
+    def set_coinbase_arbitrary(arbitrary:)
+      params = {
+          arbitrary: arbitrary
+      }
+      client.make_request('/set-coinbase-arbitrary', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/core_config.rb

@@ -0,0 +1,38 @@
+module Bytom
+  class CoreConfig
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Returns the information of current network node.
+    #
+    def net_info
+      client.make_request('/net-info', 'post', params: {})
+    end
+
+    def gas_rate
+      client.make_request('/gas-rate', 'post', params: {})
+    end
+
+    ##
+    # Returns the mining status.
+    #
+    def is_mining
+      client.make_request('/is-mining', 'post', params: {})
+    end
+
+    ##
+    # Start up node mining.
+    #
+    def set_mining(is_mining: true)
+      client.make_request('/set-mining', 'post', params: {is_mining: is_mining})
+    end
+
+
+
+  end
+end

data/lib/bytom/api/keys.rb

@@ -0,0 +1,124 @@
+module Bytom
+  class Keys
+
+    attr_reader :client
+    private :client
+
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # It is to create private key essentially, returns the information of key. The private key is encrypted in the file and not visible to the user.
+    #
+    # @param [string] alias_name the filed alias is a keyword in ruby. so use alias_name to map.
+    # @param [string] password
+    # @param [string] language
+    # @param [string] mnemonic Optional
+    #
+    # @return [Hash]
+    #
+    def create_key(alias_name:, password:, language: 'en', mnemonic: nil)
+      params = {
+          alias: alias_name,
+          password: password,
+          language: language,
+          mnemonic: nil
+      }
+      client.make_request('/create-key', 'post', params: params)
+    end
+
+    ##
+    # Returns the list of all available keys.
+    #
+    # @return [Hash]
+    #
+    def list_keys
+      client.make_request('/list-keys', 'get')
+    end
+
+    ##
+    # Update alias for the existed key.
+    # 
+    # @param [string] xpub
+    # @param [string] new_alias
+    #
+    # @return [nil]
+    #
+    def update_key_alias(xpub:, new_alias:)
+      params = {
+          xpub: xpub,
+          new_alias: new_alias
+      }
+      client.make_request('/update-key-alias', 'post', params: params)
+    end
+  
+    ##
+    # Delete existed key, please make sure that there is no balance in the related accounts.
+    #
+    # @param [string] xpub
+    # @param [string] password
+    #
+    # @return [nil]
+    #
+    def delete_key(xpub:, password:)
+      params = {
+          xpub: xpub,
+          password: password
+      }
+      client.make_request('/delete-key', 'post', params: params)
+    end
+
+    ##
+    # Check key password.
+    #
+    # @param [string] xpub
+    # @param [string] password
+    #
+    # @return [Hash]  check_result, result of check key password, true is check successfully, otherwise is false.
+    #
+    def check_key_password(xpub:, password:)
+      params = {
+          xpub: xpub,
+          password: password
+      }
+      client.make_request('/check-key-password', 'post', params: params)
+    end
+
+    ##
+    # Reset key password.
+    #
+    # @param [string] xpub
+    # @param [string] old_password
+    # @param [string] new_password
+    #
+    # @return [Hash] changed, result of reset key password, true is reset successfully, otherwise is false.
+    #
+    def reset_key_password(xpub:, old_password:, new_password:)
+      params = {
+          xpub: xpub,
+          old_password: old_password,
+          new_password: new_password
+      }
+      client.make_request('/reset-key-password', 'post', params: params)
+    end
+
+    ##
+    # Returns the list of all available pubkeys by account.
+    #
+    # @param [String] account_alias optional
+    # @param [String] account_id optional
+    # @param [String] public_keyoptional
+    #
+    # @return [Hash]
+    #
+    def list_pubkeys(account_alias: nil, account_id: nil, public_key: nil)
+      params = {}
+      params = {account_alias: account_alias} if account_alias
+      params = {account_id: account_id} if account_id
+      #params = {public_key: public_key} if public_key
+      client.make_request('/list-pubkeys', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/message.rb

@@ -0,0 +1,48 @@
+module Bytom
+  class Message
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Verify a signed message with derived pubkey of the address.
+    #
+    # @param [String] address
+    # @param [String] derived_xpub
+    # @param [String] message
+    # @param [String] signature
+    #
+    def verify_message(address:, derived_xpub:, message:, signature:)
+      params = {
+          address: address,
+          derived_xpub: derived_xpub,
+          message: message,
+          signature: signature
+      }
+      client.make_request('/verify-message', 'post', params: params)
+    end
+
+    ##
+    # Sign a message with the key password(decode encrypted private key) of an address.
+    #
+    # @param [String] address
+    # @param [String] message
+    # @param [String] password
+    #
+    # @return [Hash] signature, derived_xpub
+    #
+    def sign_message(address:, message:, password:)
+      params = {
+          address: address,
+          message: message,
+          password: password
+      }
+      p params
+      client.make_request('/sign-message', 'post', params: params)
+    end
+
+  end
+end