api

Documentation

Overview

Package api contains server-side logic for the relayer's REST API.

Index

• type MessageResult
• type RelayRequest
• type RelayerAPIServer
  • func NewRelayerAPIServer(port uint16, host string, db db2.CCTPRelayerDB, ...) *RelayerAPIServer
  • func (r RelayerAPIServer) GetTx(ctx *gin.Context)
  • func (r RelayerAPIServer) Start(ctx context.Context) error
• type RelayerResponse

Types

type MessageResult

type MessageResult struct {
	OriginHash      string `json:"origin_hash"`
	DestinationHash string `json:"destination_hash"`
	Origin          uint32 `json:"origin"`
	Destination     uint32 `json:"destination"`
	RequestID       string `json:"request_id"`
	State           string `json:"state"`
}

MessageResult is the result of a successful /tx request.

type RelayRequest

type RelayRequest struct {
	Origin uint32
	TxHash common.Hash
}

RelayRequest is a request to relay a transaction.

type RelayerAPIServer

type RelayerAPIServer struct {
	// contains filtered or unexported fields
}

RelayerAPIServer exposes API endpoints that interact with CCTPRelayer.

func NewRelayerAPIServer

func NewRelayerAPIServer(port uint16, host string, db db2.CCTPRelayerDB, relayRequestChan chan *RelayRequest) *RelayerAPIServer

NewRelayerAPIServer creates a new RelayerAPIServer.

func (RelayerAPIServer) GetTx

func (r RelayerAPIServer) GetTx(ctx *gin.Context)

GetTx handles the /tx endpoint. If the transaction is found in the db, return information about the transaction. Otherwise, queue the corresponding Message for relay.

func (RelayerAPIServer) Start

func (r RelayerAPIServer) Start(ctx context.Context) error

Start starts the RelayerAPIServer.

type RelayerResponse

type RelayerResponse struct {
	Success bool        `json:"success"`
	Result  interface{} `json:"result"`
}

RelayerResponse is a wrapper struct for a relayer API response.