summaryrefslogtreecommitdiff
path: root/logging/logspec/ledger.go
blob: d04b2087f725e228918485c82be64d0259f7f2e1 (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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright (C) 2019-2024 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 logspec

import (
	"encoding/json"
	"errors"
)

// LedgerType is an enum identifying a specific type of LedgerEvent
// TODO Maybe this should be called LedgerEventType, since these are not actually types of ledgers
//
//go:generate stringer -type=LedgerType
type LedgerType int

const (
	// WroteBlock is emitted whenever a block is written to the ledger
	WroteBlock LedgerType = iota

	numLedgerTypes // keep this last
)

// LedgerEvent represents data corresponding to an event occurring related to the ledger
type LedgerEvent struct {
	Event

	Type LedgerType

	// Round of the block just written
	Round uint64

	// Hash is the block hash of the block just written
	Hash string

	// Number of transactions in the block just written
	TxnCount int
}

func ledgerTypeFromString(s string) (LedgerType, bool) {
	for i := 0; i < int(numLedgerTypes); i++ {
		t := LedgerType(i)
		if t.String() == s {
			return t, true
		}
	}
	return 0, false
}

// UnmarshalJSON initializes the LedgerType from a JSON string contained in a byte buffer.
// An error is returned if a valid LedgerType can't be parsed from the buffer.
func (t *LedgerType) UnmarshalJSON(b []byte) error {
	var raw string
	err := json.Unmarshal(b, &raw)
	if err != nil {
		return err
	}

	typeConst, ok := ledgerTypeFromString(raw)
	if !ok {
		return errors.New("invalid LedgerType field")
	}

	*t = typeConst
	return nil
}