glassnode 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fd053158af0fc3f9a4e289826502475c0a9196398b20fc77cf2addb1616b62b
+  data.tar.gz: 98b0b04000c07d8935956bd316ac13e95cd10feedddb5c2dbc090a70e46cf433
+SHA512:
+  metadata.gz: 84d70fbace8516476928b2282ecd72f68f334d88400633d8e9486a016943d44d7538905725b737382f2f2305ecb5983aa11f8a3b5fb532b7bdccd895331b107a
+  data.tar.gz: 04b730a45eaf88401db34a6f43b78cd418112612d17137f321180bfd89e299acde0125c33339cf715365d3aedb762c0998b6221f4ee47ede536db941a2c8a1af

data/lib/errors.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+
+module Glassnode
+  class ClientError < Exception; end
+  class ParamsError < ClientError; end
+  class InvalidAuthKeyError < ClientError; end
+  class BlockMissingError < ParamsError; end
+  class ServerError < Exception; end # Error reported back by Glassnode server
+  class ConnectionClosed < Exception; end
+  class BadRequestError < ServerError; end
+  class NotFoundError < ServerError; end
+  class ForbiddenError < ServerError; end
+  class UnauthorizedError < ServerError; end
+  class InternalServerError < ServerError; end
+
+  class CustomErrors < Faraday::Response::Middleware
+    def on_complete(env)
+      case env[:status]
+      when 400
+        raise BadRequestError, env.body['message']
+      when 401
+        raise UnauthorizedError, env.body['message']
+      when 403
+        raise ForbiddenError, env.body['message']
+      when 404
+        raise NotFoundError, env.url
+      when 500
+        raise InternalServerError, env.body
+      else
+        super
+      end
+    end
+  end
+end

data/lib/glassnode.rb

@@ -0,0 +1,11 @@
+require 'uri'
+require 'base64'
+require 'openssl'
+require 'faraday'
+require 'json'
+require 'faraday_middleware'
+require 'dotenv/load'
+
+require_relative './errors'
+require_relative './rest/v1'
+require_relative './rest/v2'

data/lib/rest/rest_client.rb

@@ -0,0 +1,39 @@
+require 'faraday_adapter_socks'
+
+module Glassnode
+  module RESTClient
+    def check_params(params, allowed_params)
+      if (params.keys - allowed_params).empty?
+        return params
+      else
+        raise Glassnode::ParamsError
+      end
+    end
+
+    private
+    def rest_connection
+      @conn ||= new_rest_connection
+    end
+
+    def new_rest_connection
+      Faraday.new(url: config[:api_endpoint], proxy: config[:proxy]) do |conn|
+        conn.use Glassnode::CustomErrors
+        conn.response :logger, Logger.new(STDOUT), bodies: true  if config[:debug_connection]
+        conn.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+        conn.adapter :net_http_socks
+      end
+    end
+    
+    def authenticated_get(url, params: {})
+      headers = {'Content-Type' => 'application/json', 'X-Api-Key' => config[:api_key]}
+      rest_connection.get(url, params, headers) do |req|
+        req.options.timeout = config[:rest_timeout]
+        req.options.open_timeout = config[:rest_open_timeout]
+      end
+    end
+
+    def valid_key?
+      !! (config[:api_key])
+    end
+  end
+end

data/lib/rest/v1/addresses.rb

