bytom 1.0.1

data/lib/bytom/api/other.rb

@@ -0,0 +1,56 @@
+module Bytom
+  class Other
+
+    attr_reader :client
+    private :client
+
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Decode program.
+    #
+    # @param [String] program
+    #
+    def decode_program(program:)
+      client.make_request('/decode-program', 'post', params: {program: program})
+    end
+
+    ##
+    # Compile equity contract.
+    #
+    def compile(contract:, args: [])
+      params = {
+          contract: contract,
+          args: args
+      }
+      client.make_request('/compile', 'post', params: params)
+    end
+
+    ##
+    # Returns the sub list of all available unspent outputs for all accounts in your wallet.
+    #
+    # @param [String] id
+    # @param [Boolean] unconfirmed
+    # @param [Boolean] smart_contract
+    # @param [Fixnum] from
+    # @param [Fixnum] count
+    # @param [String] account_id
+    # @param [String] account_alias
+    #
+    def list_unspent_outputs(id: nil, unconfirmed: nil, smart_contract: nil, from: nil, count: nil, account_id: nil, account_alias: nil)
+      params = {
+          id: id,
+          unconfirmed: unconfirmed,
+          smart_contract: smart_contract,
+          from: from,
+          count: count,
+          account_id: account_id,
+          account_alias: account_alias
+      }
+      client.make_request('/list-unspent-outputs', 'post', params: params)
+    end
+  end
+end

data/lib/bytom/api/peer.rb

@@ -0,0 +1,42 @@
+module Bytom
+  class Peer
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Returns the list of connected peers.
+    #
+    def list_peers
+      client.make_request('/list-peers', 'post', params: {})
+    end
+
+    ##
+    # Disconnect to specified peer.
+    #
+    # @param [String] peer_id
+    #
+    def disconnect_peer(peer_id:)
+      client.make_request('/disconnect-peer', 'post', params: {peer_id: peer_id})
+    end
+
+    ##
+    # Connect to specified peer.
+    #
+    # @param [String] ip peer IP address.
+    # @param [Fixnum] port peer port.
+    #
+    def connect_peer(ip:, port:)
+      params = {
+          ip: ip,
+          port: port
+      }
+      client.make_request('/connect-peer', 'post', params: params)
+    end
+
+  end
+end
+

data/lib/bytom/api/transactions.rb

