fraud

Documentation

Index

• func ConstructModule(tp node.Type) fx.Option
• func Lifecycle(startCtx, lifecycleCtx context.Context, p fraud.ProofType, ...) error
• type API
  • func (api *API) Get(ctx context.Context, proofType fraud.ProofType) ([]Proof, error)
  • func (api *API) Subscribe(ctx context.Context, proofType fraud.ProofType) (<-chan Proof, error)
• type Module
• type Proof
  • func (f *Proof) MarshalJSON() ([]byte, error)
  • func (f *Proof) UnmarshalJSON(data []byte) error
• type Service
  • func (s *Service) Get(ctx context.Context, proofType fraud.ProofType) ([]Proof, error)
  • func (s *Service) Subscribe(ctx context.Context, proofType fraud.ProofType) (<-chan Proof, error)

Functions

func ConstructModule

func ConstructModule(tp node.Type) fx.Option

func Lifecycle

func Lifecycle(
	startCtx, lifecycleCtx context.Context,
	p fraud.ProofType,
	fraudServ fraud.Service,
	start, stop func(context.Context) error,
) error

Lifecycle controls the lifecycle of service depending on fraud proofs. It starts the service only if no fraud-proof exists and stops the service automatically if a proof arrives after the service was started.

Types

type API

type API struct {
	Internal struct {
		Subscribe func(context.Context, fraud.ProofType) (<-chan Proof, error) `perm:"public"`
		Get       func(context.Context, fraud.ProofType) ([]Proof, error)      `perm:"public"`
	}
}

API is a wrapper around Module for the RPC. TODO(@distractedm1nd): These structs need to be autogenerated.

func (*API) Get

func (api *API) Get(ctx context.Context, proofType fraud.ProofType) ([]Proof, error)

func (*API) Subscribe

func (api *API) Subscribe(ctx context.Context, proofType fraud.ProofType) (<-chan Proof, error)

type Module

type Module interface {
	// Subscribe allows to subscribe on a Proof pub sub topic by its type.
	Subscribe(context.Context, fraud.ProofType) (<-chan Proof, error)
	// Get fetches fraud proofs from the disk by its type.
	Get(context.Context, fraud.ProofType) ([]Proof, error)
}

Module encompasses the behavior necessary to subscribe and broadcast fraud proofs within the network. Any method signature changed here needs to also be changed in the API struct.

type Proof

type Proof struct {
	fraud.Proof
}

Proof embeds the fraud.Proof interface type to provide a concrete type for JSON serialization.

func (*Proof) MarshalJSON

func (f *Proof) MarshalJSON() ([]byte, error)

func (*Proof) UnmarshalJSON

func (f *Proof) UnmarshalJSON(data []byte) error

type Service

type Service struct {
	fraud.Service
}

Service is an implementation of Module that uses fraud.Service as a backend. It is used to provide fraud proofs as a non-interface type to the API, and wrap fraud.Subscriber with a channel of Proofs.

func (*Service) Get

func (s *Service) Get(ctx context.Context, proofType fraud.ProofType) ([]Proof, error)

func (*Service) Subscribe

func (s *Service) Subscribe(ctx context.Context, proofType fraud.ProofType) (<-chan Proof, error)