-
Notifications
You must be signed in to change notification settings - Fork 42
/
nmt.go
612 lines (553 loc) · 24.1 KB
/
nmt.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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
// Package nmt contains an NMT implementation.
// The specifications can be found in https://github.com/celestiaorg/nmt/blob/master/docs/spec/nmt.md.
package nmt
import (
"bytes"
"errors"
"fmt"
"hash"
"math/bits"
"github.com/celestiaorg/nmt/namespace"
)
const (
DefaultNamespaceIDLen = 8
DefaultCapacity = 128
)
var (
ErrInvalidRange = errors.New("invalid proof range")
ErrInvalidPushOrder = errors.New("pushed data has to be lexicographically ordered by namespace IDs")
noOp = func(hash []byte, children ...[]byte) {}
)
type NodeVisitorFn = func(hash []byte, children ...[]byte)
type Options struct {
// InitialCapacity indicates the initial number of leaves in the tree
InitialCapacity int
// NamespaceIDSize is the size of a namespace ID in bytes
NamespaceIDSize namespace.IDSize
// The "IgnoreMaxNamespace" flag influences the calculation of the namespace
// ID range for intermediate nodes in the tree. This flag signals that, when
// determining the upper limit of the namespace ID range for a tree node,
// the maximum possible namespace ID (equivalent to "NamespaceIDSize" bytes
// of 0xFF, or 2^NamespaceIDSize-1) should be omitted if feasible. For a
// more in-depth understanding of this field, refer to the "HashNode" method
// in the "Hasher.
IgnoreMaxNamespace bool
NodeVisitor NodeVisitorFn
}
type Option func(*Options)
// InitialCapacity sets the capacity of the internally used slice(s) to the
// passed in initial value (defaults is 128).
func InitialCapacity(cap int) Option {
if cap < 0 {
panic("Got invalid capacity. Expected int greater or equal to 0.")
}
return func(opts *Options) {
opts.InitialCapacity = cap
}
}
// NamespaceIDSize sets the size of namespace IDs (in bytes) used by this tree.
// Defaults to 8 bytes.
func NamespaceIDSize(size int) Option {
if size < 0 || size > namespace.IDMaxSize {
panic("Got invalid namespace.IDSize. Expected 0 <= size <= namespace.IDMaxSize.")
}
return func(opts *Options) {
opts.NamespaceIDSize = namespace.IDSize(size)
}
}
// IgnoreMaxNamespace sets whether the largest possible namespace.ID MAX_NID
// should be 'ignored'. If set to true, this allows for shorter proofs in
// particular use-cases. E.g., see:
// https://github.com/celestiaorg/celestiaorg-specs/blob/master/specs/data_structures.md#namespace-merkle-tree
// Defaults to true.
func IgnoreMaxNamespace(ignore bool) Option {
return func(opts *Options) {
opts.IgnoreMaxNamespace = ignore
}
}
func NodeVisitor(nodeVisitorFn NodeVisitorFn) Option {
return func(opts *Options) {
opts.NodeVisitor = nodeVisitorFn
}
}
type NamespacedMerkleTree struct {
treeHasher *Hasher
visit NodeVisitorFn
// just cache stuff until we pass in a store and keep all nodes in there
// currently, only leaves and leafHashes are stored:
// leaves holds the list of namespace-prefixed data elements that have been
// added to the tree, in the order of their insertion. Each
// namespace-prefixed data item is represented as a byte slice.
leaves [][]byte
// leafHashes stores the namespace hash of the leaves, calculated either
// through the Root() or the computeLeafHashesIfNecessary methods.
leafHashes [][]byte
// namespaceRanges can be used to efficiently look up the range for an
// existing namespace without iterating through the leaves. The map key is
// the string representation of a namespace.ID and the leafRange indicates
// the range of the leaves matching that namespace ID in the tree
namespaceRanges map[string]leafRange
// minNID is the minimum namespace ID of the leaves
minNID namespace.ID
// maxNID is the maximum namespace ID of the leaves
maxNID namespace.ID
// rawRoot caches the value of the tree root whenever the Root() method is
// invoked. It's important to note that rawRoot may become outdated and may
// not accurately reflect the current state of the leaves.
rawRoot []byte
}
// New initializes a namespaced Merkle tree using the given base hash function
// and for the given namespace size (number of bytes). If the namespace size is
// 0 this corresponds to a regular non-namespaced Merkle tree.
func New(h hash.Hash, setters ...Option) *NamespacedMerkleTree {
// default options:
opts := &Options{
InitialCapacity: DefaultCapacity,
NamespaceIDSize: DefaultNamespaceIDLen,
IgnoreMaxNamespace: true,
NodeVisitor: noOp,
}
for _, setter := range setters {
setter(opts)
}
treeHasher := NewNmtHasher(h, opts.NamespaceIDSize, opts.IgnoreMaxNamespace)
return &NamespacedMerkleTree{
treeHasher: treeHasher,
visit: opts.NodeVisitor,
leaves: make([][]byte, 0, opts.InitialCapacity),
leafHashes: make([][]byte, 0, opts.InitialCapacity),
namespaceRanges: make(map[string]leafRange),
minNID: bytes.Repeat([]byte{0xFF}, int(opts.NamespaceIDSize)),
maxNID: bytes.Repeat([]byte{0x00}, int(opts.NamespaceIDSize)),
}
}
// Prove returns a NMT inclusion proof for the leaf at the supplied index. Note
// this is not really NMT specific but the tree supports inclusions proofs like
// any vanilla Merkle tree. Prove is a thin wrapper around the ProveRange.
// If the supplied index is invalid i.e., if index < 0 or index > len(n.leaves), then Prove returns an ErrInvalidRange error. Any other errors rather than this are irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) Prove(index int) (Proof, error) {
return n.ProveRange(index, index+1)
}
// ProveRange returns a Merkle inclusion proof for a specified range of leaves,
// from start to end exclusive. The returned Proof structure contains the nodes
// field, which holds the necessary tree nodes for the Merkle range proof in an
// in-order traversal order. These nodes include the namespaced hash of the left
// siblings for the proof of the leaf at index start, and the namespaced hash of
// the right siblings for the proof of the leaf at index end.
//
// If the specified range [start, end) exceeds the current range of leaves in
// the tree, ProveRange returns an error together with an empty Proof with empty
// nodes and start and end fields set to 0.
//
// The isMaxNamespaceIDIgnored field of the Proof reflects the ignoreMaxNs field
// of n.treeHasher. When set to true, this indicates that the proof was
// generated using a modified version of the namespace hash with a custom
// namespace ID range calculation. For more information on this, please refer to
// the HashNode method in the Hasher.
// If the supplied (start, end) range is invalid i.e., if start < 0 or end > len(n.leafHashes) or start >= end,
// then ProveRange returns an ErrInvalidRange error. Any errors rather than ErrInvalidRange are irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) ProveRange(start, end int) (Proof, error) {
isMaxNsIgnored := n.treeHasher.IsMaxNamespaceIDIgnored()
// TODO: store nodes and re-use the hashes instead recomputing parts of the
// tree here
if err := n.validateRange(start, end); err != nil {
return NewEmptyRangeProof(isMaxNsIgnored), err
}
proof, err := n.buildRangeProof(start, end)
if err != nil {
return Proof{}, err
}
return NewInclusionProof(start, end, proof, isMaxNsIgnored), nil
}
// ProveNamespace returns a range proof for the given NamespaceID.
//
// case 1) If the namespace nID is out of the range of the tree's min and max
// namespace i.e., (nID < n.minNID) or (n.maxNID < nID) ProveNamespace returns an empty
// Proof with empty nodes and the range (0,0) i.e., Proof.start = 0 and
// Proof.end = 0 to indicate that this namespace is not contained in the tree.
//
// case 2) If the namespace nID is within the range of the tree's min and max
// namespace i.e., n.minNID<= n.ID <=n.maxNID and the tree does not have any
// entries with the given Namespace ID nID, this will be proven by returning the
// inclusion/range Proof of the (namespaced or rather flagged) hash of the leaf
// of the tree 1) with the smallest namespace ID that is larger than nID and 2)
// the namespace ID of the leaf to the left of it is smaller than the nid. The nodes
// field of the returned Proof structure is populated with the Merkle inclusion
// proof. the leafHash field of the returned Proof will contain the namespaced
// hash of such leaf. The start and end fields of the Proof are set to the
// indices of the identified leaf. The start field is set to the index of the
// leaf, and the end field is set to the index of the leaf + 1.
//
// case 3) In case the underlying tree contains leaves with the given namespace
// their start and end (end is non-inclusive) index will be returned together
// with a range proof for [start, end). In that case the leafHash field of the
// returned Proof will be nil.
//
// The isMaxNamespaceIDIgnored field of the Proof reflects the ignoreMaxNs field
// of n.treeHasher. When set to true, this indicates that the proof was
// generated using a modified version of the namespace hash with a custom
// namespace ID range calculation. For more information on this, please refer to
// the HashNode method in the Hasher.
// Any error returned by this method is irrecoverable and indicates an illegal state of the tree (n).
func (n *NamespacedMerkleTree) ProveNamespace(nID namespace.ID) (Proof, error) {
isMaxNsIgnored := n.treeHasher.IsMaxNamespaceIDIgnored()
// case 1) In the cases (n.nID < minNID) or (n.maxNID < nID), return empty
// range proof
if nID.Less(n.minNID) || n.maxNID.Less(nID) {
return NewEmptyRangeProof(isMaxNsIgnored), nil
}
// find the range of indices of leaves with the given nID
found, proofStart, proofEnd := n.foundInRange(nID)
// case 2)
if !found {
// To generate a proof for an absence we calculate the position of the
// leaf that is in the place of where the namespace would be in:
proofStart = n.calculateAbsenceIndex(nID)
proofEnd = proofStart + 1
}
// case 3) At this point we either found leaves with the namespace nID in
// the tree or calculated the range it would be in (to generate a proof of
// absence and to return the corresponding leaf hashes).
proof, err := n.buildRangeProof(proofStart, proofEnd)
if err != nil {
return Proof{}, err
}
if found {
return NewInclusionProof(proofStart, proofEnd, proof, isMaxNsIgnored), nil
}
return NewAbsenceProof(proofStart, proofEnd, proof, n.leafHashes[proofStart], isMaxNsIgnored), nil
}
// validateRange validates the range [start, end) against the size of the tree.
// start is inclusive and end is non-inclusive.
func (n *NamespacedMerkleTree) validateRange(start, end int) error {
if start < 0 || start >= end || end > len(n.leaves) {
return ErrInvalidRange
}
return nil
}
// buildRangeProof returns the nodes (as byte slices) in the range proof of the
// supplied range i.e., [proofStart, proofEnd) where proofEnd is non-inclusive.
// The nodes are ordered according to in order traversal of the namespaced tree.
// Any errors returned by this method are irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) buildRangeProof(proofStart, proofEnd int) ([][]byte, error) {
proof := [][]byte{} // it is the list of nodes hashes (as byte slices) with no index
var recurse func(start, end int, includeNode bool) ([]byte, error)
// validate the range
if err := n.validateRange(proofStart, proofEnd); err != nil {
return nil, err
}
// start, end are indices of leaves in the tree hence they should be within
// the size of the tree i.e., less than or equal to the len(n.leaves)
// includeNode indicates whether the hash of the current subtree (covering
// the supplied range i.e., [start, end)) or one of its constituent subtrees
// should be part of the proof
recurse = func(start, end int, includeNode bool) ([]byte, error) {
if start >= len(n.leafHashes) {
return nil, nil
}
// reached a leaf
if end-start == 1 {
leafHash := n.leafHashes[start]
// if the index of the leaf node is out of the queried range i.e. ,
// [proofStart, proofEnd) and if the leaf is required as part of the
// proof i.e., includeNode == true
if (start < proofStart || start >= proofEnd) && includeNode {
// add the leafHash to the proof
proof = append(proof, leafHash)
}
// if the index of the leaf is within the queried range i.e.,
// [proofStart, proofEnd] OR if the leaf is not required as part of
// the proof i.e., includeNode == false
return leafHash, nil
}
// newIncludeNode indicates whether one of the subtrees of the current
// subtree [start, end) may have an overlap with the queried proof range
// i.e., [proofStart, proofEnd)
newIncludeNode := includeNode
// check whether the subtree representing the [start, end) range of
// leaves has overlap with the queried proof range i.e., [proofStart,
// proofEnd) if there is no overlap
if (end <= proofStart || start >= proofEnd) && includeNode {
// setting newIncludeNode to false indicates that none of the
// subtrees (left and right) of the current subtree are required for
// the proof because the range of the leaves they cover have no
// overlap with the queried proof range i.e., [proofStart, proofEnd)
newIncludeNode = false
}
// recursively get left and right subtree
k := getSplitPoint(end - start)
left, err := recurse(start, start+k, newIncludeNode)
if err != nil {
return nil, err
}
right, err := recurse(start+k, end, newIncludeNode)
if err != nil {
return nil, err
}
// only right leaf/subtree can be non-existent
var hash []byte
if right == nil {
hash = left
} else {
var err error
hash, err = n.treeHasher.HashNode(left, right)
if err != nil { // if HashNode returns an error, it is a bug
return nil, err // this should never happen if the Push method is used to add leaves to the tree
}
}
// if the hash of the subtree representing [start, end) should be part
// of the proof but not its left and right subtrees
if includeNode && !newIncludeNode {
proof = append(proof, hash)
}
return hash, nil
}
fullTreeSize := getSplitPoint(len(n.leafHashes)) * 2
if fullTreeSize < 1 {
fullTreeSize = 1
}
if _, err := recurse(0, fullTreeSize, true); err != nil {
return nil, err
}
return proof, nil
}
// Get returns leaves for the given namespace.ID.
func (n *NamespacedMerkleTree) Get(nID namespace.ID) [][]byte {
_, start, end := n.foundInRange(nID)
return n.leaves[start:end]
}
// GetWithProof is a convenience method returns leaves for the given
// namespace.ID together with the proof for that namespace. It returns the same
// result as calling the combination of Get(nid) and ProveNamespace(nid).
func (n *NamespacedMerkleTree) GetWithProof(nID namespace.ID) ([][]byte, Proof, error) {
data := n.Get(nID)
proof, err := n.ProveNamespace(nID)
return data, proof, err
}
// calculateAbsenceIndex returns the index of a leaf of the tree that 1) its
// namespace ID is the smallest namespace ID larger than nID and 2) the
// namespace ID of the leaf to the left of it is smaller than the nID.
func (n *NamespacedMerkleTree) calculateAbsenceIndex(nID namespace.ID) int {
nidSize := n.treeHasher.NamespaceSize()
var prevLeaf []byte
for index, curLeaf := range n.leaves {
if index == 0 {
prevLeaf = curLeaf
continue
}
prevNs := namespace.ID(prevLeaf[:nidSize])
currentNs := curLeaf[:nidSize]
// Note that here we would also care for the case current < nId < prevNs
// but we only allow pushing leaves with ascending namespaces; i.e.
// prevNs <= currentNs is always true. Also we only check for strictly
// smaller: prev < nid < current because if we either side was equal, we
// would have found the namespace before.
if prevNs.Less(nID) && nID.Less(currentNs) {
return index
}
prevLeaf = curLeaf
}
// the case (nID < minNID) or (maxNID < nID) should be handled before
// calling this private helper!
panic("calculateAbsenceIndex() called although (nID < minNID) or (maxNID < nID) for provided nID")
}
// foundInRange returns a range of leaves in the namespace tree with the
// namespace IDs that match the given nID. The startIndex and endIndex indicate
// the starting and ending indices of the range, respectively. The endIndex is
// non-inclusive, meaning it does not include the leaf at that index in the
// range. If no leaves are found, foundInRange returns (false, 0, 0).
func (n *NamespacedMerkleTree) foundInRange(nID namespace.ID) (found bool, startIndex int, endIndex int) {
// This is a faster version of this code snippet:
// https://github.com/celestiaorg/celestiaorg-prototype/blob/2aeca6f55ad389b9d68034a0a7038f80a8d2982e/simpleblock.go#L106-L117
foundRng, found := n.namespaceRanges[string(nID)]
// XXX casting from uint64 to int is kinda crappy but nebolousLabs' range
// proof api requires int params only to convert them to uint64 ...
return found, int(foundRng.start), int(foundRng.end)
}
// NamespaceSize returns the underlying namespace size. Note that all namespaced
// data is expected to have the same namespace size.
func (n *NamespacedMerkleTree) NamespaceSize() namespace.IDSize {
return n.treeHasher.NamespaceSize()
}
// Push adds a namespaced data to the tree. The first `n.NamespaceSize()` bytes
// of namespacedData is treated as its namespace ID. Push returns an error if
// the namespaced data is not namespace-prefixed (i.e., its size is smaller than
// the tree's NamespaceSize), or if it is not pushed in ascending order based on
// the namespace ID compared to the previously inserted data (i.e., it is not
// lexicographically sorted by namespace ID).
func (n *NamespacedMerkleTree) Push(namespacedData namespace.PrefixedData) error {
nID, err := n.validateAndExtractNamespace(namespacedData)
if err != nil {
return err
}
// compute the leaf hash
res, err := n.treeHasher.HashLeaf(namespacedData)
if err != nil {
return err
}
// update relevant "caches":
n.leaves = append(n.leaves, namespacedData)
n.leafHashes = append(n.leafHashes, res)
n.updateNamespaceRanges()
n.updateMinMaxID(nID)
n.rawRoot = nil
return nil
}
// Root calculates the namespaced Merkle Tree's root based on the data that has
// been added through the use of the Push method. the returned byte slice is of
// size 2* n.NamespaceSize + the underlying hash output size, and should be
// parsed as minND || maxNID || hash
// Any error returned by this method is irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) Root() ([]byte, error) {
if n.rawRoot == nil {
res, err := n.computeRoot(0, len(n.leaves))
if err != nil {
return nil, err // this should never happen since leaves are validated in the Push method
}
n.rawRoot = res
}
return n.rawRoot, nil
}
// MinNamespace returns the minimum namespace ID in this Namespaced Merkle Tree.
// Any errors returned by this method are irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) MinNamespace() (namespace.ID, error) {
r, err := n.Root()
if err != nil {
return nil, err
}
return MinNamespace(r, n.NamespaceSize()), nil
}
// MaxNamespace returns the maximum namespace ID in this Namespaced Merkle Tree.
// Any errors returned by this method are irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) MaxNamespace() (namespace.ID, error) {
r, err := n.Root()
if err != nil {
return nil, err
}
return MaxNamespace(r, n.NamespaceSize()), nil
}
// computeRoot calculates the namespace Merkle root for a tree/sub-tree that
// encompasses the leaves within the range of [start, end).
// Any errors returned by this method are irrecoverable and indicate an illegal state of the tree (n).
func (n *NamespacedMerkleTree) computeRoot(start, end int) ([]byte, error) {
switch end - start {
case 0:
rootHash := n.treeHasher.EmptyRoot()
n.visit(rootHash)
return rootHash, nil
case 1:
leafHash := make([]byte, len(n.leafHashes[start]))
copy(leafHash, n.leafHashes[start])
n.visit(leafHash, n.leaves[start])
return leafHash, nil
default:
k := getSplitPoint(end - start)
left, err := n.computeRoot(start, start+k)
if err != nil { // this should never happen since leaves are added through the Push method, during which leaves formats are validated and their namespace IDs are checked to be sequential.
return nil, fmt.Errorf("failed to compute subtree root [%d, %d): %w", start, start+k, err)
}
right, err := n.computeRoot(start+k, end)
if err != nil { // this should never happen since leaves are added through the Push method, during which leaves formats are validated and their namespace IDs are checked to be sequential.
return nil, fmt.Errorf("failed to compute subtree root [%d, %d): %w", start+k, end, err)
}
hash, err := n.treeHasher.HashNode(left, right)
if err != nil { // this error should never happen since leaves are added through the Push method, during which leaves formats are validated and their namespace IDs are checked to be sequential.
return nil, fmt.Errorf("failed to compute subtree root [%d, %d): %w", left, right, err)
}
n.visit(hash, left, right)
return hash, nil
}
}
// getSplitPoint returns the largest power of 2 less than the length.
// Essentially, it returns the size of the left subtree in a full Merkle tree
// with a total number of leaves equal to length.
func getSplitPoint(length int) int {
if length < 1 {
panic("Trying to split a tree with size < 1")
}
uLength := uint(length)
bitlen := bits.Len(uLength)
k := 1 << (bitlen - 1)
if k == length {
k >>= 1
}
return k
}
func (n *NamespacedMerkleTree) updateNamespaceRanges() {
if len(n.leaves) > 0 {
lastIndex := len(n.leaves) - 1
lastPushed := n.leaves[lastIndex]
lastNsStr := string(lastPushed[:n.treeHasher.NamespaceSize()])
lastRange, found := n.namespaceRanges[lastNsStr]
if !found {
n.namespaceRanges[lastNsStr] = leafRange{
start: uint64(lastIndex),
end: uint64(lastIndex + 1),
}
} else {
n.namespaceRanges[lastNsStr] = leafRange{
start: lastRange.start,
end: lastRange.end + 1,
}
}
}
}
// validateAndExtractNamespace verifies whether ndata is a valid namespace
// -prefixed data, and returns its namespace ID. The first `n.NamespaceSize()`
// bytes of namespacedData is treated as its namespace ID.
// validateAndExtractNamespace returns an error if the namespaced data is not
// namespace-prefixed (i.e., its size is smaller than the tree's NamespaceSize),
// or if its namespace ID is smaller than the last leaf data in the tree (i.e.,
// the n.leaves should be sorted in ascending order by their namespace ID).
// validateAndExtractNamespace returns one of the following errors:
// - ErrInvalidLeafLen: indicates the length of the ndata is smaller than the tree's NamespaceSize.
// - ErrInvalidPushOrder: indicates the namespace ID of the ndata is smaller than the last leaf data in the tree.
func (n *NamespacedMerkleTree) validateAndExtractNamespace(ndata namespace.PrefixedData) (namespace.ID, error) {
nidSize := int(n.NamespaceSize())
if len(ndata) < nidSize {
return nil, fmt.Errorf("%w: got: %v, want >= %v", ErrInvalidLeafLen, len(ndata), nidSize)
}
nID := namespace.ID(ndata[:n.NamespaceSize()])
// ensure pushed data doesn't have a smaller namespace than the previous
// one:
curSize := len(n.leaves)
if curSize > 0 {
if nID.Less(n.leaves[curSize-1][:nidSize]) {
return nil, fmt.Errorf(
"%w: last namespace: %x, pushed: %x",
ErrInvalidPushOrder,
n.leaves[curSize-1][:nidSize],
nID,
)
}
}
return nID, nil
}
func (n *NamespacedMerkleTree) updateMinMaxID(id namespace.ID) {
if id.Less(n.minNID) {
n.minNID = id
}
if n.maxNID.Less(id) {
n.maxNID = id
}
}
type leafRange struct {
// start and end denote the indices of a leaf in the tree. start ranges from
// 0 up to the total number of leaves minus 1 end ranges from 1 up to the
// total number of leaves end is non-inclusive
start, end uint64
}
// MinNamespace extracts the minimum namespace ID from a given namespace hash,
// which is formatted as: minimum namespace ID || maximum namespace ID || hash
// digest.
func MinNamespace(hash []byte, size namespace.IDSize) []byte {
min := make([]byte, 0, size)
return append(min, hash[:size]...)
}
// MaxNamespace extracts the maximum namespace ID from a given namespace hash,
// which is formatted as: minimum namespace ID || maximum namespace ID || hash
// digest.
func MaxNamespace(hash []byte, size namespace.IDSize) []byte {
max := make([]byte, 0, size)
return append(max, hash[size:size*2]...)
}