5adfc968df
In preparation for MPP we return the terminal errors recorded with the control tower. The reason is that we cannot return immediately when a shard fails for MPP, since there might be more shards in flight that we must wait for. For that reason we instead mark the payment failed in the control tower, then return this error when we inspect the payment, seeing it has been failed and there are no shards in flight.
71 lines
1.9 KiB
Go
71 lines
1.9 KiB
Go
package routing
|
|
|
|
import "github.com/go-errors/errors"
|
|
|
|
// errorCode is used to represent the various errors that can occur within this
|
|
// package.
|
|
type errorCode uint8
|
|
|
|
const (
|
|
// ErrOutdated is returned when the routing update already have
|
|
// been applied, or a newer update is already known.
|
|
ErrOutdated errorCode = iota
|
|
|
|
// ErrIgnored is returned when the update have been ignored because
|
|
// this update can't bring us something new, or because a node
|
|
// announcement was given for node not found in any channel.
|
|
ErrIgnored
|
|
)
|
|
|
|
// routerError is a structure that represent the error inside the routing package,
|
|
// this structure carries additional information about error code in order to
|
|
// be able distinguish errors outside of the current package.
|
|
type routerError struct {
|
|
err *errors.Error
|
|
code errorCode
|
|
}
|
|
|
|
// Error represents errors as the string
|
|
// NOTE: Part of the error interface.
|
|
func (e *routerError) Error() string {
|
|
return e.err.Error()
|
|
}
|
|
|
|
// A compile time check to ensure routerError implements the error interface.
|
|
var _ error = (*routerError)(nil)
|
|
|
|
// newErr creates a routerError by the given error description and its
|
|
// corresponding error code.
|
|
func newErr(code errorCode, a interface{}) *routerError {
|
|
return &routerError{
|
|
code: code,
|
|
err: errors.New(a),
|
|
}
|
|
}
|
|
|
|
// newErrf creates a routerError by the given error formatted description and
|
|
// its corresponding error code.
|
|
func newErrf(code errorCode, format string, a ...interface{}) *routerError {
|
|
return &routerError{
|
|
code: code,
|
|
err: errors.Errorf(format, a...),
|
|
}
|
|
}
|
|
|
|
// IsError is a helper function which is needed to have ability to check that
|
|
// returned error has specific error code.
|
|
func IsError(e interface{}, codes ...errorCode) bool {
|
|
err, ok := e.(*routerError)
|
|
if !ok {
|
|
return false
|
|
}
|
|
|
|
for _, code := range codes {
|
|
if err.code == code {
|
|
return true
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|