upsideos_evm_rwa_artifacts 0.1.0

data/lib/upsideos_evm_rwa_artifacts/version.rb

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

data/lib/upsideos_evm_rwa_artifacts.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+
+require_relative 'upsideos_evm_rwa_artifacts/version'
+
+# ABIs and verification sources for audited EVM contract releases.
+#
+# The gem carries data only. It has no dependencies and runs no code at
+# load time beyond reading the release directory.
+module UpsideosEvmRwaArtifacts
+  RELEASES = %w[v5 v5.1 recallable-payment].freeze
+
+  class Error < StandardError; end
+
+  # The release name is not one this gem carries.
+  class UnknownRelease < Error; end
+
+  # The release carries no such file.
+  class UnknownFile < Error; end
+
+  DATA_ROOT = Pathname.new(File.expand_path('../data', __dir__)).freeze
+
+  CACHE = {}
+  CACHE_MUTEX = Mutex.new
+  private_constant :CACHE, :CACHE_MUTEX
+
+  class << self
+    def releases
+      RELEASES
+    end
+
+    def release_dir(release)
+      name = release.to_s
+      unless RELEASES.include?(name)
+        raise UnknownRelease,
+              "Unknown release #{name}. Known: #{RELEASES.join(', ')}"
+      end
+
+      DATA_ROOT.join(name)
+    end
+
+    # Callers that hand a file to another tool, such as an explorer
+    # verification request, need the path rather than the content.
+    def path(release, file)
+      full = release_dir(release).join(file)
+      raise UnknownFile, "#{file} is not in release #{release}" unless full.file?
+
+      full
+    end
+
+    def abi_path(release, contract)
+      path(release, "abi/#{contract}.json")
+    end
+
+    # The token forwards unknown selectors into its extensions, so a caller
+    # that talks to the token address needs the merged call surface rather
+    # than the token ABI alone.
+    def merged_abi_path(release, contract)
+      path(release, "abi/merged/#{contract}.json")
+    end
+
+    def verification_source_codes_path(release)
+      path(release, 'verification-source-codes.json')
+    end
+
+    def manifest_path(release)
+      path(release, 'manifest.json')
+    end
+
+    def abi(release, contract)
+      read_json(abi_path(release, contract))
+    end
+
+    def merged_abi(release, contract)
+      read_json(merged_abi_path(release, contract))
+    end
+
+    def verification_source_codes(release)
+      read_json(verification_source_codes_path(release))
+    end
+
+    def manifest(release)
+      read_json(manifest_path(release))
+    end
+
+    def contracts(release)
+      manifest(release).fetch('artifacts').map { |artifact| artifact.fetch('name') }
+    end
+
+    def call_surfaces(release)
+      manifest(release).fetch('callSurfaces', []).map { |surface| surface.fetch('name') }
+    end
+
+    def commit(release)
+      manifest(release).fetch('source').fetch('commit')
+    end
+
+    def compiler_version(release)
+      manifest(release).fetch('build').fetch('compilerLongVersion')
+    end
+
+    private
+
+    # Parsed files are shared and frozen, because a release never changes
+    # once it is published.
+    def read_json(path)
+      key = path.to_s
+      cached = CACHE[key]
+      return cached unless cached.nil?
+
+      CACHE_MUTEX.synchronize do
+        CACHE[key] ||= JSON.parse(path.read).freeze
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: upsideos_evm_rwa_artifacts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Upside
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Contract ABIs, merged call-surface ABIs, release manifests and solc
+  standard-json verification bundles for the audited EVM Security Token
+  releases. Data only, with no dependencies.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- data/recallable-payment/abi/AccessControl.json
+- data/recallable-payment/abi/RecallablePayment.json
+- data/recallable-payment/manifest.json
+- data/recallable-payment/verification-source-codes.json
+- data/v5.1/abi/AccessControl.json
+- data/v5.1/abi/ERC2771CustomForwarder.json
+- data/v5.1/abi/IdentityRegistry.json
+- data/v5.1/abi/InterestPayment.json
+- data/v5.1/abi/PurchaseContract.json
+- data/v5.1/abi/RestrictedLockupToken.json
+- data/v5.1/abi/RestrictedLockupTokenExtension.json
+- data/v5.1/abi/RestrictedLockupTokenManagementExtension.json
+- data/v5.1/abi/RestrictedLockupTokenStandardsExtension.json
+- data/v5.1/abi/RestrictedSwap.json
+- data/v5.1/abi/SnapshotPeriods.json
+- data/v5.1/abi/TransferRules.json
+- data/v5.1/abi/merged/RestrictedLockupToken.json
+- data/v5.1/manifest.json
+- data/v5.1/verification-source-codes.json
+- data/v5/abi/AccessControl.json
+- data/v5/abi/ERC2771CustomForwarder.json
+- data/v5/abi/IdentityRegistry.json
+- data/v5/abi/InterestPayment.json
+- data/v5/abi/PurchaseContract.json
+- data/v5/abi/RestrictedLockupToken.json
+- data/v5/abi/RestrictedLockupTokenExtension.json
+- data/v5/abi/RestrictedLockupTokenManagementExtension.json
+- data/v5/abi/RestrictedSwap.json
+- data/v5/abi/SnapshotPeriods.json
+- data/v5/abi/TransferRules.json
+- data/v5/abi/merged/RestrictedLockupToken.json
+- data/v5/manifest.json
+- data/v5/verification-source-codes.json
+- lib/upsideos_evm_rwa_artifacts.rb
+- lib/upsideos_evm_rwa_artifacts/version.rb
+homepage: https://github.com/upsideos/contract-artifacts
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/upsideos/contract-artifacts
+  source_code_uri: https://github.com/upsideos/contract-artifacts/tree/main/packages/ruby
+  bug_tracker_uri: https://github.com/upsideos/contract-artifacts/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: ABIs and verification sources for audited EVM contract releases
+test_files: []