-
Notifications
You must be signed in to change notification settings - Fork 1
/
ledger.go
57 lines (46 loc) · 1.52 KB
/
ledger.go
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
/*
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package blockledger
import (
cb "github.com/hyperledger/fabric/protos/common"
ab "github.com/hyperledger/fabric/protos/orderer"
)
// Factory retrieves or creates new ledgers by chainID
type Factory interface {
// GetOrCreate gets an existing ledger (if it exists)
// or creates it if it does not
GetOrCreate(chainID string) (ReadWriter, error)
// ChainIDs returns the chain IDs the Factory is aware of
ChainIDs() []string
// Close releases all resources acquired by the factory
Close()
}
// Iterator is useful for a chain Reader to stream blocks as they are created
type Iterator interface {
// Next blocks until there is a new block available, or returns an error if
// the next block is no longer retrievable
Next() (*cb.Block, cb.Status)
// Close releases resources acquired by the Iterator
Close()
}
// Reader allows the caller to inspect the ledger
type Reader interface {
// Iterator returns an Iterator, as specified by an ab.SeekInfo message, and
// its starting block number
Iterator(startType *ab.SeekPosition) (Iterator, uint64)
// Height returns the number of blocks on the ledger
Height() uint64
}
// Writer allows the caller to modify the ledger
type Writer interface {
// Append a new block to the ledger
Append(block *cb.Block) error
}
//go:generate mockery -dir . -name ReadWriter -case underscore -output mocks/
// ReadWriter encapsulates the read/write functions of the ledger
type ReadWriter interface {
Reader
Writer
}