-
Notifications
You must be signed in to change notification settings - Fork 0
/
record.go
238 lines (204 loc) · 5.94 KB
/
record.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
/*
* Copyright 2019 Insolar Technologies
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package core
import (
"bytes"
"encoding/binary"
"encoding/json"
"fmt"
"strconv"
"strings"
"github.com/jbenet/go-base58"
"github.com/pkg/errors"
)
const (
// RecordHashSize is a record hash size. We use 224-bit SHA-3 hash (28 bytes).
RecordHashSize = 28
// RecordIDSize is relative record address.
RecordIDSize = PulseNumberSize + RecordHashSize
// RecordRefSize is absolute records address (including domain ID).
RecordRefSize = RecordIDSize * 2
// RecordRefIDSeparator is character that separates RecordID from DomainID in serialized RecordRef
RecordRefIDSeparator = "."
)
// RecordID is a unified record ID.
type RecordID [RecordIDSize]byte
// String implements stringer on RecordID and returns base58 encoded value
func (id *RecordID) String() string {
return base58.Encode(id[:])
}
// NewRecordID generates RecordID byte representation.
func NewRecordID(pulse PulseNumber, hash []byte) *RecordID {
var id RecordID
copy(id[:PulseNumberSize], pulse.Bytes())
copy(id[PulseNumberSize:], hash)
return &id
}
// Bytes returns byte slice of RecordID.
func (id *RecordID) Bytes() []byte {
return id[:]
}
// Pulse returns a copy of Pulse part of RecordID.
func (id *RecordID) Pulse() PulseNumber {
pulse := binary.BigEndian.Uint32(id[:PulseNumberSize])
return PulseNumber(pulse)
}
// Hash returns a copy of Hash part of RecordID.
func (id *RecordID) Hash() []byte {
recHash := make([]byte, RecordHashSize)
copy(recHash, id[PulseNumberSize:])
return recHash
}
// Equal checks if reference points to the same record.
func (id *RecordID) Equal(other *RecordID) bool {
if id == nil || other == nil {
return false
}
return *id == *other
}
// NewIDFromBase58 deserializes RecordID from base58 encoded string.
func NewIDFromBase58(str string) (*RecordID, error) {
decoded := base58.Decode(str)
if len(decoded) != RecordIDSize {
return nil, errors.New("bad RecordID size")
}
var id RecordID
copy(id[:], decoded)
return &id, nil
}
// MarshalJSON serializes ID into JSON.
func (id *RecordID) MarshalJSON() ([]byte, error) {
if id == nil {
return json.Marshal(nil)
}
return json.Marshal(id.String())
}
// RecordRef is a unified record reference.
type RecordRef [RecordRefSize]byte
// NewRecordRef returns RecordRef composed from domain and record
func NewRecordRef(domain RecordID, record RecordID) *RecordRef {
var ref RecordRef
ref.SetDomain(domain)
ref.SetRecord(record)
return &ref
}
// SetDomain set domain's RecordID.
func (ref *RecordRef) SetDomain(recID RecordID) {
copy(ref[RecordIDSize:], recID[:])
}
// SetRecord set record's RecordID.
func (ref *RecordRef) SetRecord(recID RecordID) {
copy(ref[:RecordIDSize], recID[:])
}
// Domain returns domain ID part of reference.
func (ref RecordRef) Domain() *RecordID {
var id RecordID
copy(id[:], ref[RecordIDSize:])
return &id
}
// Record returns record's RecordID.
func (ref *RecordRef) Record() *RecordID {
if ref == nil {
return nil
}
var id RecordID
copy(id[:], ref[:RecordIDSize])
return &id
}
// String outputs base58 RecordRef representation.
func (ref RecordRef) String() string {
return ref.Record().String() + RecordRefIDSeparator + ref.Domain().String()
}
// FromSlice : After CBOR Marshal/Unmarshal Ref can be converted to byte slice, this converts it back
func (ref RecordRef) FromSlice(from []byte) RecordRef {
for i := 0; i < RecordRefSize; i++ {
ref[i] = from[i]
}
return ref
}
// Bytes returns byte slice of RecordRef.
func (ref RecordRef) Bytes() []byte {
return ref[:]
}
// Equal checks if reference points to the same record.
func (ref RecordRef) Equal(other RecordRef) bool {
return ref == other
}
// IsEmpty - check for void
func (ref RecordRef) IsEmpty() bool {
return ref.Equal(RecordRef{})
}
// Compare compares two record references
func (ref RecordRef) Compare(other RecordRef) int {
return bytes.Compare(ref.Bytes(), other.Bytes())
}
// NewRefFromBase58 deserializes reference from base58 encoded string.
func NewRefFromBase58(str string) (*RecordRef, error) {
parts := strings.SplitN(str, RecordRefIDSeparator, 2)
if len(parts) < 2 {
return nil, errors.New("bad reference format")
}
recordID, err := NewIDFromBase58(parts[0])
if err != nil {
return nil, errors.Wrap(err, "bad record part")
}
domainID, err := NewIDFromBase58(parts[1])
if err != nil {
return nil, errors.Wrap(err, "bad domain part")
}
return NewRecordRef(*domainID, *recordID), nil
}
// MarshalJSON serializes reference into JSON.
func (ref *RecordRef) MarshalJSON() ([]byte, error) {
if ref == nil {
return json.Marshal(nil)
}
return json.Marshal(ref.String())
}
// DebugString prints ID in human readable form.
func (id *RecordID) DebugString() string {
if id == nil {
return "<nil>"
}
pulse := NewPulseNumber(id[:PulseNumberSize])
if pulse == PulseNumberJet {
depth := int(id[PulseNumberSize])
if depth == 0 {
return "[JET 0 -]"
}
prefix := id[PulseNumberSize+1:]
var res strings.Builder
res.WriteString("[JET ")
res.WriteString(strconv.Itoa(depth))
res.WriteString(" ")
for _, b := range prefix {
for j := 7; j >= 0; j-- {
if 0 == (b >> uint(j) & 0x01) {
res.WriteString("0")
} else {
res.WriteString("1")
}
depth--
if depth == 0 {
res.WriteString("]")
return res.String()
}
}
}
return fmt.Sprintf("[JET: <wrong format> %d %b]", depth, prefix)
}
return fmt.Sprintf("[%d | %s]", id.Pulse(), id.String())
}