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

Variables

var ErrNoAddressNotFound = errors.New("record not found")

ErrNoAddressNotFound is returned when an address is not found.

Types

type BlacklistedAddress

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

	ID      string `gorm:"column:id;primaryKey" json:"id"`
	Type    string `gorm:"column:type"          json:"type"`
	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
}

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