package
0.10.3
Repository: https://github.com/tonicpow/go-paymail.git
Documentation: pkg.go.dev

# Functions

CreateMetadata will create the base metadata using the request.
CreateServer will create a basic Paymail Server.
ErrorResponse is a standard way to return errors to the client Specs: http://bsvalias.org/99-01-recommendations.html.
GenerateServiceURL will create the service URL.
GenericCapabilities will make generic capabilities.
Handlers are used to isolate loading the routes (used for testing).
NewConfig will make a new server configuration.
P2PCapabilities will make generic capabilities & add additional p2p capabilities.
StartServer will run the Paymail server.
WithBasicRoutes will turn on all the basic routes.
WithCapabilities will modify the capabilities.
WithDomain will add the domain if not found.
WithDomainValidationDisabled will disable checking domains (from request for allowed domains).
WithGenericCapabilities will load the generic Paymail capabilities.
WithP2PCapabilities will load the generic & p2p capabilities.
WithPort will overwrite the default port.
WithSenderValidation will enable sender validation.
WithServiceName will set a custom service name.
WithTimeout will set a custom timeout.

# Constants

Version of API.
Paymail specs require SSL.
If true, it requires extra sender validation.
Port for the server.
Default timeouts.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.
Error codes for server response errors.

# Variables

ErrBsvAliasMissing is when the bsv alias version is missing.
ErrCapabilitiesMissing is when the capabilities struct is nil or not set.
ErrDomainMissing is the error for missing domain.
ErrPortMissing is when the port is not found.
ErrServiceNameMissing is when the service name is not found.
ErrServiceProviderNil is the error for having a nil service provider.

# Structs

Configuration paymail server configuration object.
Domain is the Paymail Domain information.
RequestMetadata is the struct with extra metadata.

# Interfaces

PaymailServiceProvider the paymail server interface that needs to be implemented.

# Type aliases

ConfigOps allow functional options to be supplied that overwrite default options.