web

Documentation

Index

• Constants
• Variables
• func CheckUUIDMatch(id, target uuid.UUID) error
• type Render
  • func NewRender(fsys fs.FS, pattern string, includes ...string) (render *Render, err error)
  • func (r *Render) AddPattern(fsys fs.FS, pattern string, includes ...string) (err error)
  • func (r *Render) Instance(name string, data any) render.Render
• type Server
  • func Debug(conf config.WebConfig, store store.Store, network network.Network, ...) (s *Server, err error)
  • func New(conf config.WebConfig, store store.Store, network network.Network) (s *Server, err error)
  • func (s *Server) AccountDetail(c *gin.Context)
  • func (s *Server) Accounts(c *gin.Context)
  • func (s *Server) Authenticate(c *gin.Context)
  • func (s *Server) CounterpartyDetail(c *gin.Context)
  • func (s *Server) CounterpartyFromTravelAddress(c *gin.Context, address string) (cp *models.Counterparty, err error)
  • func (s *Server) CounterpartyVasps(c *gin.Context)
  • func (s *Server) CreateAccount(c *gin.Context)
  • func (s *Server) CreateCounterparty(c *gin.Context)
  • func (s *Server) CreateCryptoAddress(c *gin.Context)
  • func (s *Server) CreateTransaction(c *gin.Context)
  • func (s *Server) CryptoAddressDetail(c *gin.Context)
  • func (s *Server) Debug(c *gin.Context)
  • func (s *Server) DeleteAccount(c *gin.Context)
  • func (s *Server) DeleteCounterparty(c *gin.Context)
  • func (s *Server) DeleteCryptoAddress(c *gin.Context)
  • func (s *Server) DeleteTransaction(c *gin.Context)
  • func (s *Server) ExportTransactions(c *gin.Context)
  • func (s *Server) Healthz(c *gin.Context)
  • func (s *Server) Home(c *gin.Context)
  • func (s *Server) ListAccounts(c *gin.Context)
  • func (s *Server) ListCounterparties(c *gin.Context)
  • func (s *Server) ListCryptoAddresses(c *gin.Context)
  • func (s *Server) ListSecureEnvelopes(c *gin.Context)
  • func (s *Server) ListTransactions(c *gin.Context)
  • func (s *Server) Localparty(ctx context.Context) (_ *models.Counterparty, err error)
  • func (s *Server) Login(c *gin.Context)
  • func (s *Server) LoginPage(c *gin.Context)
  • func (s *Server) Logout(c *gin.Context)
  • func (s *Server) Maintenance() gin.HandlerFunc
  • func (s *Server) NotAllowed(c *gin.Context)
  • func (s *Server) NotFound(c *gin.Context)
  • func (s *Server) PrepareTransaction(c *gin.Context)
  • func (s *Server) Readyz(c *gin.Context)
  • func (s *Server) Reauthenticate(c *gin.Context)
  • func (s *Server) SecureEnvelopeDetail(c *gin.Context)
  • func (s *Server) SendEnvelopeForm(c *gin.Context)
  • func (s *Server) SendPreparedTransaction(c *gin.Context)
  • func (s *Server) SendTRISATransfer(ctx context.Context, outgoing *envelope.Envelope, ...) (_, incoming *envelope.Envelope, err error)
  • func (s *Server) Serve(errc chan<- error) (err error)
  • func (s *Server) SetStatus(health, ready bool)
  • func (s *Server) Shutdown() (err error)
  • func (s *Server) Status(c *gin.Context)
  • func (s *Server) TransactionDetail(c *gin.Context)
  • func (s *Server) Transactions(c *gin.Context)
  • func (s *Server) URL() string
  • func (s *Server) UpdateAccount(c *gin.Context)
  • func (s *Server) UpdateAccountPreview(c *gin.Context)
  • func (s *Server) UpdateCounterparty(c *gin.Context)
  • func (s *Server) UpdateCounterpartyPreview(c *gin.Context)
  • func (s *Server) UpdateCryptoAddress(c *gin.Context)
  • func (s *Server) UpdateTransaction(c *gin.Context)

