Categorygithub.com/synapsecns/sanguine/contrib/screener-api
modulepackage
1.8.0
Repository: https://github.com/synapsecns/sanguine.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
3
Dependents
0
Files
9 SLOC

# README

Screening API

Go Reference Go Report Card

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

  • Blacklist URL: a json list of addresses that are blocked
  • Chainalysis: the Entity API runs a screen against an address to quantify the risk associated with it, Severe, High, Medium, or Low.

Addresses themselves are checked against specific rulesets:

https://screener-url/[address]

root
├── chainalysis: chainalysis client stub.
├── 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.

# Packages

Package chainalysis contains the implementation of the Chainalysis API client.
Package client provides a client for the screener-api.
Package cmd provides the command line interface for the screener-api.
Package config provides configuration for the screener-api.
Package db provides the database interface for the screener-api.
Package docs Code generated by swaggo/swag.
Package metadata provides a metadata service for the RFQ API.
Package screener provides the screener api.