Merge pull request #22 from rarimo/route-v2/state

Add new route v2/state

Author: artemskriabin

docs/spec/components/schemas/StateV2.yaml

@@ -0,0 +1,22 @@
+allOf:
+  - $ref: '#/components/schemas/StateKey'
+  - type: object
+    required:
+      - attributes
+    properties:
+      attributes:
+        type: object
+        required:
+          - signature
+          - timestamp
+        properties:
+          signature:
+            example: "0xd0bf2f6c2270874d8870a1081b67fcb0280b61db000778f159ba39c38fb2595639c2e1d81d085916ba6ec77f2bd4c4a2ae6dfbdbaf8703da7d9fe629b2e1218a00"
+            type: string
+            pattern: '^0x([0-9a-fA-F]+)$'
+            description: Signature of root state signed by relayer private key, with the last byte of the signature set to 27/28.
+          timestamp:
+            example: "1733395652"
+            type: integer
+            format: int64
+            description: Time indicates when the event was caught, a.k.a state transition timestamp

docs/spec/components/schemas/StateV2Key.yaml

@@ -0,0 +1,11 @@
+type: object
+required:
+  - id
+  - type
+properties:
+  id:
+    type: string
+  type:
+    type: string
+    enum:
+      - state_v2

docs/spec/paths/integrations@proof-verification-relayer@v2@state.yaml

@@ -0,0 +1,57 @@
+get:
+  tags:
+    - State
+  summary: Get signed root state V2
+  description: |
+    Endpoint to get transited root state.    
+    The service listens for the new `RootUpdated` event and fetches them. By request it might return any root by 
+    its block number or root hex string if none of them provided last signed root returned.   
+    Response contain signature of root signed by relayer private key, with the last byte of the signature set to 27/28.
+  operationId: GetStateV2
+  parameters:
+    - in: query
+      name: 'filter[block]'
+      required: false
+      description: "Block number to filter root by"
+      example: "666"
+      schema:
+        type: integer
+        format: int64
+    - in: query
+      name: 'filter[root]'
+      required: false
+      description: "Transited root in hex format stated to filter root by."
+      example: "0x234693c352a217d95c3a0e2e7ea17a340ac1b2290e9ab573ef97c2a86b1a5a6e"
+      schema:
+        type: string
+        pattern: '^0x([0-9a-fA-F]+)$'
+  responses:
+    200:
+      description: Success
+      content:
+        application/vnd.api+json:
+          schema:
+            type: object
+            required:
+              - data
+            properties:
+              data:
+                $ref: '#/components/schemas/StateV2'
+    '400':
+      description: Bad Request Error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Errors'
+    '404':
+      description: Not Found Error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Errors'
+    '500':
+      description: Internal Error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Errors'

internal/service/api/handlers/get_signed_state_v2.go

@@ -0,0 +1,67 @@
+package handlers
+
+import (
+	"encoding/hex"
+	"net/http"
+
+	"github.com/rarimo/proof-verification-relayer/internal/data"
+	"github.com/rarimo/proof-verification-relayer/internal/service/api/requests"
+	"github.com/rarimo/proof-verification-relayer/resources"
+	"gitlab.com/distributed_lab/ape"
+	"gitlab.com/distributed_lab/ape/problems"
+)
+
+func GetSignedStateV2(w http.ResponseWriter, r *http.Request) {
+	req, err := requests.NewGetSignedStateRequest(r)
+	if err != nil {
+		Log(r).WithError(err).Error("failed to get request")
+		ape.RenderErr(w, problems.BadRequest(err)...)
+		return
+	}
+
+	query := StateQ(r)
+	if req.Block != nil {
+		query = query.FilterByBlock(*req.Block)
+	}
+	if req.Root != nil {
+		query = query.FilterByRoot(*req.Root)
+	}
+
+	state, err := query.SortByBlockHeight(data.DESC).Get()
+	if err != nil {
+		Log(r).WithError(err).Error("failed to get state")
+		ape.RenderErr(w, problems.InternalError())
+		return
+	}
+
+	if state == nil {
+		Log(r).Error("no block found")
+		ape.RenderErr(w, problems.NotFound())
+		return
+	}
+
+	signature, err := signState(*state, r)
+	if err != nil {
+		Log(r).WithError(err).Error("failed to sign state")
+		ape.RenderErr(w, problems.InternalError())
+		return
+	}
+
+	// See more about this here:
+	// https://eips.ethereum.org/EIPS/eip-155#:~:text=If%20block.number%20%3E%3D%20FORK_BLKNUM%20and%20v,same%20rules%20as%20it%20did%20previously.
+	// https://dev.to/truongpx396/understanding-ethereum-ecdsa-eip-712-and-its-role-in-permit-functionality-26ll
+	signature[64] += 27
+
+	ape.Render(w, resources.StateV2Response{
+		Data: resources.StateV2{
+			Key: resources.Key{
+				ID:   state.ID,
+				Type: resources.STATE_V2,
+			},
+			Attributes: resources.StateV2Attributes{
+				Signature: hex.EncodeToString(signature),
+				Timestamp: int64(state.Timestamp),
+			},
+		},
+	})
+}