Constants

const (
	ContentDisposition = "Content-Disposition"
	ContentType        = "Content-Type"
	AcceptLength       = "Accept-Length"
	ContentTypeCSV     = "text/csv"
)

Variables

var (
	ErrNoTRISAEndpoint   = errors.New("cannot construct trisa travel address: no trisa endpoint defined")
	ErrNoLocalCommonName = errors.New("invalid configuration: no common name in trisa endpoint configuration")
	ErrNoLocalparty      = errors.New("could not lookup local vasp counterparty from database, please try again later")
	ErrNotAccepted       = errors.New("the accepted formats are not offered by the server")
)

var TransactionsHeader = []string{
	"ID", "Status", "Counterparty", "Originator", "Originator Address",
	"Beneficiary", "Beneficiary Address", "Virtual Asset", "Amount",
	"Last Update", "Created", "Number of Envelopes", "HMAC Signature",
}

Functions

func CheckUUIDMatch

func CheckUUIDMatch(id, target uuid.UUID) error

Types

type Render

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

func NewRender

func NewRender(fsys fs.FS, pattern string, includes ...string) (render *Render, err error)

func (*Render) AddPattern

func (r *Render) AddPattern(fsys fs.FS, pattern string, includes ...string) (err error)

func (*Render) Instance

func (r *Render) Instance(name string, data any) render.Render

type Server

type Server struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

The Web Server implements the compliance and administrative user interfaces.

func Debug

func Debug(conf config.WebConfig, store store.Store, network network.Network, srv *http.Server) (s *Server, err error)

Debug returns a server that uses the specified http server instead of creating one. This function is primarily used to create test servers easily.

func New

func New(conf config.WebConfig, store store.Store, network network.Network) (s *Server, err error)

Create a new web server that serves the compliance and admin web user interface.

func (*Server) AccountDetail

func (s *Server) AccountDetail(c *gin.Context)

func (*Server) Accounts

func (s *Server) Accounts(c *gin.Context)

func (*Server) Authenticate

func (s *Server) Authenticate(c *gin.Context)

func (*Server) CounterpartyDetail

func (s *Server) CounterpartyDetail(c *gin.Context)

func (*Server) CounterpartyFromTravelAddress

func (s *Server) CounterpartyFromTravelAddress(c *gin.Context, address string) (cp *models.Counterparty, err error)

func (*Server) CounterpartyVasps

func (s *Server) CounterpartyVasps(c *gin.Context)

func (*Server) CreateAccount

func (s *Server) CreateAccount(c *gin.Context)

func (*Server) CreateCounterparty

func (s *Server) CreateCounterparty(c *gin.Context)

func (*Server) CreateCryptoAddress

func (s *Server) CreateCryptoAddress(c *gin.Context)

func (*Server) CreateTransaction

func (s *Server) CreateTransaction(c *gin.Context)

func (*Server) CryptoAddressDetail

func (s *Server) CryptoAddressDetail(c *gin.Context)

func (*Server) Debug

func (s *Server) Debug(c *gin.Context)

func (*Server) DeleteAccount

func (s *Server) DeleteAccount(c *gin.Context)

func (*Server) DeleteCounterparty

func (s *Server) DeleteCounterparty(c *gin.Context)

func (*Server) DeleteCryptoAddress

func (s *Server) DeleteCryptoAddress(c *gin.Context)

func (*Server) DeleteTransaction

func (s *Server) DeleteTransaction(c *gin.Context)

func (*Server) ExportTransactions

func (s *Server) ExportTransactions(c *gin.Context)

func (*Server) Healthz

func (s *Server) Healthz(c *gin.Context)

Healthz is used to alert k8s to the health/liveness status of the server.

