screener-api

command module

v0.4.1 Latest Latest Go to latest Published: May 9, 2024 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

Screening API

The screening api provides a simple restful interface for checking wether an address is blocked or not against a variety of data sources. Right now, two data sources are supported:

Blacklist URL: a json list of addresses that are blocked
TRM Labs: a list of rules that are used to determine if an address is blocked, can be different per "rule set"

Addresses themselves are checked against specific rulesets:

https://screener-url/[ruleset]/address/[address]

root
├── client: client library for using the screening api.
├── cmd: contains the command line interface to be used for the screener.
├── config: Yaml config struct/parsing.
├── db: db interface for the screener.
├── screener: screening code.
├── trmlabs: trm client stub.

Documentation ¶

Overview ¶

Package main provides the entry point for the screener-api.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
client Package client provides a client for the screener-api.	Package client provides a client for the screener-api.
cmd Package cmd provides the command line interface for the screener-api.	Package cmd provides the command line interface for the screener-api.
config Package config provides configuration for the screener-api.	Package config provides configuration for the screener-api.
db Package db provides the database interface for the screener-api.	Package db provides the database interface for the screener-api.
sql Package sql provides a sql store for the screener-api.	Package sql provides a sql store for the screener-api.
sql/base Package base provides a base store for the screener-api.	Package base provides a base store for the screener-api.
sql/mysql Package mysql provides a mysql store for the screener-api.	Package mysql provides a mysql store for the screener-api.
sql/sqlite Package sqlite provides a sqlite store for the screener-api.	Package sqlite provides a sqlite store for the screener-api.
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
metadata Package metadata provides a metadata service for the RFQ API.	Package metadata provides a metadata service for the RFQ API.
screener Package screener provides the screener api.	Package screener provides the screener api.
internal Package internal provides internal functionality for the screener-api.	Package internal provides internal functionality for the screener-api.
trmlabs Package trmlabs contains the implementation of the TRM Labs API client.	Package trmlabs contains the implementation of the TRM Labs API client.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL