db

Documentation

Overview

Package db contains the database interface for the rfq relayer.

Index

• Variables
• type Datstores
• type Reader
• type Service
• type SignRequest
• type SynapseRequestStatus
  • func (s SynapseRequestStatus) GormDataType() string
  • func (s SynapseRequestStatus) Int() uint8
  • func (s *SynapseRequestStatus) Scan(src any) error
  • func (i SynapseRequestStatus) String() string
  • func (s SynapseRequestStatus) Value() (driver.Value, error)
• type Writer

Variables

var ErrNoLatestBlockForChainID = errors.New("no latest block for chainId")

ErrNoLatestBlockForChainID is returned when no block exists for the chain.

Types

type Datstores

type Datstores interface {
	DatastoreForSigner(address common.Address) (datastore.Batching, error)
	GlobalDatastore() (datastore.Batching, error)
}

Datstores contain the datastores for the p2p comms.

type Reader

type Reader interface {
	PutLatestBlock(ctx context.Context, chainID, height uint64) error
	GetQuoteResultsByStatus(ctx context.Context, matchStatuses ...SynapseRequestStatus) (res []SignRequest, _ error)
}

Reader is the interface for reading from the database.

type Service

type Service interface {
	Reader
	Writer
	Datstores
	// SubmitterDB returns the submitter database service.
	SubmitterDB() submitterDB.Service
}

Service is the interface for the database service.

type SignRequest

type SignRequest struct {
	// TXHash is the hash of the transaction that emitted the event
	TXHash common.Hash
	// OriginChainID is the chain id the transaction hash was sent on
	OriginChainID *big.Int
	// DestChainID is the chain id the transaction hash will be sent on
	DestChainID *big.Int
	// Status is the status of the transaction
	Status SynapseRequestStatus
	// SignedEntryHash is the hash of the signed entry
	SignedEntryHash common.Hash
	// Entry is the raw entry.
	Entry []byte
}

SignRequest is the request to sign a transaction.

type SynapseRequestStatus

type SynapseRequestStatus uint8

SynapseRequestStatus is the status of a synapse request.

const (
	// Seen is the status of a synapse request that has been seen.
	Seen SynapseRequestStatus = iota + 1
	// Signed is the status of a synapse request that has been signed.
	Signed
	// Broadcast is the status of a synapse request that has been broadcast.
	Broadcast
	// Completed is the status of a synapse request that has been completed.
	Completed // Completed is the status of a synapse request that has been completed.
)

func (SynapseRequestStatus) GormDataType

func (s SynapseRequestStatus) GormDataType() string

GormDataType implements the gorm common interface for enums.

func (SynapseRequestStatus) Int

func (s SynapseRequestStatus) Int() uint8

Int returns the integer value of the synapse request status.

func (*SynapseRequestStatus) Scan

func (s *SynapseRequestStatus) Scan(src any) error

Scan implements the gorm common interface for enums.

func (SynapseRequestStatus) String

func (i SynapseRequestStatus) String() string

func (SynapseRequestStatus) Value

func (s SynapseRequestStatus) Value() (driver.Value, error)

Value implements the gorm common interface for enums.

type Writer

type Writer interface {
	LatestBlockForChain(ctx context.Context, chainID uint64) (uint64, error)
	UpdateSignRequestStatus(ctx context.Context, txid common.Hash, status SynapseRequestStatus) error
	StoreInterchainTransactionReceived(ctx context.Context, originChainID int, sr synapsemodule.SynapseModuleBatchVerificationRequested) error
}

Writer is the interface for writing to the database.