feat: add ckb-indexer types and get_cells api

Author: shaojunda

lib/ckb.rb

@@ -19,6 +19,8 @@
 require "ckb/mock_transaction_dumper"
 require "ckb/system_code_hash"
 require "ckb/script_hash_type"
+require "ckb/indexer/types/types"
+require "ckb/indexer/api"
 
 module CKB
   class Error < StandardError; end

lib/ckb/indexer/api.rb

@@ -0,0 +1,17 @@
+module CKB
+	module Indexer
+		class API
+			attr_reader :rpc
+			DEFAULT_LIMIT = 1000
+
+			def initialize(indexer_host, timeout_config = {})
+				@rpc = CKB::RPC.new(host: indexer_host, timeout_config: timeout_config)
+			end
+
+			def get_cells(search_key:, order: "asc", limit: DEFAULT_LIMIT, after_cursor: nil)
+				result = rpc.get_cells(search_key.to_h, order, Utils.to_hex(limit), after_cursor)
+				CKB::Indexer::Types::LiveCells.from_h(result)
+			end
+		end
+	end
+end

lib/ckb/indexer/types/live_cell.rb

@@ -0,0 +1,34 @@
+module CKB
+	module Indexer
+		module Types
+			class LiveCell
+				attr_reader :block_number, :out_point, :output, :output_data, :tx_index
+
+				# @param block_number [String | Integer] integer or hex number
+				# @param out_point [CKB::Types::OutPoint]
+				# @param output [CKB::Types::Output]
+				# @param output_data [string]
+				# @param tx_index [String | Integer] integer or hex number
+				def initialize(block_number:, out_point:, output:, output_data:, tx_index:)
+					@block_number = Utils.to_int(block_number)
+					@out_point = out_point
+					@output = output
+					@output_data = output_data
+					@tx_index = Utils.to_int(tx_index)
+				end
+
+				def self.from_h(hash)
+					return if hash.nil?
+
+					new(
+						block_number: hash[:block_number],
+						out_point: CKB::Types::OutPoint.from_h(hash[:out_point]),
+						output: CKB::Types::Output.from_h(hash[:output]),
+						output_data: hash[:output_data],
+						tx_index: hash[:tx_index]
+					)
+				end
+			end
+		end
+	end
+end

lib/ckb/indexer/types/live_cells.rb

@@ -0,0 +1,24 @@
+module CKB
+	module Indexer
+		module Types
+			class LiveCells
+				attr_reader :last_cursor, :objects
+				# @param last_cursor [String]
+				# @param objects [CKB::Types::LiveCell[]]
+				def initialize(last_cursor:, objects:)
+					@last_cursor = last_cursor
+					@objects = objects
+				end
+
+				def self.from_h(hash)
+					return if hash.nil?
+
+					new(
+						last_cursor: hash[:last_cursor],
+						objects: hash[:objects].map { |object| CKB::Indexer::Types::LiveCell.from_h(object) }
+					)
+				end
+			end
+		end
+	end
+end

lib/ckb/indexer/types/search_key.rb

@@ -0,0 +1,28 @@
+module CKB
+	module Indexer
+		module Types
+			class SearchKey
+				attr_accessor :script, :script_type, :args_len
+
+				def initialize(script, script_type, args_len = nil)
+					raise ArgumentError, "script type must be CKB::Types::Script" unless script.is_a?(CKB::Types::Script)
+					raise ArgumentError, "invalid script_type: #{script_type}" unless %w(lock type).include?(script_type)
+
+					@script = script
+					@script_type = script_type
+					@args_len = args_len
+				end
+
+				def to_h
+					hash = {
+						script: script.to_h,
+						script_type: script_type
+					}
+					hash[args_len] = Utils.to_hex(args_len) if args_len
+
+					hash
+				end
+			end
+		end
+	end
+end

lib/ckb/indexer/types/types.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "search_key"
+require_relative "live_cell"
+require_relative "live_cells"
+
+module CKB
+	module Indexer
+		module Types
+		end
+	end
+end

spec/ckb/indexer/types/search_key_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe CKB::Indexer::Types::SearchKey do
+	it "should raise error when script type is not CKB::Types::Script" do
+		expect {
+			CKB::Indexer::Types::SearchKey.new(123, "type")
+		}.to raise_error(ArgumentError, "script type must be CKB::Types::Script")
+	end
+
+	it "should raise error when script_type is invalid" do
+		expect {
+			CKB::Indexer::Types::SearchKey.new(CKB::Types::Script.new(code_hash: CKB::SystemCodeHash::SECP256K1_BLAKE160_SIGHASH_ALL_TYPE_HASH, args: "0x", hash_type: "type"), "t")
+		}.to raise_error(ArgumentError, "invalid script_type: t")
+	end
+end