Documentation ¶
Index ¶
- Variables
- type Chore
- type Config
- type CouponUsage
- type CouponUsagePage
- type CouponUsageStatus
- type CouponsDB
- type CreateProjectRecord
- type Customer
- type CustomersDB
- type CustomersPage
- type DB
- type Endpoint
- func (endpoint *Endpoint) ApplyInvoiceCoupons(ctx context.Context, req *pb.ApplyInvoiceCouponsRequest) (_ *pb.ApplyInvoiceCouponsResponse, err error)
- func (endpoint *Endpoint) ApplyInvoiceRecords(ctx context.Context, req *pb.ApplyInvoiceRecordsRequest) (_ *pb.ApplyInvoiceRecordsResponse, err error)
- func (endpoint *Endpoint) CreateInvoices(ctx context.Context, req *pb.CreateInvoicesRequest) (_ *pb.CreateInvoicesResponse, err error)
- func (endpoint *Endpoint) PrepareInvoiceRecords(ctx context.Context, req *pb.PrepareInvoiceRecordsRequest) (_ *pb.PrepareInvoiceRecordsResponse, err error)
- type ProjectRecord
- type ProjectRecordsDB
- type ProjectRecordsPage
- type Service
- func (service *Service) Accounts() payments.Accounts
- func (service *Service) AddCoupon(ctx context.Context, userID, projectID uuid.UUID, amount int64, duration int, ...) (err error)
- func (service *Service) CreateInvoices(ctx context.Context) (err error)
- func (service *Service) GetRate(ctx context.Context, curr1, curr2 coinpayments.Currency) (_ *big.Float, err error)
- func (service *Service) InvoiceApplyCoupons(ctx context.Context) (err error)
- func (service *Service) InvoiceApplyProjectRecords(ctx context.Context) (err error)
- func (service *Service) PrepareInvoiceProjectRecords(ctx context.Context, period time.Time) (err error)
- func (service *Service) UpdateRates(ctx context.Context) (err error)
- type Transaction
- type TransactionUpdate
- type TransactionsDB
- type TransactionsPage
- type VersionService
Constants ¶
This section is empty.
Variables ¶
var ( // Error defines stripecoinpayments service error. Error = errs.Class("stripecoinpayments service error") // ErrNoCouponUsages indicates that there are no coupon usages. ErrNoCouponUsages = errs.Class("stripecoinpayments no coupon usages") )
var ErrChore = errs.Class("stripecoinpayments chore error")
ErrChore is stripecoinpayments clearing loop chore error class.
var ErrNoCustomer = Error.New("customer doesn't exist")
ErrNoCustomer is error class defining that there is no customer for user.
var ErrProjectRecordExists = Error.New("invoice project record already exists")
ErrProjectRecordExists is error class defining that such project record already exists.
var ErrVersion = errs.Class("version service error")
ErrVersion defines version service error.
Functions ¶
This section is empty.
Types ¶
type Chore ¶ added in v0.25.0
type Chore struct { TransactionCycle sync2.Cycle CouponUsageCycle sync2.Cycle AccountBalanceCycle sync2.Cycle // contains filtered or unexported fields }
Chore runs clearing process of reconciling transactions deposits, customer balance, invoices and usages.
architecture: Chore
func NewChore ¶ added in v0.25.0
func NewChore(log *zap.Logger, service *Service, txInterval, accBalanceInterval time.Duration) *Chore
NewChore creates new clearing loop chore. TODO: uncomment new interval when coupons will be finished.
type Config ¶
type Config struct { StripeSecretKey string `help:"stripe API secret key" default:""` StripePublicKey string `help:"stripe API public key" default:""` CoinpaymentsPublicKey string `help:"coinpayments API public key" default:""` CoinpaymentsPrivateKey string `help:"coinpayments API private key key" default:""` TransactionUpdateInterval time.Duration `help:"amount of time we wait before running next transaction update loop" devDefault:"1m" releaseDefault:"30m"` AccountBalanceUpdateInterval time.Duration `help:"amount of time we wait before running next account balance update loop" devDefault:"3m" releaseDefault:"1h30m"` ConversionRatesCycleInterval time.Duration `help:"amount of time we wait before running next conversion rates update loop" devDefault:"1m" releaseDefault:"10m"` }
Config stores needed information for payment service initialization.
type CouponUsage ¶ added in v0.27.0
type CouponUsage struct { CouponID uuid.UUID Amount int64 Status CouponUsageStatus Period time.Time }
CouponUsage stores amount of money that should be charged from coupon for billing period.
type CouponUsagePage ¶ added in v0.30.0
type CouponUsagePage struct { Usages []CouponUsage Next bool NextOffset int64 }
CouponUsagePage holds coupons usages and indicates if there is more data available and provides next offset.
type CouponUsageStatus ¶ added in v0.30.0
type CouponUsageStatus int
CouponUsageStatus indicates the state of the coupon usage.
const ( // CouponUsageStatusUnapplied is a default coupon usage state. CouponUsageStatusUnapplied CouponUsageStatus = 0 // CouponUsageStatusApplied status indicates that coupon usage was used. CouponUsageStatusApplied CouponUsageStatus = 1 )
type CouponsDB ¶ added in v0.27.0
type CouponsDB interface { // Insert inserts a coupon into the database. Insert(ctx context.Context, coupon payments.Coupon) error // Update updates coupon in database. Update(ctx context.Context, couponID uuid.UUID, status payments.CouponStatus) error // Get returns coupon by ID. Get(ctx context.Context, couponID uuid.UUID) (payments.Coupon, error) // List returns all coupons with specified status. List(ctx context.Context, status payments.CouponStatus) ([]payments.Coupon, error) // ListByUserID returns all coupons of specified user. ListByUserID(ctx context.Context, userID uuid.UUID) ([]payments.Coupon, error) // ListByUserIDAndStatus returns all coupons of specified user and status. ListByUserIDAndStatus(ctx context.Context, userID uuid.UUID, status payments.CouponStatus) ([]payments.Coupon, error) // ListByProjectID returns all active coupons for specified project. ListByProjectID(ctx context.Context, projectID uuid.UUID) ([]payments.Coupon, error) // ListPending returns paginated list of coupons with specified status. ListPaged(ctx context.Context, offset int64, limit int, before time.Time, status payments.CouponStatus) (payments.CouponsPage, error) // AddUsage creates new coupon usage record in database. AddUsage(ctx context.Context, usage CouponUsage) error // TotalUsage gets sum of all usage records for specified coupon. TotalUsage(ctx context.Context, couponID uuid.UUID) (int64, error) // GetLatest return period_end of latest coupon charge. GetLatest(ctx context.Context, couponID uuid.UUID) (time.Time, error) // ListUnapplied returns coupon usage page with unapplied coupon usages. ListUnapplied(ctx context.Context, offset int64, limit int, before time.Time) (CouponUsagePage, error) // ApplyUsage applies coupon usage and updates its status. ApplyUsage(ctx context.Context, couponID uuid.UUID, period time.Time) error }
CouponsDB is an interface for managing coupons table.
architecture: Database
type CreateProjectRecord ¶ added in v0.25.0
type CreateProjectRecord struct { ProjectID uuid.UUID Storage float64 Egress int64 Objects float64 }
CreateProjectRecord holds info needed for creation new invoice project record.
type CustomersDB ¶
type CustomersDB interface { // Insert inserts a stripe customer into the database. Insert(ctx context.Context, userID uuid.UUID, customerID string) error // GetCustomerID return stripe customers id. GetCustomerID(ctx context.Context, userID uuid.UUID) (string, error) // List returns page with customers ids created before specified date. List(ctx context.Context, offset int64, limit int, before time.Time) (CustomersPage, error) }
CustomersDB is interface for working with stripe customers table.
architecture: Database
type CustomersPage ¶ added in v0.25.0
CustomersPage holds customers and indicates if there is more data available and provides next offset.
type DB ¶ added in v0.25.0
type DB interface { // Customers is getter for customers db. Customers() CustomersDB // Transactions is getter for transactions db. Transactions() TransactionsDB // ProjectRecords is getter for invoice project records db. ProjectRecords() ProjectRecordsDB // CouponsDB is getter for coupons db. Coupons() CouponsDB }
DB is stripecoinpayments DB interface.
architecture: Database
type Endpoint ¶ added in v0.25.0
type Endpoint struct {
// contains filtered or unexported fields
}
Endpoint is stripecoinpayments private RPC server payments endpoint.
func NewEndpoint ¶ added in v0.25.0
NewEndpoint creates new endpoint.
func (*Endpoint) ApplyInvoiceCoupons ¶ added in v0.30.0
func (endpoint *Endpoint) ApplyInvoiceCoupons(ctx context.Context, req *pb.ApplyInvoiceCouponsRequest) (_ *pb.ApplyInvoiceCouponsResponse, err error)
ApplyInvoiceCoupons creates stripe line items for all unapplied coupons.
func (*Endpoint) ApplyInvoiceRecords ¶ added in v0.25.0
func (endpoint *Endpoint) ApplyInvoiceRecords(ctx context.Context, req *pb.ApplyInvoiceRecordsRequest) (_ *pb.ApplyInvoiceRecordsResponse, err error)
ApplyInvoiceRecords creates stripe line items for all unapplied invoice project records.
func (*Endpoint) CreateInvoices ¶ added in v0.25.0
func (endpoint *Endpoint) CreateInvoices(ctx context.Context, req *pb.CreateInvoicesRequest) (_ *pb.CreateInvoicesResponse, err error)
CreateInvoices creates invoice for all user accounts on the satellite.
func (*Endpoint) PrepareInvoiceRecords ¶ added in v0.25.0
func (endpoint *Endpoint) PrepareInvoiceRecords(ctx context.Context, req *pb.PrepareInvoiceRecordsRequest) (_ *pb.PrepareInvoiceRecordsResponse, err error)
PrepareInvoiceRecords creates project invoice records for all satellite projects.
type ProjectRecord ¶ added in v0.25.0
type ProjectRecord struct { ID uuid.UUID ProjectID uuid.UUID Storage float64 Egress int64 Objects float64 PeriodStart time.Time PeriodEnd time.Time }
ProjectRecord holds project usage particular for billing period.
type ProjectRecordsDB ¶ added in v0.25.0
type ProjectRecordsDB interface { // Create creates new invoice project record with coupon usages in the DB. Create(ctx context.Context, records []CreateProjectRecord, couponUsages []CouponUsage, start, end time.Time) error // Check checks if invoice project record for specified project and billing period exists. Check(ctx context.Context, projectID uuid.UUID, start, end time.Time) error // Get returns record for specified project and billing period. Get(ctx context.Context, projectID uuid.UUID, start, end time.Time) (*ProjectRecord, error) // Consume consumes invoice project record. Consume(ctx context.Context, id uuid.UUID) error // ListUnapplied returns project records page with unapplied project records. ListUnapplied(ctx context.Context, offset int64, limit int, before time.Time) (ProjectRecordsPage, error) }
ProjectRecordsDB is interface for working with invoice project records.
architecture: Database
type ProjectRecordsPage ¶ added in v0.25.0
type ProjectRecordsPage struct { Records []ProjectRecord Next bool NextOffset int64 }
ProjectRecordsPage holds project records and indicates if there is more data available and provides next offset.
type Service ¶
type Service struct { PerObjectPrice int64 EgressPrice int64 TBhPrice int64 // contains filtered or unexported fields }
Service is an implementation for payment service via Stripe and Coinpayments.
architecture: Service
func NewService ¶
func NewService(log *zap.Logger, config Config, db DB, projectsDB console.Projects, usageDB accounting.ProjectAccounting, perObjectPrice, egressPrice, tbhPrice int64) *Service
NewService creates a Service instance.
func (*Service) AddCoupon ¶ added in v0.27.0
func (service *Service) AddCoupon(ctx context.Context, userID, projectID uuid.UUID, amount int64, duration int, description string, couponType payments.CouponType) (err error)
AddCoupon attaches a coupon for payment account.
func (*Service) CreateInvoices ¶ added in v0.25.0
CreateInvoices lists through all customers and creates invoices.
func (*Service) GetRate ¶ added in v0.26.0
func (service *Service) GetRate(ctx context.Context, curr1, curr2 coinpayments.Currency) (_ *big.Float, err error)
GetRate returns conversion rate for specified currencies.
func (*Service) InvoiceApplyCoupons ¶ added in v0.27.0
InvoiceApplyCoupons iterates through unapplied project coupons and creates invoice line items for stripe customer.
func (*Service) InvoiceApplyProjectRecords ¶ added in v0.25.0
InvoiceApplyProjectRecords iterates through unapplied invoice project records and creates invoice line items for stripe customer.
type Transaction ¶
type Transaction struct { ID coinpayments.TransactionID AccountID uuid.UUID Address string Amount big.Float Received big.Float Status coinpayments.Status Key string Timeout time.Duration CreatedAt time.Time }
Transaction defines coinpayments transaction info that is stored in the DB.
type TransactionUpdate ¶
type TransactionUpdate struct { TransactionID coinpayments.TransactionID Status coinpayments.Status Received big.Float }
TransactionUpdate holds transaction update info.
type TransactionsDB ¶
type TransactionsDB interface { // Insert inserts new coinpayments transaction into DB. Insert(ctx context.Context, tx Transaction) (*Transaction, error) // Update updates status and received for set of transactions. Update(ctx context.Context, updates []TransactionUpdate, applies coinpayments.TransactionIDList) error // Consume marks transaction as consumed, so it won't participate in apply account balance loop. Consume(ctx context.Context, id coinpayments.TransactionID) error // LockRate locks conversion rate for transaction. LockRate(ctx context.Context, id coinpayments.TransactionID, rate *big.Float) error // GetLockedRate returns locked conversion rate for transaction or error if non exists. GetLockedRate(ctx context.Context, id coinpayments.TransactionID) (*big.Float, error) // ListAccount returns all transaction for specific user. ListAccount(ctx context.Context, userID uuid.UUID) ([]Transaction, error) // ListPending returns TransactionsPage with pending transactions. ListPending(ctx context.Context, offset int64, limit int, before time.Time) (TransactionsPage, error) // List Unapplied returns TransactionsPage with completed transaction that should be applied to account balance. ListUnapplied(ctx context.Context, offset int64, limit int, before time.Time) (TransactionsPage, error) }
TransactionsDB is an interface which defines functionality of DB which stores coinpayments transactions.
architecture: Database
type TransactionsPage ¶
type TransactionsPage struct { Transactions []Transaction Next bool NextOffset int64 }
TransactionsPage holds set of transaction and indicates if there are more transactions to fetch.
func (*TransactionsPage) IDList ¶
func (page *TransactionsPage) IDList() coinpayments.TransactionIDList
IDList returns transaction id list of page's transactions.
type VersionService ¶ added in v0.26.0
VersionService updates conversion rates in a loop.
architecture: Service
func NewVersionService ¶ added in v0.26.0
NewVersionService creates new instance of VersionService.
func (*VersionService) Close ¶ added in v0.26.0
func (version *VersionService) Close() (err error)
Close closes underlying cycle.