overlay-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d3cefab6304e1630b289f6a40f3b0cb3ef37f91b7dec3ff81aae2406879a805
+  data.tar.gz: f3d5bfc15a43a5643da5d326397b6027e443892f9a1ec64d0264e44be22e53c3
+SHA512:
+  metadata.gz: 6c97a51f22d5e0b40abe32277af750d67942a6d5cf10a0a22a6a1a4c5265eb420b2747d925d8b457c6081a24fe1f851034cb37be1efef4b7114729ef632ac1a3
+  data.tar.gz: 83860a3d530c45384942c07eec8ea2af85f07129646787df6a2de2f251d8f58b46c11dcc9a1b671cd67fd911bbea591a41949bada9721cbecaad4e6558e90893

data/README.md

@@ -0,0 +1 @@
+# overlay-ruby

data/lib/overlay/client.rb

@@ -0,0 +1,31 @@
+require "httpx"
+require "json"
+
+module Overlay
+  class Client
+    def initialize(api_key: Config.api_key, auth_key: Config.auth_key, base_url: Config.base_url)
+      @api_key = api_key
+      @auth_key = auth_key
+      @base_url = base_url
+    end
+
+    def post(path, payload)
+      res = HTTPX.with_headers(headers).post("#{@base_url}#{path}", json: payload)
+      handle_response(res)
+    end
+
+    private
+
+    def headers
+      {
+        "api-key" => @api_key,
+        "auth-key" => @auth_key,
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def handle_response(res)
+      JSON.parse(res.to_s)
+    end
+  end
+end

data/lib/overlay/config.rb

@@ -0,0 +1,21 @@
+module Overlay
+  module Config
+    class << self
+      attr_accessor :api_key, :auth_key, :env, :base_url
+
+      def env=(value)
+        @env = value.to_s
+        @base_url = case @env
+                    when "devnet"
+                      "https://devnet.overlay.fun"
+                    when "mainnet"
+                      "https://mainnet.overlay.fun"
+                    else
+                      raise ArgumentError, "Invalid env: #{@env} (use 'devnet' or 'mainnet')"
+                    end
+      end
+    end
+
+    self.env = "devnet"
+  end
+end

data/lib/overlay/nft.rb

@@ -0,0 +1,33 @@
+require 'overlay/response'
+
+module Overlay
+  class NFT
+    def self.create(params)
+      client = Client.new
+      res = client.post("/nfts", params)
+
+      Overlay::Response.new(res)
+    end
+
+    def self.mint(mint_address, params = {})
+      client = Client.new
+      res = client.post("/nfts/#{mint_address}/mint", params)
+
+      Overlay::Response.new(res)
+    end
+
+    def self.transfer(mint_address, params = {})
+      client = Client.new
+      res = client.post("/nfts/#{mint_address}/transfer", params)
+
+      Overlay::Response.new(res)
+    end
+
+    def self.burn(mint_address, params = {})
+      client = Client.new
+      res = client.post("/nfts/#{mint_address}/burn", params)
+
+      Overlay::Response.new(res)
+    end
+  end
+end

data/lib/overlay/response.rb

@@ -0,0 +1,42 @@
+require "json"
+
+module Overlay
+  class Response
+    attr_reader :data, :message, :success
+
+    def initialize(hash)
+      @success = hash["success"]
+      @message = hash["message"]
+      @data = hash["data"] || {}
+
+      # data 配下のキーを最上位でもアクセス可能にする
+      @data.each do |k, v|
+        define_singleton_method(k) { v }
+      end
+
+      # top-level keys もメソッド化
+      (hash.keys - ["data"]).each do |k|
+        define_singleton_method(k) { hash[k] }
+      end
+    end
+
+    # JSON 表示用
+    def to_h
+      { success: success, message: message }.merge(data)
+    end
+
+    # JSON pretty print 用
+    def to_json_pretty
+      JSON.pretty_generate(to_h)
+    end
+
+    # inspect と to_s を JSON 表示にオーバーライド
+    def inspect
+      to_json_pretty
+    end
+
+    def to_s
+      to_json_pretty
+    end
+  end
+end

data/lib/overlay/token.rb

@@ -0,0 +1,35 @@
+require 'overlay/response'
+
+module Overlay
+  class Token
+    def self.create(params)
+      client = Client.new
+      res = client.post("/tokens", params)
+
+      Overlay::Response.new(res)
+    end
+
+    def self.mint(mint_address, params = {})
+    	raise "amount is required" unless params[:amount]
+
+      client = Client.new
+      res = client.post("/tokens/#{mint_address}/mint", params)
+
+      Overlay::Response.new(res)
+    end
+
+    def self.transfer(mint_address, params = {})
+      client = Client.new
+      res = client.post("/tokens/#{mint_address}/transfer", params)
+
+      Overlay::Response.new(res)
+    end
+
+    def self.burn(mint_address, params = {})
+      client = Client.new
+      res = client.post("/tokens/#{mint_address}/burn", params)
+
+      Overlay::Response.new(res)
+    end
+  end
+end

data/lib/overlay/version.rb

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

data/lib/overlay/wallet.rb

@@ -0,0 +1,12 @@
+require 'overlay/response'
+
+module Overlay
+  class Wallet
+    def self.create(params)
+      client = Client.new
+      res = client.post("/wallets", params)
+
+      Overlay::Response.new(res)
+    end
+  end
+end

data/lib/overlay.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "overlay/version"
+require_relative "overlay/config"
+require_relative "overlay/client"
+require_relative "overlay/wallet"
+require_relative "overlay/token"
+require_relative "overlay/nft"
+
+module Overlay
+  class Error < StandardError; end
+
+  class << self
+    def configure
+      yield(Config)
+    end
+  end
+end

data/sig/overlay.rbs

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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: overlay-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- overlay
+bindir: exe
+cert_chain: []
+date: 2025-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Overlay enables simple Web3 development across multiple blockchains,
+  including Solana, Ethereum, BSC, Base, Polygon, and Bera. It does not require signing
+  transactions with wallets, which is typically necessary in blockchain development.
+  Additionally, Overlay does not store any database, implements high-level security
+  features, and securely encrypts wallet information to safely execute transactions.
+email:
+- contact@overlay.fun
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- README.md
+- lib/overlay.rb
+- lib/overlay/.DS_Store
+- lib/overlay/client.rb
+- lib/overlay/config.rb
+- lib/overlay/nft.rb
+- lib/overlay/response.rb
+- lib/overlay/token.rb
+- lib/overlay/version.rb
+- lib/overlay/wallet.rb
+- sig/overlay.rbs
+homepage: https://docs.overlay.fun
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://docs.overlay.fun
+  source_code_uri: https://github.com/overlaydotfun/overlay-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Overlay is a library for Web3 development that makes it easy to implement
+  wallet creation, token and NFT issuance, minting, burning, and transfers.
+test_files: []