intent

Documentation

Index

• Variables
• func GetPaymentAmount(ctx context.Context, codeData codedata.Provider, intentID *commonpb.IntentId) (uint64, error)
• func LoadPaymentMetadata(ctx context.Context, codeData codedata.Provider, intentID *commonpb.IntentId, ...) (*codeintent.Record, error)
• type CustomAntispamGuard
  • func NewFlipchatAntispamGuard(accounts account.Store) CustomAntispamGuard
• type CustomHandler
• type FlipchatAntispamGuard
  • func (g *FlipchatAntispamGuard) AllowOpenAccounts(ctx context.Context, owner *codecommon.Account) (bool, string, error)
  • func (g *FlipchatAntispamGuard) AllowSendPayment(_ context.Context, _ *codecommon.Account, isPublic bool) (bool, string, error)
• type StatusCode
• type Store
• type ValidationResult

Variables

var (
	ErrNoPaymentMetadata      = errors.New("no payment metdata")
	ErrInvalidPaymentMetadata = errors.New("invalid payment metadata")
)

var (
	ErrAlreadyFulfilled = errors.New("intent id is already fulfilled")
)

Functions

func GetPaymentAmount

func GetPaymentAmount(ctx context.Context, codeData codedata.Provider, intentID *commonpb.IntentId) (uint64, error)

func LoadPaymentMetadata

func LoadPaymentMetadata(ctx context.Context, codeData codedata.Provider, intentID *commonpb.IntentId, dst proto.Message) (*codeintent.Record, error)

Types

type CustomAntispamGuard

type CustomAntispamGuard interface {
	AllowOpenAccounts(ctx context.Context, owner *codecommon.Account) (bool, string, error)

	AllowSendPayment(ctx context.Context, owner *codecommon.Account, isPublic bool) (bool, string, error)
}

func NewFlipchatAntispamGuard

func NewFlipchatAntispamGuard(accounts account.Store) CustomAntispamGuard

type CustomHandler

type CustomHandler interface {
	Validate(ctx context.Context, intentRecord *codeintent.Record, customMetadata proto.Message) (*ValidationResult, error)
}

todo: some way to register a handler to a proto URL

type FlipchatAntispamGuard

type FlipchatAntispamGuard struct {
	// contains filtered or unexported fields
}

func (*FlipchatAntispamGuard) AllowOpenAccounts

func (g *FlipchatAntispamGuard) AllowOpenAccounts(ctx context.Context, owner *codecommon.Account) (bool, string, error)

func (*FlipchatAntispamGuard) AllowSendPayment

func (g *FlipchatAntispamGuard) AllowSendPayment(_ context.Context, _ *codecommon.Account, isPublic bool) (bool, string, error)

type StatusCode

type StatusCode uint8

const (
	SUCCESS StatusCode = iota
	INVALID
	DENIED
)

type Store

type Store interface {
	IsFulfilled(ctx context.Context, id *commonpb.IntentId) (bool, error)

	MarkFulfilled(ctx context.Context, id *commonpb.IntentId) error
}

type ValidationResult

type ValidationResult struct {
	StatusCode       StatusCode
	ErrorDescription string
}