chainalysis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3559d0827651183fd3adc8bff46df276d1821ee8bf6c16af0be8d7418ad55f5
+  data.tar.gz: ea500373a881c4ff215d04f687d0eb0c18aab2e68237facf4576585ce75facb3
+SHA512:
+  metadata.gz: da082b2fe769d535bb2967c6e49ad40f70a460fb39378eadf3ec1389707c04e7e67942daee81a12f1d506269dc0936b52aeb356afb86feffdfa00adb6970c7a3
+  data.tar.gz: 164c68e2cdea0a703c9887f171c18bcc40c827dbe1eca796faf04820de0e356c919cb9979f4863171cb1c629bd5b69ec547a80dd8b1c07248779ade6fa087b9b

data/.rubocop.yml

@@ -0,0 +1 @@
+require: rubocop-rspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-11
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Raghav Sood
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Chainalysis
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chainalysis`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chainalysis.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/flake.lock

@@ -0,0 +1,253 @@
+{
+  "nodes": {
+    "devenv": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "nix": "nix",
+        "nixpkgs": "nixpkgs",
+        "pre-commit-hooks": "pre-commit-hooks"
+      },
+      "locked": {
+        "lastModified": 1688824367,
+        "narHash": "sha256-qHxX0U8K+BvN+P1+ZhPuFMHRL2aCmQxSnXLzzNpTLD0=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "1e4701fb1f51f8e6fe3b0318fc2b80aed0761914",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "1e4701fb1f51f8e6fe3b0318fc2b80aed0761914",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1685518550,
+        "narHash": "sha256-o2d0KcvaXzTrPRIo0kOLV0/QXHhDQ5DTi+OxcjO8xqY=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "a1720a10a6cfe8234c0e93907ffe81be440f4cef",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "devenv",
+          "pre-commit-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1660459072,
+        "narHash": "sha256-8DFJjXG8zqoONA1vXtgeKXy68KdJL5UaXR8NtVMUbx8=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "a20de23b925fd8264fd7fad6454652e142fd7f73",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "lowdown-src": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1633514407,
+        "narHash": "sha256-Dw32tiMjdK9t3ETl5fzGrutQTzh2rufgZV4A/BbxuD4=",
+        "owner": "kristapsdz",
+        "repo": "lowdown",
+        "rev": "d2c2b44ff6c27b936ec27358a2653caaef8f73b8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "kristapsdz",
+        "repo": "lowdown",
+        "type": "github"
+      }
+    },
+    "nix": {
+      "inputs": {
+        "lowdown-src": "lowdown-src",
+        "nixpkgs": [
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression"
+      },
+      "locked": {
+        "lastModified": 1676545802,
+        "narHash": "sha256-EK4rZ+Hd5hsvXnzSzk2ikhStJnD63odF7SzsQ8CuSPU=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "7c91803598ffbcfe4a55c44ac6d49b2cf07a527f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "relaxed-flakes",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1678875422,
+        "narHash": "sha256-T3o6NcQPwXjxJMn2shz86Chch4ljXgZn746c2caGxd8=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "126f49a01de5b7e35a43fd43f891ecf6d3a51459",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1685801374,
+        "narHash": "sha256-otaSUoFEMM+LjBI1XL/xGB5ao6IwnZOXc47qhIgJe8U=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "c37ca420157f4abc31e26f436c1145f8951ff373",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1735821806,
+        "narHash": "sha256-cuNapx/uQeCgeuhUhdck3JKbgpsml259sjUQnWM7zW8=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "d6973081434f88088e5321f83ebafe9a1167c367",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": [
+          "devenv",
+          "flake-compat"
+        ],
+        "flake-utils": "flake-utils",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable"
+      },
+      "locked": {
+        "lastModified": 1688056373,
+        "narHash": "sha256-2+SDlNRTKsgo3LBRiMUcoEUb6sDViRNQhzJquZ4koOI=",
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "5843cf069272d92b60c3ed9e55b7a8989c01d4c7",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "nixpkgs": "nixpkgs_2",
+        "systems": "systems_2"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "systems_2": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/flake.nix

@@ -0,0 +1,43 @@
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    systems.url = "github:nix-systems/default";
+    devenv.url = "github:cachix/devenv/1e4701fb1f51f8e6fe3b0318fc2b80aed0761914";
+  };
+
+  nixConfig = {
+    extra-trusted-public-keys = "devenv.cachix.org-1:w1cLUi8dv3hnoSPGAuibQv+f9TZLr6cv/Hm9XgU50cw=";
+    extra-substituters = "https://devenv.cachix.org";
+  };
+
+  outputs = { self, nixpkgs, devenv, systems, ... } @ inputs:
+    let
+      forEachSystem = nixpkgs.lib.genAttrs (import systems);
+    in
+    {
+      devShells = forEachSystem
+        (system:
+          let
+            pkgs = nixpkgs.legacyPackages.${system};
+          in
+          {
+            default = devenv.lib.mkShell {
+              inherit inputs pkgs;
+              modules = [
+                {
+                  packages = with pkgs; [ 
+                    ruby_3_4
+
+                    # Ensure we use openssl 3
+                    openssl_3 
+                  ];
+
+                  enterShell = ''
+                    export PATH=$HOME/.gem/ruby/3.4.0/bin:$PATH
+                  '';
+                }
+              ];
+            };
+          });
+    };
+}

data/lib/chainalysis/client.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+module Chainalysis
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class BadRequestError < Error; end
+  class NotFoundError < Error; end
+  class RateLimitError < Error; end
+  class ApiError < Error; end
+
+  class Client
+    BASE_URL = 'https://api.chainalysis.com/api/kyt'
+    ADMIN_URL = 'https://api.chainalysis.com/admin'
+    VERSION = '0.1.0'
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+      @stubs = stubs
+    end
+
+    # Transfer Registration
+    def register_transfer(user_id:, network:, asset:, transfer_reference:, direction:, **options)
+      post_request(
+        "v2/users/#{user_id}/transfers",
+        {
+          network: network,
+          asset: asset,
+          transferReference: transfer_reference,
+          direction: direction,
+          **options
+        }
+      )
+    end
+
+    # Withdrawal Attempt Registration
+    def register_withdrawal_attempt(user_id:, network:, asset:, address:, attempt_identifier:, asset_amount:,
+                                    attempt_timestamp:, **options)
+      post_request(
+        "v2/users/#{user_id}/withdrawal-attempts",
+        {
+          network: network,
+          asset: asset,
+          address: address,
+          attemptIdentifier: attempt_identifier,
+          assetAmount: asset_amount,
+          attemptTimestamp: attempt_timestamp,
+          **options
+        }
+      )
+    end
+
+    # Transfer Endpoints
+    def get_transfer(external_id:, format_type: nil)
+      params = { format_type: format_type } if format_type
+      get_request("v2/transfers/#{external_id}", params)
+    end
+
+    def get_transfer_exposures(external_id:)
+      get_request("v2/transfers/#{external_id}/exposures")
+    end
+
+    def get_transfer_alerts(external_id:)
+      get_request("v2/transfers/#{external_id}/alerts")
+    end
+
+    def get_transfer_network_identifications(external_id:)
+      get_request("v2/transfers/#{external_id}/network-identifications")
+    end
+
+    # Withdrawal Attempt Endpoints
+    def get_withdrawal_attempt(external_id:, format_type: nil)
+      params = { format_type: format_type } if format_type
+      get_request("v2/withdrawal-attempts/#{external_id}", params)
+    end
+
+    def get_withdrawal_attempt_exposures(external_id:)
+      get_request("v2/withdrawal-attempts/#{external_id}/exposures")
+    end
+
+    def get_withdrawal_attempt_alerts(external_id:)
+      get_request("v2/withdrawal-attempts/#{external_id}/alerts")
+    end
+
+    def get_withdrawal_attempt_high_risk_addresses(external_id:)
+      get_request("v2/withdrawal-attempts/#{external_id}/high-risk-addresses")
+    end
+
+    def get_withdrawal_attempt_network_identifications(external_id:)
+      get_request("v2/withdrawal-attempts/#{external_id}/network-identifications")
+    end
+
+    # Categories
+    def get_categories
+      get_request('v2/categories')
+    end
+
+    # Administration
+    def get_internal_users
+      get_request('organization/users', admin: true)
+    end
+
+    private
+
+    def client
+      @client ||= Faraday.new(url: BASE_URL) do |conn|
+        conn.headers['Token'] = api_key
+        conn.headers['Accept'] = 'application/json'
+        conn.headers['Content-Type'] = 'application/json'
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def admin_client
+      @admin_client ||= Faraday.new(url: ADMIN_URL) do |conn|
+        conn.headers['Token'] = api_key
+        conn.headers['Accept'] = 'application/json'
+        conn.headers['Content-Type'] = 'application/json'
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def handle_response(response)
+      case response.status
+      when 200, 201, 202
+        return {} if response.body.empty?
+
+        JSON.parse(response.body)
+      when 400
+        raise BadRequestError, error_message(response)
+      when 403
+        raise AuthenticationError, error_message(response)
+      when 404
+        raise NotFoundError, error_message(response)
+      when 429
+        raise RateLimitError, error_message(response)
+      else
+        raise ApiError, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      return response.body if response.body.empty?
+
+      error = JSON.parse(response.body)
+      error['message'] || error['error'] || response.body
+    rescue JSON::ParserError
+      response.body
+    end
+
+    def get_request(url, params = {}, admin: false)
+      client = admin ? admin_client : self.client
+      response = client.get(url) do |req|
+        req.params = params if params
+      end
+      handle_response(response)
+    end
+
+    def post_request(url, body = {})
+      response = client.post(url) do |req|
+        req.body = JSON.generate(body) unless body.empty?
+      end
+      handle_response(response)
+    end
+  end
+end

data/lib/chainalysis/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Chainalysis
+  VERSION = '0.1.0'
+end

data/lib/chainalysis.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'chainalysis/version'
+
+module Chainalysis
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/chainalysis.rbs

@@ -0,0 +1,4 @@
+module Chainalysis
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: chainalysis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raghav Sood
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: A Ruby client for the Chainalysis API, allowing you to interact with
+  Chainalysis's blockchain analysis tools.
+email:
+- r@raghavsood.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- flake.lock
+- flake.nix
+- lib/chainalysis.rb
+- lib/chainalysis/client.rb
+- lib/chainalysis/version.rb
+- sig/chainalysis.rbs
+homepage: https://github.com/RaghavSood/chainalysis.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/RaghavSood/chainalysis.rb
+  source_code_uri: https://github.com/RaghavSood/chainalysis.rb
+  changelog_uri: https://github.com/RaghavSood/chainalysis.rb/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby client for the Chainalysis API
+test_files: []