func (*Server) Home

func (s *Server) Home(c *gin.Context)

Home currently renders the primary landing page for the web ui.

func (*Server) ListAccounts

func (s *Server) ListAccounts(c *gin.Context)

func (*Server) ListCounterparties

func (s *Server) ListCounterparties(c *gin.Context)

func (*Server) ListCryptoAddresses

func (s *Server) ListCryptoAddresses(c *gin.Context)

func (*Server) ListSecureEnvelopes

func (s *Server) ListSecureEnvelopes(c *gin.Context)

func (*Server) ListTransactions

func (s *Server) ListTransactions(c *gin.Context)

func (*Server) Localparty

func (s *Server) Localparty(ctx context.Context) (_ *models.Counterparty, err error)

Localparty returns the VASP information for the current node.

func (*Server) Login

func (s *Server) Login(c *gin.Context)

func (*Server) LoginPage

func (s *Server) LoginPage(c *gin.Context)

func (*Server) Logout

func (s *Server) Logout(c *gin.Context)

func (*Server) Maintenance

func (s *Server) Maintenance() gin.HandlerFunc

If the server is in maintenance mode, aborts the current request and renders the maintenance mode page instead. Returns nil if not in maintenance mode.

func (*Server) NotAllowed

func (s *Server) NotAllowed(c *gin.Context)

Renders the "invalid action page"

func (*Server) NotFound

func (s *Server) NotFound(c *gin.Context)

Renders the "not found page"

func (*Server) PrepareTransaction

func (s *Server) PrepareTransaction(c *gin.Context)

func (*Server) Readyz

func (s *Server) Readyz(c *gin.Context)

Readyz is used to alert k8s to the readiness status of the server.

func (*Server) Reauthenticate

func (s *Server) Reauthenticate(c *gin.Context)

func (*Server) SecureEnvelopeDetail

func (s *Server) SecureEnvelopeDetail(c *gin.Context)

func (*Server) SendEnvelopeForm

func (s *Server) SendEnvelopeForm(c *gin.Context)

func (*Server) SendPreparedTransaction

func (s *Server) SendPreparedTransaction(c *gin.Context)

func (*Server) SendTRISATransfer

func (s *Server) SendTRISATransfer(ctx context.Context, outgoing *envelope.Envelope, counterparty *models.Counterparty) (_, incoming *envelope.Envelope, err error)

func (*Server) Serve

func (s *Server) Serve(errc chan<- error) (err error)

Serve the compliance and administrative user interfaces in its own go routine.

func (*Server) SetStatus

func (s *Server) SetStatus(health, ready bool)

SetStatus sets the health and ready status on the server, modifying the behavior of the kubernetes probe responses.

func (*Server) Shutdown

func (s *Server) Shutdown() (err error)

Shutdown the web server gracefully.

func (*Server) Status

func (s *Server) Status(c *gin.Context)

Status reports the version and uptime of the server

func (*Server) TransactionDetail

func (s *Server) TransactionDetail(c *gin.Context)

func (*Server) Transactions

func (s *Server) Transactions(c *gin.Context)

func (*Server) URL

func (s *Server) URL() string

URL returns the endpoint of the server as determined by the configuration and the socket address and port (if specified).

func (*Server) UpdateAccount

func (s *Server) UpdateAccount(c *gin.Context)

func (*Server) UpdateAccountPreview

func (s *Server) UpdateAccountPreview(c *gin.Context)

func (*Server) UpdateCounterparty

func (s *Server) UpdateCounterparty(c *gin.Context)

func (*Server) UpdateCounterpartyPreview

func (s *Server) UpdateCounterpartyPreview(c *gin.Context)

func (*Server) UpdateCryptoAddress

func (s *Server) UpdateCryptoAddress(c *gin.Context)

func (*Server) UpdateTransaction

func (s *Server) UpdateTransaction(c *gin.Context)