@@ -0,0 +1,210 @@
+module Bytom
+  class Transactions
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Query the account related transaction by transaction ID.
+    #
+    # @param [String] tx_id transaction id, hash of transaction.
+    #
+    def get_transaction(tx_id:)
+      client.make_request('/get-transaction', 'post', params: {tx_id: tx_id})
+    end
+
+    ##
+    # Returns the sub list of all the account related transactions.
+    #
+    # @param [String] id
+    # @param [String] account_id
+    # @param [Boolean] detail
+    # @param [OBoolean unconfirmed
+    # @param [Fixnum] from
+    # @param [Fixnum] count
+    #
+    def list_transactions(id: nil, account_id: nil, detail: nil, unconfirmed: nil, from: nil, count: nil)
+      params = {
+          id: id,
+          account_id: account_id,
+          detail: detail,
+          unconfirmed: unconfirmed,
+          from: from,
+          count: count
+      }
+      client.make_request('/list-transactions', 'post', params: params)
+    end
+
+    ##
+    # Build transaction.
+    #
+    # @param [String] base_transaction
+    # @param [Fixnum] ttl
+    # @param [Fixnum] time_range the block height at which this transaction will be allowed to be included in a block. If the block height of the main chain exceeds this value, the transaction will expire and no longer be valid.
+    # @param [Hash] actions
+    #
+    def build_transaction(base_transaction: nil, ttl: 0, time_range:, actions: [])
+      params = {
+          base_transaction: base_transaction,
+          ttl: ttl,
+          time_range: time_range,
+          actions: actions
+      }
+      client.make_request('/build-transaction', 'post', params: params)
+    end
+
+    def build_chain_transactions(base_transaction: nil, ttl:, time_range:, actions: [])
+      params = {
+          base_transaction: base_transaction,
+          ttl: ttl,
+          time_range: time_range,
+          actions: actions
+      }
+      client.make_request('/build-chain-transactions', 'post', params: params)
+    end
+
+    ##
+    # Sign transaction.
+    #
+    # @param [String] password
+    # @param [Hash] transaction
+    #
+    def sign_transaction(password:, transaction: {})
+      params = {
+          password: password,
+          transaction: transaction
+      }
+      client.make_request('/sign-transaction', 'post', params: params)
+    end
+
+    def sign_transactions(password: nil, transactions: [])
+      params = {
+          password: password,
+          transactions: transactions
+      }
+      client.make_request('/sign-transactions', 'post', params: params)
+    end
+
+    ##
+    # Submit transaction.
+    #
+    # @param [String] raw_transaction raw_transaction of signed transaction.
+    #
+    def submit_transaction(raw_transaction: {})
+      params = {
+          raw_transaction: raw_transaction,
+      }
+      client.make_request('/submit-transaction', 'post', params: params)
+    end
+
+    ##
+    # Submit transactions used for batch submit transactions.
+    #
+    # @param [Array] raw_transactions Submit transactions used for batch submit transactions.
+    #
+    def submit_transactions(raw_transactions: [])
+      params = {
+          raw_transactions: raw_transactions,
+      }
+      client.make_request('/submit-transactions', 'post', params: params)
+    end
+
+    ##
+    # Estimate consumed neu(1BTM = 10^8NEU) for the transaction.
+    #
+    def estimate_transaction_gas(transaction_template: {})
+      params = {
+          transaction_template: transaction_template,
+      }
+      client.make_request('/estimate-transaction-gas', 'post', params: params)
+    end
+    ##
+    # Create transaction feed.
+    #
+    # @param [String] alias_name
+    # @param [String] filter
+    #
+    def create_transaction_feed(alias_name:, filter:)
+      params = {
+          alias: alias_name,
+          filter: filter
+      }
+      client.make_request('/create-transaction-feed', 'post', params: params)
+    end
+
+    ##
+    # Query detail transaction feed by name.
+    #
+    def get_transaction_feed(alias_name:)
+      params = {
+          alias: alias_name
+      }
+      client.make_request('/get-transaction-feed', 'post', params: params)
+    end
+
+    ##
+    # Returns the list of all available transaction feeds.
+    #
+    def list_transaction_feeds
+      client.make_request('/list-transaction-feeds', 'post', params: {})
+    end
+
+    ##
+    # Delete transaction feed by name.
+    #
+    # @param [String] alias_name name of the transaction feed.
+    #
+    def delete_transaction_feed(alias_name:)
+      params = {
+          alias: alias_name,
+      }
+      client.make_request('/delete-transaction-feed', 'post', params: params)
+    end
+
+    ##
+    # Update transaction feed.
+    #
+    # @param [String] alias_name
+    # @param [String] filter
+    #
+    def update_transaction_feed(alias_name:, filter:)
+      params = {
+          alias: alias_name,
+          filter: filter
+      }
+      client.make_request('/update-transaction-feed', 'post', params: params)
+    end
+
+    ##
+    # Query mempool transaction by transaction ID.
+    #
+    def get_unconfirmed_transaction(tx_id:)
+      params = {
+          tx_id: tx_id,
+      }
+      client.make_request('/get-unconfirmed-transaction', 'post', params: params)
+    end
+
+    ##
+    # Returns the total number of mempool transactions and the list of transaction IDs.
+    #
+    def list_unconfirmed_transactions
+      client.make_request('/list-unconfirmed-transactions', 'post', params: {})
+    end
+
+    ##
+    # Decode a serialized transaction hex string into a JSON object describing the transaction.
+    #
+    def decode_raw_transaction(raw_transaction:)
+      params = {
+          raw_transaction: raw_transaction,
+      }
+      client.make_request('/decode-raw-transaction', 'post', params: params)
+    end
+
+
+  end
+end

data/lib/bytom/api/wallet.rb

@@ -0,0 +1,57 @@
+module Bytom
+  class Wallet
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Backup wallet to image file, it contain accounts image, assets image and keys image.
+    #
+    def backup_wallet
+      client.make_request('/backup-wallet', 'post', params: {})
+    end
+
+    ##
+    # Restore wallet by image file.
+    #
+    # @param [Hash] account_image
+    # @param [Hash] asset_image
+    # @param [Hash] key_images
+    #
+    def restore_wallet(account_image: {}, asset_image: {}, key_images: {})
+      params = {
+          account_image: account_image,
+          asset_image: asset_image,
+          key_images: key_images
+      }
+      client.make_request('/restore-wallet', 'post', params: params)
+    end
+
+    ##
+    # Trigger to rescan block information into related wallet.
+    #
+    def rescan_wallet
+      client.make_request('/rescan-wallet', 'post', params: {})
+    end
+
+    ##
+    # Recovery wallet and accounts from root XPubs.
+    # All accounts and balances of bip44 multi-account hierarchy for deterministic wallets can be restored via root xpubs.
+    #
+    # @param [Array] xpubs
+    #
+    def recovery_wallet(xpubs: [])
+      client.make_request('/recovery-wallet', 'post', params: {xpubs: xpubs})
+    end
+
+    ##
+    # Return the information of wallet.
+    #
+    def wallet_info
+      client.make_request('/wallet-info', 'post', params: {})
+    end
+  end
+end

