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 BlacklistedAddress
• type BlacklistedAddressDB
• type BlacklistedAddressReaderDB
• type BlacklistedAddressWriterDB
• type DB
• 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 BlacklistedAddress

type BlacklistedAddress struct {
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`

	TypeReq string `gorm:"column:typereq"        json:"typereq"`
	ID      string `gorm:"column:id;primary_key" json:"id"`
	Data    string `gorm:"column:data"           json:"data"`
	Address string `gorm:"column:address"        json:"address"`
	Network string `gorm:"column:network"        json:"network"`
	Tag     string `gorm:"column:tag"            json:"tag"`
	Remark  string `gorm:"column:remark"         json:"remark"`
}

BlacklistedAddress is a blacklisted address.

type BlacklistedAddressDB

type BlacklistedAddressDB interface {
	BlacklistedAddressWriterDB
	BlacklistedAddressReaderDB
}

BlacklistedAddressDB is the interface for reading and writing blacklisted addresses to the database.

type BlacklistedAddressReaderDB

type BlacklistedAddressReaderDB interface {
	GetBlacklistedAddress(ctx context.Context, address string) (*BlacklistedAddress, error)
}

BlacklistedAddressReaderDB provides methods to read blacklisted addresses from the database.

type BlacklistedAddressWriterDB

type BlacklistedAddressWriterDB interface {
	PutBlacklistedAddress(ctx context.Context, body BlacklistedAddress) error
	DeleteBlacklistedAddress(ctx context.Context, id string) error
	UpdateBlacklistedAddress(ctx context.Context, id string, body BlacklistedAddress) error
}

BlacklistedAddressWriterDB provides methods to write blacklisted addresses to the database.

type DB

type DB interface {
	BlacklistedAddressDB
	RuleDB
}

DB is the general database interface for the screener-api.

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.