tss-lib/tss/error.go

// Copyright © 2019 Binance
//
// This file is part of Binance. The full Binance copyright notice, including
// terms governing use, modification, and redistribution, is contained in the
// file LICENSE at the root of the source code distribution tree.

package tss

import (
	"fmt"
)

// Represents an error that occurred during execution of the TSS protocol rounds.
type Error struct {
	cause    error
	task     string
	round    int
	victim   *PartyID
	culprits []*PartyID
}

type VictimAndCulprit struct {
	Victim  *PartyID
	Culprit *PartyID
	Message string
}

func NewError(err error, task string, round int, victim *PartyID, culprits ...*PartyID) *Error {
	return &Error{cause: err, task: task, round: round, victim: victim, culprits: culprits}
}

func (err *Error) Unwrap() error { return err.cause }

func (err *Error) Cause() error { return err.cause }

func (err *Error) Task() string { return err.task }

func (err *Error) Round() int { return err.round }

func (err *Error) Victim() *PartyID { return err.victim }

func (err *Error) Culprits() []*PartyID { return err.culprits }

func (err *Error) SelfCaused() bool {
	return len(err.culprits) == 0 || (len(err.culprits) == 1 && err.culprits[0] == err.victim)
}

func (err *Error) Error() string {
	if err == nil || err.cause == nil {
		return "Error is nil"
	}
	if err.culprits != nil && len(err.culprits) > 0 {
		return fmt.Sprintf("task %s, party %v, round %d, culprits %s: %s",
			err.task, err.victim, err.round, err.culprits, err.cause.Error())
	}
	if err.victim != nil {
		return fmt.Sprintf("task %s, party %v, round %d: %s",
			err.task, err.victim, err.round, err.cause.Error())
	}
	return fmt.Sprintf("task %s, round %d: %s",
		err.task, err.round, err.cause.Error())
}

func (vc *VictimAndCulprit) Error() string {
	message := ""
	if vc.Culprit != nil {
		message = fmt.Sprintf("culprit party: %s", vc.Culprit)
	}
	if vc.Victim != nil {
		message = message + fmt.Sprintf(" victim party: %s", vc.Victim)
	}
	if len(vc.Message) > 0 {
		message = message + " " + vc.Message
	}
	return message
}