data/lib/bytom/api/work.rb

@@ -0,0 +1,43 @@
+module Bytom
+  class Work
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Get the proof of work.
+    #
+    def get_work
+      client.make_request('/get-work', 'post', params: {})
+    end
+
+    ##
+    # Submit the proof of work.
+    #
+    # @param [String] block_header
+    #
+    def submit_work(block_header:)
+      client.make_request('/submit-work', 'post', params: {block_header: block_header})
+    end
+
+    ##
+    # Get the proof of work by json.
+    #
+    def get_work_json
+      client.make_request('/get-work-json', 'post', params: {})
+    end
+
+    ##
+    # Submit the proof of work by json.
+    # 
+    def submit_work_json(block_header:)
+      client.make_request('/submit-work-json', 'post', params: {block_header: block_header})
+    end
+
+  end
+end
+
+

data/lib/bytom/client.rb

@@ -0,0 +1,89 @@
+require 'bytom/api/keys'
+require 'bytom/api/accounts'
+require 'bytom/api/address'
+require 'bytom/api/coinbase'
+require 'bytom/api/asset'
+require 'bytom/api/balances'
+require 'bytom/api/access_token'
+require 'bytom/api/transactions'
+require 'bytom/api/block'
+require 'bytom/api/core_config'
+require 'bytom/api/peer'
+require 'bytom/api/wallet'
+require 'bytom/api/message'
+require 'bytom/api/work'
+require 'bytom/api/other'
+
+require 'bytom/constants'
+require 'bytom/request'
+
+module Bytom
+  # The entry point to the SDK. API endpoint categories are accessed through this object's readable
+  # attributes.
+  #
+  # @!attribute [r] client
+  #   @return [Client]
+  # @!attribute [r] keys
+  #   @return [Keys]
+  # @!attribute [r] accounts
+  #   @return [Accounts]
+  # @!attribute [r] address
+  #   @return [Address]
+  # @!attribute [r] coinbase
+  #   @return [Coinbase]
+  # @!attribute [r] asset
+  #   @return [Asset]
+  # @!attribute [r] balances
+  #   @return [Balances]
+  # @!attribute [r] access_token
+  #   @return [AccessToken]
+  # @!attribute [r] transactions
+  #   @return [Transactions]
+  # @!attribute [r] block
+  #   @return [Block]
+  # @!attribute [r] core_config
+  #   @return [CoreConfig]
+  # @!attribute [r] peer
+  #   @return [Peer]
+  # @!attribute [r] wallet
+  #   @return [Wallet]
+  # @!attribute [r] message
+  #   @return [Message]
+  # @!attribute [r] work
+  #   @return [Work]
+  # @!attribute [r] other
+  #   @return [Other]
+  #
+  class Client
+    include Bytom::Constants
+    attr_reader :client, :keys, :accounts, :address, :coinbase, :asset, :balances, :access_token,
+                :transactions, :block, :core_config, :peer, :wallet, :message, :work, :other
+
+    def initialize(
+        base_url: API_URL,
+        token: nil
+    )
+      @client = Request.new(base_url: base_url, token: token)
+      build_categories
+    end
+
+    def build_categories
+      @keys = Keys.new(client)
+      @accounts = Accounts.new(client)
+      @address = Address.new(client)
+      @coinbase = Coinbase.new(client)
+      @asset = Asset.new(client)
+      @balances = Balances.new(client)
+      @access_token = AccessToken.new(client)
+      @transactions = Transactions.new(client)
+      @block = Block.new(client)
+      @core_config = CoreConfig.new(client)
+      @peer = Peer.new(client)
+      @wallet = Wallet.new(client)
+      @message = Message.new(client)
+      @work = Work.new(client)
+      @other = Other.new(client)
+    end
+
+  end
+end