feat: add epoch type and add get_current_epoch RPC

Author: classicalliu

lib/ckb/api.rb

@@ -134,6 +134,11 @@ def get_transaction_trace(hash)
       rpc.get_transaction_trace(hash)
     end
 
+    # @return [CKB::Types::Epoch]
+    def get_current_epoch
+      Types::Epoch.from_h(rpc.get_current_epoch)
+    end
+
     def inspect
       "\#<API@#{uri}>"
     end

lib/ckb/rpc.rb

@@ -74,6 +74,10 @@ def get_transaction_trace(hash)
       rpc_request("get_transaction_trace", params: [hash])
     end
 
+    def get_current_epoch
+      rpc_request("get_current_epoch")
+    end
+
     def inspect
       "\#<RPC@#{uri}>"
     end

lib/ckb/types/block_header.rb

@@ -28,7 +28,8 @@ def self.from_h(hash)
     end
 
     class BlockHeader
-      attr_reader :difficulty, :hash, :number, :parent_hash, :seal, :timestamp, :transactions_root, :proposals_root, :uncles_count, :uncles_hash, :version, :witness_root
+      attr_reader :difficulty, :hash, :number, :parent_hash, :seal, :timestamp, :transactions_root, :proposals_root, \
+                  :uncles_count, :uncles_hash, :version, :witness_root, :epoch
 
       def initialize(
         difficulty:,
@@ -42,7 +43,8 @@ def initialize(
         uncles_count:,
         uncles_hash:,
         version:,
-        witness_root:
+        witness_root:,
+        epoch:
       )
         @difficulty = difficulty
         @hash = hash
@@ -56,6 +58,7 @@ def initialize(
         @uncles_hash = uncles_hash
         @version = version
         @witness_root = witness_root
+        @epoch = epoch
       end
 
       def to_h
@@ -71,7 +74,8 @@ def to_h
           uncles_count: @uncles_count.to_i,
           uncles_hash: @uncles_hash,
           version: @version,
-          witness_root: @witness_root
+          witness_root: @witness_root,
+          epoch: @epoch
         }
       end
 
@@ -88,7 +92,8 @@ def self.from_h(hash)
           uncles_count: hash[:uncles_count],
           uncles_hash: hash[:uncles_hash],
           version: hash[:version],
-          witness_root: hash[:witnesses_root]
+          witness_root: hash[:witnesses_root],
+          epoch: hash[:epoch]
         )
       end
     end

lib/ckb/types/epoch.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module CKB
+  module Types
+    class Epoch
+      attr_reader :block_reward, :difficulty, :last_block_hash_in_previous_epoch, :length, :number, :remainder_reward, :start_number
+
+      # @param block_reward [String] number
+      # @param difficulty [String] 0x...
+      # @param last_block_hash_in_previous_epoch [String] 0x...
+      # @param length [String] number
+      # @param number [String] number
+      # @param remainer_reward [String] number
+      # @param start_number [Sring] number
+      def initialize(
+        block_reward:,
+        difficulty:,
+        last_block_hash_in_previous_epoch:,
+        length:,
+        number:,
+        remainder_reward:,
+        start_number:
+      )
+        @block_reward = block_reward
+        @difficulty = difficulty
+        @last_block_hash_in_previous_epoch = last_block_hash_in_previous_epoch
+        @length = length
+        @number = number
+        @remainder_reward = remainder_reward
+        @start_number = start_number
+      end
+
+      def to_h
+        {
+          block_reward: @block_reward,
+          difficulty: @difficulty,
+          last_block_hash_in_previous_epoch: @last_block_hash_in_previous_epoch,
+          length: @length,
+          number: @number,
+          remainder_reward: @remainder_reward,
+          start_number: @start_number
+        }
+      end
+
+      def self.from_h(hash)
+        new(
+          block_reward: hash[:block_reward],
+          difficulty: hash[:difficulty],
+          last_block_hash_in_previous_epoch: hash[:last_block_hash_in_previous_epoch],
+          length: hash[:length],
+          number: hash[:number],
+          remainder_reward: hash[:remainder_reward],
+          start_number: hash[:start_number]
+        )
+      end
+    end
+  end
+end

lib/ckb/types/types.rb

@@ -11,6 +11,7 @@
 require_relative "transaction"
 require_relative "tx_status"
 require_relative "witness"
+require_relative "epoch"
 
 module CKB
   module Types

spec/ckb/api_spec.rb

@@ -70,4 +70,10 @@
       api.send_transaction(tx)
     }.to raise_error(CKB::RPCError, /:code=>-3/)
   end
+
+  it "get current epoch" do
+    result = api.get_current_epoch
+    expect(result).not_to be nil
+    expect(result).to be_a(Types::Epoch)
+  end
 end