paymail

Documentation

Index

• type PayloadFormat
  • func (format PayloadFormat) String() string
• type ServiceClient
  • func NewServiceClient(cache cachestore.ClientInterface, paymailClient paymail.ClientInterface, ...) ServiceClient

Types

type PayloadFormat

type PayloadFormat uint32

PayloadFormat is the format of the paymail payload

const (
	BasicPaymailPayloadFormat PayloadFormat = iota
	BeefPaymailPayloadFormat
)

Types of Paymail payload formats

func (PayloadFormat) String

func (format PayloadFormat) String() string

type ServiceClient

type ServiceClient interface {
	GetSanitizedPaymail(addr string) (*paymail.SanitisedPaymail, error)
	GetCapabilities(ctx context.Context, domain string) (*paymail.CapabilitiesPayload, error)
	GetP2PDestinations(ctx context.Context, address *paymail.SanitisedPaymail, satoshis bsv.Satoshis) (*paymail.PaymentDestinationPayload, error)
	GetP2P(ctx context.Context, domain string) (success bool, p2pDestinationURL, p2pSubmitTxURL string, format PayloadFormat)
	StartP2PTransaction(alias, domain, p2pDestinationURL string, satoshis uint64) (*paymail.PaymentDestinationPayload, error)
	GetPkiForPaymail(ctx context.Context, sPaymail *paymail.SanitisedPaymail) (*paymail.PKIResponse, error)
	AddContactRequest(ctx context.Context, receiverPaymail *paymail.SanitisedPaymail, contactData *paymail.PikeContactRequestPayload) (*paymail.PikeContactRequestResponse, error)
}

ServiceClient is a service that aims to make easier paymail operations.

func NewServiceClient

func NewServiceClient(cache cachestore.ClientInterface, paymailClient paymail.ClientInterface, log zerolog.Logger) ServiceClient

NewServiceClient creates a new paymail service client