client

Documentation

Overview

Package client provides a client for the screener-api.

Index

• func GenerateSignature(secret, message string) string
• type BlackListBody
• type Data
• type ScreenerClient
  • func NewClient(metricHandler metrics.Handler, screenerURL string) (ScreenerClient, error)
  • func NewNoOpClient() (ScreenerClient, error)

Functions

func GenerateSignature

func GenerateSignature(secret, message string) string

GenerateSignature generates a signature for the request.

Types

type BlackListBody

type BlackListBody struct {
	Type string `json:"type"`
	ID   string `json:"id"`
	Data Data   `json:"data"`
}

BlackListBody is the json payload that represents a blacklisted address.

type Data

type Data struct {
	Address string `json:"address"`
	Network string `json:"network"`
	Tag     string `json:"tag"`
	Remark  string `json:"remark"`
}

Data is the data field in the BlackListBody.

type ScreenerClient

type ScreenerClient interface {
	ScreenAddress(ctx context.Context, address string) (blocked bool, err error)
	BlacklistAddress(ctx context.Context, appsecret string, appid string, body BlackListBody) (string, error)
}

ScreenerClient is an interface for the Screener API.

func NewClient

func NewClient(metricHandler metrics.Handler, screenerURL string) (ScreenerClient, error)

NewClient creates a new client for the Screener API.

func NewNoOpClient

func NewNoOpClient() (ScreenerClient, error)

NewNoOpClient creates a new no-op client for the Screener API. it returns false for every address.