internal/service/api/router.go

@@ -64,15 +64,18 @@ func (s *service) router() chi.Router {
 			r.Post("/transit-state", handlers.TransitState)
 			r.Get("/state", handlers.GetSignedState)
 		})
-		if s.cfg.VotingV2Config().Enable {
-			r.Route("/v2", func(r chi.Router) {
+		r.Route("/v2", func(r chi.Router) {
+			if s.cfg.VotingV2Config().Enable {
 				r.Get("/count-remaining-votes/{voting_id}", handlers.VoteCountHandlers)
 				r.Get("/is-enough/{voting_id}", handlers.IsEnoughHandler)
 				r.Post("/vote", handlers.VoteV2)
 				r.Post("/predict", handlers.PredictHandlers)
 				r.Get("/proposals", handlers.ProposalsInfo)
-			})
-		}
+			}
+
+			r.Get("/state", handlers.GetSignedStateV2)
+		})
+
 	})
 
 	return r

resources/model_resource_type.go

@@ -11,6 +11,7 @@ const (
 	PROPOSALS             ResourceType = "proposals"
 	SEND_TRANSACTION      ResourceType = "send_transaction"
 	STATE                 ResourceType = "state"
+	STATE_V2              ResourceType = "state_v2"
 	TXS                   ResourceType = "txs"
 	VOTE_COUNT            ResourceType = "vote_count"
 	IS_ENOUGH             ResourceType = "is_enough"

resources/model_state_v2.go

@@ -0,0 +1,31 @@
+/*
+ * GENERATED. Do not modify. Your changes might be overwritten!
+ */
+
+package resources
+
+type StateV2 struct {
+	Key
+	Attributes StateV2Attributes `json:"attributes"`
+}
+type StateV2Response struct {
+	Data     StateV2  `json:"data"`
+	Included Included `json:"included"`
+}
+
+type StateV2ListResponse struct {
+	Data     []StateV2 `json:"data"`
+	Included Included  `json:"included"`
+	Links    *Links    `json:"links"`
+}
+
+// MustStateV2 - returns StateV2 from include collection.
+// if entry with specified key does not exist - returns nil
+// if entry with specified key exists but type or ID mismatches - panics
+func (c *Included) MustStateV2(key Key) *StateV2 {
+	var stateV2 StateV2
+	if c.tryFindEntry(key, &stateV2) {
+		return &stateV2
+	}
+	return nil
+}

resources/model_state_v2_attributes.go

@@ -0,0 +1,12 @@
+/*
+ * GENERATED. Do not modify. Your changes might be overwritten!
+ */
+
+package resources
+
+type StateV2Attributes struct {
+	// Signature of root state signed by relayer private key, with the last byte of the signature set to 27/28.
+	Signature string `json:"signature"`
+	// Time indicates when the event was caught, a.k.a state transition timestamp
+	Timestamp int64 `json:"timestamp"`
+}