summaryrefslogtreecommitdiff
path: root/agreement/errors.go
blob: e0929b63e4c0d2bf5a705c8d950a29701db0ee05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package agreement

import (
	"fmt"
)

// serializableError, or state machine error, is a serializable error that
// is correctly written to cadaver files.
type serializableError string

// implement error interface
func (e serializableError) Error() string {
	return string(e)
}

func (e serializableError) String() string {
	return e.Error()
}

// makeSerErrStr returns an serializableError that formats as the given text.
func makeSerErrStr(text string) *serializableError {
	s := serializableError(text)
	return &s
}

func makeSerErrf(format string, a ...interface{}) *serializableError {
	s := serializableError(fmt.Sprintf(format, a...))
	return &s
}

// makeSerErr returns an serializableError that formats as the given error.
func makeSerErr(err error) *serializableError {
	if err == nil {
		return nil
	}
	s := serializableError(err.Error())
	return &s
}