escrow

Documentation

Index

• Variables
• type Escrow
• type FarmAPI
• type Free
  • func NewFree(db *mongo.Database) *Free
  • func (e *Free) CapacityReservation(reservation capacitytypes.Reservation, _ []string) (detail types.CustomerCapacityEscrowInformation, err error)
  • func (e *Free) PaidCapacity() <-chan schema.ID
  • func (e *Free) RegisterReservation(reservation workloads.Reservation, _ []string) (detail types.CustomerEscrowInformation, err error)
  • func (e *Free) ReservationCanceled(reservationID schema.ID)
  • func (e *Free) ReservationDeployed(reservationID schema.ID)
  • func (e *Free) Run(ctx context.Context) error
• type NodeAPI
• type Stellar
  • func NewStellar(wallet *stellar.Wallet, db *mongo.Database, foundationAddress string) *Stellar
  • func (e *Stellar) CapacityReservation(reservation capacitytypes.Reservation, supportedCurrencies []string) (types.CustomerCapacityEscrowInformation, error)
  • func (e *Stellar) PaidCapacity() <-chan schema.ID
  • func (e *Stellar) RegisterReservation(reservation workloads.Reservation, supportedCurrencies []string) (types.CustomerEscrowInformation, error)
  • func (e *Stellar) ReservationCanceled(reservationID schema.ID)
  • func (e *Stellar) ReservationDeployed(reservationID schema.ID)
  • func (e *Stellar) Run(ctx context.Context) error

Variables

var (
	// ErrNoCurrencySupported indicates a reservation was offered but none of the currencies
	// the farmer wants to pay in are currently supported
	ErrNoCurrencySupported = errors.New("none of the offered currencies are currently supported")
	// ErrNoCurrencyShared indicates that none of the currencies offered in the reservation
	// is supported by all farmers used
	ErrNoCurrencyShared = errors.New("none of the provided currencies is supported by all farmers")
)

Types

type Escrow

type Escrow interface {
	Run(ctx context.Context) error
	RegisterReservation(reservation workloads.Reservation, supportedCurrencies []string) (types.CustomerEscrowInformation, error)
	ReservationDeployed(reservationID schema.ID)
	ReservationCanceled(reservationID schema.ID)
	CapacityReservation(reservation capacitytypes.Reservation, supportedCurrencies []string) (types.CustomerCapacityEscrowInformation, error)
	PaidCapacity() <-chan schema.ID
}

Escrow are responsible for the payment flow of a reservation

type FarmAPI

type FarmAPI interface {
	// GetByID get a farm from the database using its ID
	GetByID(ctx context.Context, db *mongo.Database, id int64) (directorytypes.Farm, error)
}

FarmAPI operations on farm database

type Free

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

Free implements the Escrow interface in a way that makes all reservation free

func NewFree

func NewFree(db *mongo.Database) *Free

NewFree creates a new EscrowFree object

func (*Free) CapacityReservation

func (e *Free) CapacityReservation(reservation capacitytypes.Reservation, _ []string) (detail types.CustomerCapacityEscrowInformation, err error)

CapacityReservation implements the escrow interface

func (*Free) PaidCapacity

func (e *Free) PaidCapacity() <-chan schema.ID

PaidCapacity implements the escrow interface

func (*Free) RegisterReservation

func (e *Free) RegisterReservation(reservation workloads.Reservation, _ []string) (detail types.CustomerEscrowInformation, err error)

RegisterReservation implements the escrow interface

func (*Free) ReservationCanceled

func (e *Free) ReservationCanceled(reservationID schema.ID)

ReservationCanceled implements the escrow interface

func (*Free) ReservationDeployed

func (e *Free) ReservationDeployed(reservationID schema.ID)

ReservationDeployed implements the escrow interface

func (*Free) Run

func (e *Free) Run(ctx context.Context) error

Run implements the escrow interface

type NodeAPI

type NodeAPI interface {
	// Get a node from the database using its ID
	Get(ctx context.Context, db *mongo.Database, id string, proofs bool) (directorytypes.Node, error)
}

NodeAPI operations on node database

type Stellar

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

Stellar service manages a dedicate wallet for payments for reservations.

func NewStellar

func NewStellar(wallet *stellar.Wallet, db *mongo.Database, foundationAddress string) *Stellar

NewStellar creates a new escrow object and fetches all addresses for the escrow wallet

func (*Stellar) CapacityReservation

func (e *Stellar) CapacityReservation(reservation capacitytypes.Reservation, supportedCurrencies []string) (types.CustomerCapacityEscrowInformation, error)

CapacityReservation implements Escrow

func (*Stellar) PaidCapacity

func (e *Stellar) PaidCapacity() <-chan schema.ID

PaidCapacity implements Escrow

func (*Stellar) RegisterReservation

func (e *Stellar) RegisterReservation(reservation workloads.Reservation, supportedCurrencies []string) (types.CustomerEscrowInformation, error)

RegisterReservation registers a workload reservation

func (*Stellar) ReservationCanceled

func (e *Stellar) ReservationCanceled(reservationID schema.ID)

ReservationCanceled informs the escrow of a canceled reservation so it can refund the user

func (*Stellar) ReservationDeployed

func (e *Stellar) ReservationDeployed(reservationID schema.ID)

ReservationDeployed informs the escrow that a reservation has been successfully deployed, so the escrow can release the funds to the farmer (and refund any excess)

func (*Stellar) Run

func (e *Stellar) Run(ctx context.Context) error

Run the escrow until the context is done