@@ -0,0 +1,356 @@
+module Glassnode
+  module RESTv1Addresses
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["10m", "1h", "24h", "1w", "1month"]
+    def sending_to_exchanges_count(params={})
+      authenticated_get("metrics/addresses/sending_to_exchanges_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["10m", "1h", "24h", "1w", "1month"]
+    def receiving_from_exchanges_count(params={})
+      authenticated_get("metrics/addresses/receiving_from_exchanges_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def count(params={})
+      authenticated_get("metrics/addresses/count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def sending_count(params={})
+      authenticated_get("metrics/addresses/sending_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def receiving_count(params={})
+      authenticated_get("metrics/addresses/receiving_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def active_count(params={})
+      authenticated_get("metrics/addresses/active_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def new_non_zero_count(params={})
+      authenticated_get("metrics/addresses/new_non_zero_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def accumulation_count(params={})
+      authenticated_get("metrics/addresses/accumulation_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["24h"]
+    def accumulation_balance(params={})
+      authenticated_get("metrics/addresses/accumulation_balance", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def non_zero_count(params={})
+      authenticated_get("metrics/addresses/non_zero_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_point_zero_1_count(params={})
+      authenticated_get("metrics/addresses/min_point_zero_1_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_point_1_count(params={})
+      authenticated_get("metrics/addresses/min_point_1_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_1_count(params={})
+      authenticated_get("metrics/addresses/min_1_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_10_count(params={})
+      authenticated_get("metrics/addresses/min_10_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_100_count(params={})
+      authenticated_get("metrics/addresses/min_100_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_1k_count(params={})
+      authenticated_get("metrics/addresses/min_1k_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_10k_count(params={})
+      authenticated_get("metrics/addresses/min_10k_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m"]
+    def min_32_count(params={})
+      authenticated_get("metrics/addresses/min_32_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_less_0001(params={})
+      authenticated_get("metrics/addresses/supply_balance_less_0001", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_0001_001(params={})
+      authenticated_get("metrics/addresses/supply_balance_0001_001", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_001_01(params={})
+      authenticated_get("metrics/addresses/supply_balance_001_01", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_01_1(params={})
+      authenticated_get("metrics/addresses/supply_balance_01_1", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_1_10(params={})
+      authenticated_get("metrics/addresses/supply_balance_1_10", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_10_100(params={})
+      authenticated_get("metrics/addresses/supply_balance_10_100", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_100_1k(params={})
+      authenticated_get("metrics/addresses/supply_balance_100_1k", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_1k_10k(params={})
+      authenticated_get("metrics/addresses/supply_balance_1k_10k", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_10k_100k(params={})
+      authenticated_get("metrics/addresses/supply_balance_10k_100k", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m"]
+    def supply_balance_more_100k(params={})
+      authenticated_get("metrics/addresses/supply_balance_more_100k", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def supply_distribution_relative(params={})
+      authenticated_get("metrics/addresses/supply_distribution_relative", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_1_usd_count(params={})
+      authenticated_get("metrics/addresses/min_1_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_10_usd_count(params={})
+      authenticated_get("metrics/addresses/min_10_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_100_usd_count(params={})
+      authenticated_get("metrics/addresses/min_100_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_1k_usd_count(params={})
+      authenticated_get("metrics/addresses/min_1k_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_10k_usd_count(params={})
+      authenticated_get("metrics/addresses/min_10k_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_100k_usd_count(params={})
+      authenticated_get("metrics/addresses/min_100k_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["24h"]
+    def min_1m_usd_count(params={})
+      authenticated_get("metrics/addresses/min_1m_usd_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def profit_count(params={})
+      authenticated_get("metrics/addresses/profit_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def loss_count(params={})
+      authenticated_get("metrics/addresses/loss_count", params: params).body
+    end
+
+    #Tier: 3
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def profit_relative(params={})
+      authenticated_get("metrics/addresses/profit_relative", params: params).body
+    end
+
+  end
+end

data/lib/rest/v1/assets.rb

@@ -0,0 +1,10 @@
+module Glassnode
+  module RESTv1Assets
+
+    #Tier: 3
+    def get_assets
+      authenticated_get("metrics/assets")
+    end
+
+  end
+end

data/lib/rest/v1/blockchain.rb

@@ -0,0 +1,167 @@
+module Glassnode
+  module RESTv1Blockchain
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_count(params={})
+      authenticated_get("metrics/blockchain/utxo_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_created_count(params={})
+      authenticated_get("metrics/blockchain/utxo_created_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_spent_count(params={})
+      authenticated_get("metrics/blockchain/utxo_spent_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_created_value_sum(params={})
+      authenticated_get("metrics/blockchain/utxo_created_value_sum", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_spent_value_sum(params={})
+      authenticated_get("metrics/blockchain/utxo_spent_value_sum", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_created_value_mean(params={})
+      authenticated_get("metrics/blockchain/utxo_created_value_mean", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_spent_value_mean(params={})
+      authenticated_get("metrics/blockchain/utxo_spent_value_mean", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_created_value_median(params={})
+      authenticated_get("metrics/blockchain/utxo_created_value_median", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE", "USD"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def utxo_spent_value_median(params={})
+      authenticated_get("metrics/blockchain/utxo_spent_value_median", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def utxo_profit_count(params={})
+      authenticated_get("metrics/blockchain/utxo_profit_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def utxo_loss_count(params={})
+      authenticated_get("metrics/blockchain/utxo_loss_count", params: params).body
+    end
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h"]
+    def utxo_profit_relative(params={})
+      authenticated_get("metrics/blockchain/utxo_profit_relative", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def block_height(params={})
+      authenticated_get("metrics/blockchain/block_height", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def block_count(params={})
+      authenticated_get("metrics/blockchain/block_count", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def block_interval_mean(params={})
+      authenticated_get("metrics/blockchain/block_interval_mean", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def block_interval_median(params={})
+      authenticated_get("metrics/blockchain/block_interval_median", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def block_size_mean(params={})
+      authenticated_get("metrics/blockchain/block_size_mean", params: params).body
+    end
+
+    #Tier: 1
+    #Params
+    #  a: asset symbol
+    #  c: ["NATIVE"]
+    #  i: ["1h", "24h", "10m", "1w", "1month"]
+    def block_size_sum(params={})
+      authenticated_get("metrics/blockchain/block_size_sum", params: params).body
+    end
+
+  end
+end

data/lib/rest/v1/defi.rb

@@ -0,0 +1,14 @@
+module Glassnode
+  module RESTv1Defi
+
+    #Tier: 2
+    #Params
+    #  a: asset symbol
+    #  c: ["USD"]
+    #  i: ["24h"]
+    def total_value_locked(params={})
+      authenticated_get("metrics/defi/total_value_locked", params: params).body
+    end
+
+  end
+end