nft_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8153b19d92797310cd260ebdba17a6c11bdae0b9a3a0c86c182ba2e2047d2503
+  data.tar.gz: 1f20e9beb1b63cb0892b5182fbe48d85d5ed241b6aff57289343a5ddb23079d4
+SHA512:
+  metadata.gz: f75b7bea25958aeca21abce0b3f7da30b4b09d03506279a8d50ac759924d7676e5a7ad11a0f666fe1c35aa27524d8015d1a560a5e1e012dcdd28df3c7ff09006
+  data.tar.gz: e9936d133831a60cdcd41d882e3e9abe0514bd72bb6ea4766919e1138aabb593771ab9c6947f47121bc953a7ee39fde8e701dc5c126b61eb92cd2a885cc75369

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-30
+
+Initial release with support for OpenSea NFTs

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nft_checker.gemspec
+gemspec
+
+gem "httparty", "~> 0.20.0"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake", "~> 0.6.0"
+gem "rubocop-rspec", "~> 2.7"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.14"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    nft_checker (0.1.0)
+      httparty (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    multi_xml (0.6.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  httparty (~> 0.20.0)
+  nft_checker!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.7)
+  vcr (~> 6.0)
+  webmock (~> 3.14)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,52 @@
+# NftChecker
+
+NFT Checker is a utility to verify NFT ownership.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nft_checker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nft_checker
+
+## Usage
+
+```ruby
+require 'nft_checker'
+checker = NftChecker.init(:opensea)
+# or, for testnets:
+# checker = NftChecker.init(:opensea, testnet: true)
+
+# List all "naturedivas" still owned by AleyArt
+list = checker.list_nfts({slug: naturedivas}, "0x422699b0f5891c8ddd306c08d9856032264c5e8e" )
+p list.map {|nft| nft["image_url"]} # [ "https://...", ... ]
+
+# Verify that naturediva 016 is still owned by Thision
+still_owned = checker.verify_owner(
+  {
+    contract_address: "0x495f947276749Ce646f68AC8c248420045cb7b5e",
+    token_id: "29920848932956748486580529385461081269564523998318357035541486687674930561025"
+  },
+  "0x3dec7052aa8d55b3b6b6ad2c6bce195a9acca404"
+)
+p still_owned # true
+```
+
+## 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/valthon/nft_checker.

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nft_checker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nft_checker/open_sea.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "httparty"
+module NftChecker
+  ###
+  # NFT Checker implementation for OpenSea
+  class OpenSea
+    # @param testnet Use OpenSea 'testnets' API (default false)
+    def initialize(testnet: false)
+      @url_base = testnet ? "https://testnets-api.opensea.io/" : "https://api.opensea.io/"
+    end
+
+    # Verify that the NFT is owned by the given address
+    # @param nft_metadata - hash containing :contract_address and :token_id values
+    # @param owner_address - address of presumed NFT owner
+    def verify_owner(nft_metadata, owner_address)
+      contract, token = nft_metadata.slice(:contract_address, :token_id).values
+      rez = HTTParty.get(@url_base + "asset/#{contract}/#{token}/", query: { account_address: owner_address })
+      handle_response_codes(rez, not_found: false) do
+        ownership_data = rez.parsed_response["ownership"]
+        return false if ownership_data.nil?
+
+        ownership_data["owner"]["address"].casecmp(owner_address).zero? && ownership_data["quantity"].to_i.positive?
+      end
+    end
+
+    # List all NFTs in the collection owned by the given address
+    # @param collection_metadata - hash containing :slug for OpenSea collection
+    # @param owner_address - address to check for NFTs
+    def list_nfts(collection_metadata, owner_address)
+      rez = HTTParty.get("#{@url_base}assets", query: { owner: owner_address, collection: collection_metadata[:slug] })
+      handle_response_codes(rez, not_found: []) do
+        rez.parsed_response["assets"] || []
+      end
+    end
+
+    private
+
+    def handle_response_codes(rez, not_found: nil)
+      case rez.code
+      when 429
+        raise Throttled
+      when 400
+        not_found
+      when 200
+        yield
+      else
+        raise Error(rez.to_s)
+      end
+    end
+  end
+end

data/lib/nft_checker/version.rb

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

data/lib/nft_checker.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "nft_checker/version"
+require_relative "nft_checker/open_sea"
+
+###
+# NftChecker is a tool for verifying NFT ownership
+#
+# Use the `init` method to generate a checker for a given NFT source
+# Currently supported sources:
+# * OpenSea
+#
+# Checkers all support the following methods:
+# * verify_owner(nft_metadata, owner_address): boolean
+# * list_nfts(collection_metadata, owner_address): [<NFT ID>,...]
+#
+module NftChecker
+  class Error < StandardError; end
+  class Throttled < Error; end
+
+  def self.init(source, options = {})
+    case source.to_s
+    when /\Aopen\w?sea(.io)?\z/i
+      OpenSea.new(testnet: options[:testnet])
+    else
+      raise "Unknown source: #{source}"
+    end
+  end
+end

data/nft_checker.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/nft_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nft_checker"
+  spec.version = NftChecker::VERSION
+  spec.authors = ["David J Parrott"]
+  spec.email = ["valthon@nothlav.net"]
+
+  spec.summary = "Utility to verify ownership of an NFT"
+  spec.homepage = "https://github.com/valthon/nft_checker"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/valthon/nft_checker/blob/trunk/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "httparty", "~> 0.20"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 0.6"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.14"
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: nft_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David J Parrott
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+description:
+email:
+- valthon@nothlav.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nft_checker.rb
+- lib/nft_checker/open_sea.rb
+- lib/nft_checker/version.rb
+- nft_checker.gemspec
+homepage: https://github.com/valthon/nft_checker
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/valthon/nft_checker
+  source_code_uri: https://github.com/valthon/nft_checker
+  changelog_uri: https://github.com/valthon/nft_checker/blob/trunk/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Utility to verify ownership of an NFT
+test_files: []