Use interfaces

accounts/jobs.go

@@ -8,7 +8,7 @@ import (
 
 const AccountCreateJobType = "account_create"
 
-func (s *Service) executeAccountCreateJob(ctx context.Context, j *jobs.Job) error {
+func (s *ServiceImpl) executeAccountCreateJob(ctx context.Context, j *jobs.Job) error {
 	if j.Type != AccountCreateJobType {
 		return jobs.ErrInvalidJobType
 	}

accounts/options.go

@@ -2,10 +2,10 @@ package accounts
 
 import "go.uber.org/ratelimit"
 
-type ServiceOption func(*Service)
+type ServiceOption func(*ServiceImpl)
 
 func WithTxRatelimiter(limiter ratelimit.Limiter) ServiceOption {
-	return func(svc *Service) {
+	return func(svc *ServiceImpl) {
 		svc.txRateLimiter = limiter
 	}
 }

accounts/service.go

@@ -12,21 +12,29 @@ import (
 	"github.com/flow-hydraulics/flow-wallet-api/jobs"
 	"github.com/flow-hydraulics/flow-wallet-api/keys"
 	"github.com/onflow/flow-go-sdk"
-	"github.com/onflow/flow-go-sdk/client"
 	flow_templates "github.com/onflow/flow-go-sdk/templates"
 	log "github.com/sirupsen/logrus"
 	"go.uber.org/ratelimit"
 )
 
 const maxGasLimit = 9999
 
-// Service defines the API for account management.
-type Service struct {
+type Service interface {
+	List(limit, offset int) (result []Account, err error)
+	Create(ctx context.Context, sync bool) (*jobs.Job, *Account, error)
+	AddNonCustodialAccount(address string) (*Account, error)
+	DeleteNonCustodialAccount(address string) error
+	Details(address string) (Account, error)
+	InitAdminAccount(ctx context.Context) error
+}
+
+// ServiceImpl defines the API for account management.
+type ServiceImpl struct {
 	cfg           *configs.Config
 	store         Store
 	km            keys.Manager
-	fc            *client.Client
-	wp            *jobs.WorkerPool
+	fc            flow_helpers.FlowClient
+	wp            jobs.WorkerPool
 	txRateLimiter ratelimit.Limiter
 }
 
@@ -35,14 +43,14 @@ func NewService(
 	cfg *configs.Config,
 	store Store,
 	km keys.Manager,
-	fc *client.Client,
-	wp *jobs.WorkerPool,
+	fc flow_helpers.FlowClient,
+	wp jobs.WorkerPool,
 	opts ...ServiceOption,
-) *Service {
+) Service {
 	var defaultTxRatelimiter = ratelimit.NewUnlimited()
 
 	// TODO(latenssi): safeguard against nil config?
-	svc := &Service{cfg, store, km, fc, wp, defaultTxRatelimiter}
+	svc := &ServiceImpl{cfg, store, km, fc, wp, defaultTxRatelimiter}
 
 	for _, opt := range opts {
 		opt(svc)
@@ -59,7 +67,7 @@ func NewService(
 }
 
 // List returns all accounts in the datastore.
-func (s *Service) List(limit, offset int) (result []Account, err error) {
+func (s *ServiceImpl) List(limit, offset int) (result []Account, err error) {
 	o := datastore.ParseListOptions(limit, offset)
 	return s.store.Accounts(o)
 }
@@ -68,7 +76,7 @@ func (s *Service) List(limit, offset int) (result []Account, err error) {
 // It receives a new account with a corresponding private key or resource ID
 // and stores both in datastore.
 // It returns a job, the new account and a possible error.
-func (s *Service) Create(ctx context.Context, sync bool) (*jobs.Job, *Account, error) {
+func (s *ServiceImpl) Create(ctx context.Context, sync bool) (*jobs.Job, *Account, error) {
 	log.WithFields(log.Fields{"sync": sync}).Trace("Create account")
 
 	if !sync {
@@ -93,7 +101,7 @@ func (s *Service) Create(ctx context.Context, sync bool) (*jobs.Job, *Account, e
 	return nil, account, nil
 }
 
-func (s *Service) AddNonCustodialAccount(_ context.Context, address string) (*Account, error) {
+func (s *ServiceImpl) AddNonCustodialAccount(address string) (*Account, error) {
 	log.WithFields(log.Fields{"address": address}).Trace("Add non-custodial account")
 
 	a := &Account{
@@ -109,7 +117,7 @@ func (s *Service) AddNonCustodialAccount(_ context.Context, address string) (*Ac
 	return a, nil
 }
 
-func (s *Service) DeleteNonCustodialAccount(_ context.Context, address string) error {
+func (s *ServiceImpl) DeleteNonCustodialAccount(address string) error {
 	log.WithFields(log.Fields{"address": address}).Trace("Delete non-custodial account")
 
 	a, err := s.store.Account(flow_helpers.HexString(address))
@@ -130,7 +138,7 @@ func (s *Service) DeleteNonCustodialAccount(_ context.Context, address string) e
 }
 
 // Details returns a specific account, does not include private keys
-func (s *Service) Details(address string) (Account, error) {
+func (s *ServiceImpl) Details(address string) (Account, error) {
 	log.WithFields(log.Fields{"address": address}).Trace("Account details")
 
 	// Check if the input is a valid address
@@ -157,7 +165,7 @@ func (s *Service) Details(address string) (Account, error) {
 // generated key. Admin account is used to pay for the transaction.
 //
 // Returns created account and the flow transaction ID of the account creation.
-func (s *Service) createAccount(ctx context.Context) (*Account, string, error) {
+func (s *ServiceImpl) createAccount(ctx context.Context) (*Account, string, error) {
 	account := &Account{Type: AccountTypeCustodial}
 
 	// Important to ratelimit all the way up here so the keys and reference blocks

accounts/service_init.go

@@ -13,7 +13,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-func (s *Service) InitAdminAccount(ctx context.Context) error {
+func (s *ServiceImpl) InitAdminAccount(ctx context.Context) error {
 	log.Debug("Initializing admin account")
 
 	a, err := s.store.Account(s.cfg.AdminAddress)
@@ -64,7 +64,7 @@ func (s *Service) InitAdminAccount(ctx context.Context) error {
 	return nil
 }
 
-func (s *Service) addAdminProposalKeys(ctx context.Context, count uint16) error {
+func (s *ServiceImpl) addAdminProposalKeys(ctx context.Context, count uint16) error {
 
 	log.
 		WithFields(log.Fields{"count": count}).

accounts/store_gorm.go

@@ -9,7 +9,7 @@ type GormStore struct {
 	db *gorm.DB
 }
 
-func NewGormStore(db *gorm.DB) *GormStore {
+func NewGormStore(db *gorm.DB) Store {
 	return &GormStore{db}
 }
 

accounts/test_helpers.go

@@ -9,15 +9,14 @@ import (
 	"github.com/flow-hydraulics/flow-wallet-api/templates/template_strings"
 	"github.com/onflow/cadence"
 	"github.com/onflow/flow-go-sdk"
-	"github.com/onflow/flow-go-sdk/client"
 
 	flow_templates "github.com/onflow/flow-go-sdk/templates"
 )
 
 // AddContract is used only in tests
 func AddContract(
 	ctx context.Context,
-	fc *client.Client,
+	fc flow_helpers.FlowClient,
 	km keys.Manager,
 	accountAddress string,
 	contract flow_templates.Contract,

chain_events/event.go

@@ -1,12 +1,14 @@
 package chain_events
 
 import (
+	"context"
+
 	"github.com/onflow/flow-go-sdk"
 	log "github.com/sirupsen/logrus"
 )
 
 type handler interface {
-	Handle(flow.Event)
+	Handle(context.Context, flow.Event)
 }
 
 type event struct {
@@ -22,7 +24,7 @@ func (e *event) Register(handler handler) {
 }
 
 // Trigger sends out an event with the payload
-func (e *event) Trigger(payload flow.Event) {
+func (e *event) Trigger(ctx context.Context, payload flow.Event) {
 	log.
 		WithFields(log.Fields{"payload": payload}).
 		Trace("Handling Flow event")
@@ -32,6 +34,6 @@ func (e *event) Trigger(payload flow.Event) {
 	}
 
 	for _, handler := range e.handlers {
-		go handler.Handle(payload)
+		go handler.Handle(ctx, payload)
 	}
 }

chain_events/listener.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	wallet_errors "github.com/flow-hydraulics/flow-wallet-api/errors"
+	"github.com/flow-hydraulics/flow-wallet-api/flow_helpers"
 	"github.com/flow-hydraulics/flow-wallet-api/system"
 	"github.com/onflow/flow-go-sdk"
 	"github.com/onflow/flow-go-sdk/client"
@@ -16,17 +17,22 @@ import (
 
 type GetEventTypes func() ([]string, error)
 
-type Listener struct {
+type Listener interface {
+	Start() Listener
+	Stop()
+}
+
+type ListenerImpl struct {
 	ticker         *time.Ticker
 	stopChan       chan struct{}
-	fc             *client.Client
+	fc             flow_helpers.FlowClient
 	db             Store
 	getTypes       GetEventTypes
 	maxBlocks      uint64
 	interval       time.Duration
 	startingHeight uint64
 
-	systemService *system.Service
+	systemService system.Service
 }
 
 type ListenerStatus struct {
@@ -39,16 +45,16 @@ func (ListenerStatus) TableName() string {
 }
 
 func NewListener(
-	fc *client.Client,
+	fc flow_helpers.FlowClient,
 	db Store,
 	getTypes GetEventTypes,
 	maxDiff uint64,
 	interval time.Duration,
 	startingHeight uint64,
 	opts ...ListenerOption,
-) *Listener {
+) Listener {
 
-	listener := &Listener{
+	listener := &ListenerImpl{
 		ticker:         nil,
 		stopChan:       make(chan struct{}),
 		fc:             fc,
@@ -68,7 +74,7 @@ func NewListener(
 	return listener
 }
 
-func (l *Listener) run(ctx context.Context, start, end uint64) error {
+func (l *ListenerImpl) run(ctx context.Context, start, end uint64) error {
 	events := make([]flow.Event, 0)
 
 	eventTypes, err := l.getTypes()
@@ -91,13 +97,13 @@ func (l *Listener) run(ctx context.Context, start, end uint64) error {
 	}
 
 	for _, event := range events {
-		Event.Trigger(event)
+		Event.Trigger(ctx, event)
 	}
 
 	return nil
 }
 
-func (l *Listener) Start() *Listener {
+func (l *ListenerImpl) Start() Listener {
 	if l.ticker != nil {
 		// Already started
 		return l
@@ -194,7 +200,7 @@ func (l *Listener) Start() *Listener {
 	return l
 }
 
-func (l *Listener) initHeight() error {
+func (l *ListenerImpl) initHeight() error {
 	return l.db.LockedStatus(func(status *ListenerStatus) error {
 		if l.startingHeight > 0 && status.LatestHeight < l.startingHeight-1 {
 			status.LatestHeight = l.startingHeight - 1
@@ -215,7 +221,7 @@ func (l *Listener) initHeight() error {
 	})
 }
 
-func (l *Listener) Stop() {
+func (l *ListenerImpl) Stop() {
 	log.Debug("Stopping Flow event listener")
 
 	close(l.stopChan)
@@ -227,7 +233,7 @@ func (l *Listener) Stop() {
 	l.ticker = nil
 }
 
-func (l *Listener) systemHalted() (bool, error) {
+func (l *ListenerImpl) systemHalted() (bool, error) {
 	if l.systemService != nil {
 		return l.systemService.IsHalted()
 	}

chain_events/option.go

@@ -4,10 +4,10 @@ import (
 	"github.com/flow-hydraulics/flow-wallet-api/system"
 )
 
-type ListenerOption func(*Listener)
+type ListenerOption func(*ListenerImpl)
 
-func WithSystemService(svc *system.Service) ListenerOption {
-	return func(listener *Listener) {
+func WithSystemService(svc system.Service) ListenerOption {
+	return func(listener *ListenerImpl) {
 		listener.systemService = svc
 	}
 }

chain_events/store_gorm.go

@@ -8,7 +8,7 @@ type GormStore struct {
 	db *gorm.DB
 }
 
-func NewGormStore(db *gorm.DB) *GormStore {
+func NewGormStore(db *gorm.DB) Store {
 	return &GormStore{db}
 }