Update antispam guard to be an app integration

Author: Jeff Yanta

pkg/code/antispam/airdrop.go

@@ -1,26 +1,86 @@
 package antispam
 
 import (
-	"github.com/sirupsen/logrus"
+	"context"
 
-	code_data "github.com/code-payments/code-server/pkg/code/data"
+	"github.com/code-payments/code-server/pkg/code/common"
+	"github.com/code-payments/code-server/pkg/metrics"
 )
 
-// Guard is an antispam guard that checks whether operations of interest are
-// allowed to be performed.
-//
-// Note: Implementation assumes distributed locking has already occurred for
-// all methods.
 type Guard struct {
-	log  *logrus.Entry
-	data code_data.Provider
+	integration Integration
 }
 
-func NewGuard(
-	data code_data.Provider,
-) *Guard {
-	return &Guard{
-		log:  logrus.StandardLogger().WithField("type", "antispam/guard"),
-		data: data,
+func NewGuard(integration Integration) *Guard {
+	return &Guard{integration: integration}
+}
+
+func (g *Guard) AllowOpenAccounts(ctx context.Context, owner *common.Account) (bool, error) {
+	tracer := metrics.TraceMethodCall(ctx, metricsStructName, "AllowOpenAccounts")
+	defer tracer.End()
+
+	allow, reason, err := g.integration.AllowOpenAccounts(ctx, owner)
+	if err != nil {
+		return false, err
+	}
+	if !allow {
+		recordDenialEvent(ctx, actionOpenAccounts, reason)
+	}
+	return allow, nil
+}
+
+func (g *Guard) AllowWelcomeBonus(ctx context.Context, owner *common.Account) (bool, error) {
+	tracer := metrics.TraceMethodCall(ctx, metricsStructName, "AllowWelcomeBonus")
+	defer tracer.End()
+
+	allow, reason, err := g.integration.AllowWelcomeBonus(ctx, owner)
+	if err != nil {
+		return false, err
+	}
+	if !allow {
+		recordDenialEvent(ctx, actionWelcomeBonus, reason)
+	}
+	return allow, nil
+}
+
+func (g *Guard) AllowSendPayment(ctx context.Context, owner, destination *common.Account, isPublic bool) (bool, error) {
+	tracer := metrics.TraceMethodCall(ctx, metricsStructName, "AllowSendPayment")
+	defer tracer.End()
+
+	allow, reason, err := g.integration.AllowSendPayment(ctx, owner, destination, isPublic)
+	if err != nil {
+		return false, err
+	}
+	if !allow {
+		recordDenialEvent(ctx, actionSendPayment, reason)
+	}
+	return allow, nil
+}
+
+func (g *Guard) AllowReceivePayments(ctx context.Context, owner *common.Account, isPublic bool) (bool, error) {
+	tracer := metrics.TraceMethodCall(ctx, metricsStructName, "AllowReceivePayments")
+	defer tracer.End()
+
+	allow, reason, err := g.integration.AllowReceivePayments(ctx, owner, isPublic)
+	if err != nil {
+		return false, err
+	}
+	if !allow {
+		recordDenialEvent(ctx, actionReceivePayments, reason)
+	}
+	return allow, nil
+}
+
+func (g *Guard) AllowSwap(ctx context.Context, owner *common.Account) (bool, error) {
+	tracer := metrics.TraceMethodCall(ctx, metricsStructName, "AllowSwap")
+	defer tracer.End()
+
+	allow, reason, err := g.integration.AllowSwap(ctx, owner)
+	if err != nil {
+		return false, err
+	}
+	if !allow {
+		recordDenialEvent(ctx, actionSwap, reason)
 	}
+	return allow, nil
 }

pkg/code/antispam/guard.go

@@ -0,0 +1,49 @@
+package antispam
+
+import (
+	"context"
+
+	"github.com/code-payments/code-server/pkg/code/common"
+)
+
+// Integration is an antispam guard integration that apps can implement to check
+// whether operations of interest are allowed to be performed.
+type Integration interface {
+	AllowOpenAccounts(ctx context.Context, owner *common.Account) (bool, string, error)
+
+	AllowWelcomeBonus(ctx context.Context, owner *common.Account) (bool, string, error)
+
+	AllowSendPayment(ctx context.Context, owner, destination *common.Account, isPublic bool) (bool, string, error)
+
+	AllowReceivePayments(ctx context.Context, owner *common.Account, isPublic bool) (bool, string, error)
+
+	AllowSwap(ctx context.Context, owner *common.Account) (bool, string, error)
+}
+
+type allowEverythingIntegration struct {
+}
+
+// NewAllowEverything returns a default antispam integration that allows everything
+func NewAllowEverything() Integration {
+	return &allowEverythingIntegration{}
+}
+
+func (i *allowEverythingIntegration) AllowOpenAccounts(ctx context.Context, owner *common.Account) (bool, string, error) {
+	return true, "", nil
+}
+
+func (i *allowEverythingIntegration) AllowWelcomeBonus(ctx context.Context, owner *common.Account) (bool, string, error) {
+	return true, "", nil
+}
+
+func (i *allowEverythingIntegration) AllowSendPayment(ctx context.Context, owner, destination *common.Account, isPublic bool) (bool, string, error) {
+	return true, "", nil
+}
+
+func (i *allowEverythingIntegration) AllowReceivePayments(ctx context.Context, owner *common.Account, isPublic bool) (bool, string, error) {
+	return true, "", nil
+}
+
+func (i *allowEverythingIntegration) AllowSwap(ctx context.Context, owner *common.Account) (bool, string, error) {
+	return true, "", nil
+}

pkg/code/antispam/integration.go

@@ -15,8 +15,7 @@ const (
 	actionSendPayment     = "SendPayment"
 	actionReceivePayments = "ReceivePayments"
 
-	actionWelcomeBonus  = "WelcomeBonus"
-	actionReferralBonus = "ReferralBonus"
+	actionWelcomeBonus = "WelcomeBonus"
 
 	actionSwap = "Swap"
 )

pkg/code/antispam/intent.go

@@ -381,7 +381,7 @@ func (h *SendPublicPaymentIntentHandler) AllowCreation(ctx context.Context, inte
 			return err
 		}
 
-		allow, err := h.antispamGuard.AllowSendPayment(ctx, initiatiorOwnerAccount, true, destination)
+		allow, err := h.antispamGuard.AllowSendPayment(ctx, initiatiorOwnerAccount, destination, true)
 		if err != nil {
 			return err
 		} else if !allow {