vouchers

Documentation

Index

• Variables
• type Config
• type Endpoint
  • func NewEndpoint(log *zap.Logger, satellite signing.Signer, overlay *overlay.Service, ...) *Endpoint
  • func (endpoint *Endpoint) Request(ctx context.Context, req *pb.VoucherRequest) (_ *pb.VoucherResponse, err error)

Variables

var (
	// Error the default vouchers errs class
	Error = errs.Class("vouchers error")
)

Types

type Config

type Config struct {
	Expiration time.Duration `help:"length of time before a voucher expires" default:"720h0m0s"`
}

Config contains voucher endpoint configuration parameters

type Endpoint

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

Endpoint for issuing signed vouchers

func NewEndpoint

func NewEndpoint(log *zap.Logger, satellite signing.Signer, overlay *overlay.Service, expiration time.Duration) *Endpoint

NewEndpoint creates a new endpoint for issuing signed vouchers

func (*Endpoint) Request

func (endpoint *Endpoint) Request(ctx context.Context, req *pb.VoucherRequest) (_ *pb.VoucherResponse, err error)

Request receives a voucher request and returns a voucher and an error