blockfrost-ruby 0.1.0

data/lib/blockfrostruby/endpoints/cardano/accounts_endpoints.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module AccountsEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/accounts/(address).
+  #
+  # @param address [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_address(address)
+    Request.get_response("#{@url}/accounts/#{address}", @project_id)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/rewards.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_rewards(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/rewards", @project_id, params)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/history.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_history(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/history", @project_id, params)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/delegations.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_delegations(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/delegations", @project_id, params)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/registrations.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_registrations(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/registations", @project_id, params)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/withdrawals.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_withdrawals(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/withdrawals", @project_id, params)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/mirs.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_mirs(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/mirs", @project_id, params)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/addresses.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_addresses(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/addresses", @project_id, params, @config)
+  end
+
+  # Calls get request on (@url)/accounts/(address)/addresses/assets.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_account_addresses_assets(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/accounts/#{address}/addresses/assets", @project_id, params)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/addresses_endpoints.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module AddressesEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/addresses/(address).
+  #
+  # @param address [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_address(address)
+    Request.get_response("#{@url}/addresses/#{address}", @project_id)
+  end
+
+  # Calls get request on (@url)/addresses/(address)/total.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_address_details(address)
+    Request.get_response("#{@url}/addresses/#{address}/total", @project_id)
+  end
+
+  # Calls get request on (@url)/addresses/(address)/utxos.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_address_utxos(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/addresses/#{address}/utxos", @project_id, params)
+  end
+
+  # Calls get request on (@url)/addresses/(address)/transactions.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_address_transactions(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/addresses/#{address}/transactions", @project_id, params)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/assets_endpoints.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Example: 81791e9e2b5929574039c38020374c753a548ef84bd7eaef8c908bdf43617264616e6f4b6f6d626174533154323541303035
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module AssetsEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/assets.
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_assets(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/assets", @project_id, params)
+  end
+
+  # Calls get request on (@url)/assets/(asset).
+  #
+  # @param asset [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_asset(asset, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/assets/#{asset}", @project_id, params)
+  end
+
+  # Calls get request on (@url)/assets/(asset)/history.
+  #
+  # @param asset [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_asset_history(asset, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/assets/#{asset}/history", @project_id, params)
+  end
+
+  # Calls get request on (@url)/assets/(asset)/transactions.
+  #
+  # @param asset [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_asset_transactions(asset, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/assets/#{asset}/transactions", @project_id, params)
+  end
+
+  # Calls get request on (@url)/assets/(asset)/addresses.
+  #
+  # @param asset [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_asset_addresses(asset, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/assets/#{asset}/addresses", @project_id, params)
+  end
+
+  # Calls get request on (@url)/assets/policy/(policy_id).
+  #
+  # @param policy_id [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_assets_of_policy(policy_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/assets/policy/#{policy_id}", @project_id, params)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/blocks_endpoints.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Example hash_or_number: 5ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a
+# Example slot_number: 30895909
+# Example epoch_number: 219
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module BlocksEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/blocks/latest.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_block_latest
+    Request.get_response("#{@url}/blocks/latest", @project_id)
+  end
+
+  # Calls get request on (@url)/blocks/latest/txs.
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_block_latest_transactions(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/blocks/latest/txs", @project_id, params)
+  end
+
+  # Calls get request on (@url)/blocks/(hash_or_number).
+  #
+  # @param hash_or_number [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_block(hash_or_number)
+    Request.get_response("#{@url}/blocks/#{hash_or_number}", @project_id)
+  end
+
+  # Calls get request on (@url)/blocks/slot/(slot_number).
+  #
+  # @param slot_number [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_block_in_slot(slot_number)
+    Request.get_response("#{@url}/blocks/slot/#{slot_number}", @project_id)
+  end
+
+  # Calls get request on (@url)/blocks/epoch/(epoch_number)/slot/(slot_number).
+  #
+  # @param slot_number [String] will be added to the url for get request.
+  # @param epoch_number [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_block_in_slot_in_epoch(slot_number, epoch_number)
+    Request.get_response("#{@url}/blocks/epoch/#{epoch_number}/slot/#{slot_number}", @project_id)
+  end
+
+  # Calls get request on (@url)/blocks/(hash_or_number)/next.
+  #
+  # @param hash_or_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_list_of_next_blocks(hash_or_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/blocks/#{hash_or_number}/next", @project_id, params)
+  end
+
+  # Calls get request on (@url)/blocks/(hash_or_number)/previous.
+  #
+  # @param hash_or_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_list_of_previous_blocks(hash_or_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/blocks/#{hash_or_number}/previous", @project_id, params)
+  end
+
+  # Calls get request on (@url)/blocks/(hash_or_number)/txs.
+  #
+  # @param hash_or_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_block_transactions(hash_or_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/blocks/#{hash_or_number}/txs", @project_id, params)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/epochs_endpoints.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# Example epoch_number: 225
+# Example pool_id: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module EpochsEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/epochs/latest.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_latest_epoch
+    Request.get_response("#{@url}/epochs/latest", @project_id)
+  end
+
+  # Calls get request on (@url)/epochs/latest/parameters.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_latest_epoch_parameters
+    Request.get_response("#{@url}/epochs/latest/parameters", @project_id)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number).
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_epoch(epoch_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/next.
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_list_of_next_epochs(epoch_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/next", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/previous.
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_list_of_previous_epochs(epoch_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/previous", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/stakes.
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_epoch_stakes(epoch_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/stakes", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/stakes/(pool_id).
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_epoch_stakes_by_pool(epoch_number, pool_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/stakes/#{pool_id}", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/blocks.
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_epoch_blocks(epoch_number, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/blocks", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/bloks/(pool_id).
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @param pool_id [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_epoch_blocks_by_pool(epoch_number, pool_id, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/blocks/#{pool_id}", @project_id, params)
+  end
+
+  # Calls get request on (@url)/epochs/(epoch_number)/parameters.
+  #
+  # @param epoch_number [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_epoch_parameters(epoch_number)
+    Request.get_response("#{@url}/epochs/#{epoch_number}/parameters", @project_id)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/health_endpoints.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../../../blockfrostruby/request'
+
+module HealthEndpoints
+  extend Request
+
+  # Calls get request on (@url)/.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_root
+    Request.get_response("#{@url}/", @project_id)
+  end
+
+  # Calls get request on (@url)/health.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_health
+    Request.get_response("#{@url}/health", @project_id)
+  end
+
+  # Calls get request on (@url)/health/clock.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_health_clock
+    Request.get_response("#{@url}/health/clock", @project_id)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/ledger_endpoints.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../../../blockfrostruby/request'
+
+module LedgerEndpoints
+  extend Request
+
+  # Calls get request on (@url)/genesis.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_genesis
+    Request.get_response("#{@url}/genesis", @project_id)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/metadata_endpoints.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Example label: 1990
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module MetadataEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/metadata/txs/labels.
+  #
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transactions_metadata_labels(params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/metadata/txs/labels", @project_id, params)
+  end
+
+  # Calls get request on (@url)/metadata/txs/labels/(label).
+  #
+  # @param label [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_metadata_content_in_json(label, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/metadata/txs/labels/#{label}", @project_id, params)
+  end
+
+  # Calls get request on (@url)/metadata/txs/labels/(label)/cbor.
+  #
+  # @param label [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_transaction_metadata_content_in_cbor(label, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/metadata/txs/labels/#{label}/cbor", @project_id, params)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/metrics_endpoints.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../../../blockfrostruby/request'
+
+module MetricsEndpoints
+  extend Request
+
+  # Calls get request on (@url)/metrics.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_metrics
+    Request.get_response("#{@url}/metrics", @project_id)
+  end
+
+  # Calls get request on (@url)/metrics.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_metrics_endpoints
+    Request.get_response("#{@url}/metrics/endpoints", @project_id)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/network_endpoints.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../../../blockfrostruby/request'
+
+module NetworkEndpoints
+  extend Request
+
+  # Calls get request on (@url)/network.
+  #
+  # @return [Hash] formatted result with status and body keys.
+  def get_network
+    Request.get_response("#{@url}/network", @project_id)
+  end
+end

data/lib/blockfrostruby/endpoints/cardano/nutlink_endpoints.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Example address: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz
+
+require_relative '../../../blockfrostruby/request'
+require_relative '../../../blockfrostruby/params'
+
+module NutlinkEndpoints
+  extend Request
+  extend Params
+
+  # Calls get request on (@url)/nutlink/(address).
+  #
+  # @param address [String] will be added to the url for get request.
+  # @return [Hash] formatted result with status and body keys.
+  def get_address_metadata_list(address)
+    Request.get_response("#{@url}/nutlink/#{address}", @project_id)
+  end
+
+  # Calls get request on (@url)/nutlink/(address)/tickers.
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_address_metadata_tickers_list(address, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/nutlink/#{address}/tickers", @project_id, params)
+  end
+
+  # Calls get request on (@url)/nutlink/(address)/tickers/(ticker).
+  #
+  # @param address [String] will be added to the url for get request.
+  # @param ticker [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_ticker_records_by_address(address, ticker, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/nutlink/#{address}/tickers/#{ticker}", @project_id, params)
+  end
+
+  # Calls get request on (@url)/nutlink/tickers/(ticker).
+  #
+  # @param ticker [String] will be added to the url for get request.
+  # @param params [Hash] - params passed by user.
+  # @return [Hash] formatted result with status and body keys.
+  def get_ticker_records(ticker, params = {})
+    params = Params.define_params(params, @config)
+    Request.get_response("#{@url}/nutlink/tickers/#{ticker}", @project_id, params)
+  end
+end