db

Documentation

Overview

Package db provides the database interface for the screener-api.

Package db provides the database interface for the screener-api.

Index

• Variables
• type AddressIndicators
  • func MakeRecord(address string, records []trmlabs.AddressRiskIndicator) *AddressIndicators
• type RuleDB
• type RuleReaderDB
• type RuleWriterDB

Variables

var ErrNoAddressNotCached = errors.New("address not cached")

ErrNoAddressNotCached is returned when an address is not cached.

Types

type AddressIndicators

type AddressIndicators struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	// Address is the address to be screened
	Address string `gorm:"column:address;primary_key"`
	// RiskIndicators is the list of categories for the address
	Indicators addressRiskIndicators `gorm:"column:indicators"`
}

AddressIndicators is the address indicators for a given address.

func MakeRecord

func MakeRecord(address string, records []trmlabs.AddressRiskIndicator) *AddressIndicators

MakeRecord creates a new address indicators record.

type RuleDB

type RuleDB interface {
	RuleWriterDB
	RuleReaderDB
}

RuleDB is the interface for reading and writing rules to the database.

type RuleReaderDB

type RuleReaderDB interface {
	GetAddressIndicators(ctx context.Context, address string, since time.Time) ([]trmlabs.AddressRiskIndicator, error)
}

RuleReaderDB is the interface for reading rules from the database.

type RuleWriterDB

type RuleWriterDB interface {
	PutAddressIndicators(ctx context.Context, address string, riskIndicator []trmlabs.AddressRiskIndicator) error
}

RuleWriterDB is the interface for writing rules to the database.