-
Notifications
You must be signed in to change notification settings - Fork 39
/
service.go
445 lines (374 loc) · 15.5 KB
/
service.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
package purchaseorder
import (
"bytes"
"fmt"
"time"
"github.com/centrifuge/centrifuge-protobufs/gen/go/coredocument"
"github.com/centrifuge/centrifuge-protobufs/gen/go/notification"
"github.com/centrifuge/centrifuge-protobufs/gen/go/p2p"
"github.com/centrifuge/go-centrifuge/anchors"
"github.com/centrifuge/go-centrifuge/config"
"github.com/centrifuge/go-centrifuge/coredocument"
"github.com/centrifuge/go-centrifuge/documents"
"github.com/centrifuge/go-centrifuge/errors"
"github.com/centrifuge/go-centrifuge/header"
"github.com/centrifuge/go-centrifuge/identity"
"github.com/centrifuge/go-centrifuge/notification"
clientpopb "github.com/centrifuge/go-centrifuge/protobufs/gen/go/purchaseorder"
"github.com/centrifuge/go-centrifuge/signatures"
"github.com/centrifuge/go-centrifuge/utils"
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/golang/protobuf/ptypes"
logging "github.com/ipfs/go-log"
)
var srvLog = logging.Logger("po-service")
// Service defines specific functions for purchase order
type Service interface {
documents.Service
// DeriverFromPayload derives purchase order from clientPayload
DeriveFromCreatePayload(payload *clientpopb.PurchaseOrderCreatePayload, hdr *header.ContextHeader) (documents.Model, error)
// DeriveFromUpdatePayload derives purchase order from update payload
DeriveFromUpdatePayload(payload *clientpopb.PurchaseOrderUpdatePayload, hdr *header.ContextHeader) (documents.Model, error)
// Create validates and persists purchase order and returns a Updated model
Create(ctx *header.ContextHeader, po documents.Model) (documents.Model, error)
// Update validates and updates the purchase order and return the updated model
Update(ctx *header.ContextHeader, po documents.Model) (documents.Model, error)
// DerivePurchaseOrderData returns the purchase order data as client data
DerivePurchaseOrderData(po documents.Model) (*clientpopb.PurchaseOrderData, error)
// DerivePurchaseOrderResponse returns the purchase order in our standard client format
DerivePurchaseOrderResponse(po documents.Model) (*clientpopb.PurchaseOrderResponse, error)
}
// service implements Service and handles all purchase order related persistence and validations
// service always returns errors of type `errors.Error` or `errors.TypedError`
type service struct {
config documents.Config
repo documents.Repository
coreDocProcessor coredocument.Processor
notifier notification.Sender
anchorRepository anchors.AnchorRepository
identityService identity.Service
}
// DefaultService returns the default implementation of the service
func DefaultService(config config.Configuration, repo documents.Repository, processor coredocument.Processor, anchorRepository anchors.AnchorRepository, identityService identity.Service) Service {
return service{config: config, repo: repo, coreDocProcessor: processor, notifier: notification.NewWebhookSender(config), anchorRepository: anchorRepository, identityService: identityService}
}
// DeriveFromCoreDocument takes a core document and returns a purchase order
func (s service) DeriveFromCoreDocument(cd *coredocumentpb.CoreDocument) (documents.Model, error) {
var model documents.Model = new(PurchaseOrder)
err := model.UnpackCoreDocument(cd)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentUnPackingCoreDocument, err)
}
return model, nil
}
// calculateDataRoot validates the document, calculates the data root, and persists to DB
func (s service) calculateDataRoot(old, new documents.Model, validator documents.Validator) (documents.Model, error) {
po, ok := new.(*PurchaseOrder)
if !ok {
return nil, errors.NewTypedError(documents.ErrDocumentInvalidType, fmt.Errorf("unknown document type: %T", new))
}
// create data root, has to be done at the model level to access fields
err := po.calculateDataRoot()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
// validate the invoice
err = validator.Validate(old, po)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
// get tenant ID
tenantID, err := s.config.GetIdentityID()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentConfigTenantID, err)
}
// we use CurrentVersion as the id since that will be unique across multiple versions of the same document
err = s.repo.Create(tenantID, po.CoreDocument.CurrentVersion, po)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPersistence, err)
}
return po, nil
}
// Create validates, persists, and anchors a purchase order
func (s service) Create(ctx *header.ContextHeader, po documents.Model) (documents.Model, error) {
po, err := s.calculateDataRoot(nil, po, CreateValidator())
if err != nil {
return nil, err
}
po, err = documents.AnchorDocument(ctx, po, s.coreDocProcessor, s.updater)
if err != nil {
return nil, err
}
return po, nil
}
// updater wraps logic related to updating documents so that it can be executed as a closure
func (s service) updater(id []byte, model documents.Model) error {
// get tenant ID
tenantID, err := s.config.GetIdentityID()
if err != nil {
return errors.NewTypedError(documents.ErrDocumentConfigTenantID, err)
}
return s.repo.Update(tenantID, id, model)
}
// Update validates, persists, and anchors a new version of purchase order
func (s service) Update(ctx *header.ContextHeader, po documents.Model) (documents.Model, error) {
cd, err := po.PackCoreDocument()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPackingCoreDocument, err)
}
old, err := s.GetCurrentVersion(cd.DocumentIdentifier)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentNotFound, err)
}
po, err = s.calculateDataRoot(old, po, UpdateValidator())
if err != nil {
return nil, err
}
po, err = documents.AnchorDocument(ctx, po, s.coreDocProcessor, s.updater)
if err != nil {
return nil, err
}
return po, nil
}
// DeriveFromCreatePayload derives purchase order from create payload
func (s service) DeriveFromCreatePayload(payload *clientpopb.PurchaseOrderCreatePayload, ctxH *header.ContextHeader) (documents.Model, error) {
if payload == nil || payload.Data == nil {
return nil, documents.ErrDocumentNil
}
po := new(PurchaseOrder)
err := po.InitPurchaseOrderInput(payload, ctxH)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
return po, nil
}
// DeriveFromUpdatePayload derives purchase order from update payload
func (s service) DeriveFromUpdatePayload(payload *clientpopb.PurchaseOrderUpdatePayload, ctxH *header.ContextHeader) (documents.Model, error) {
if payload == nil || payload.Data == nil {
return nil, documents.ErrDocumentNil
}
// get latest old version of the document
id, err := hexutil.Decode(payload.Identifier)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentIdentifier, fmt.Errorf("failed to decode identifier: %v", err))
}
old, err := s.GetCurrentVersion(id)
if err != nil {
return nil, err
}
// load purchase order data
po := new(PurchaseOrder)
err = po.initPurchaseOrderFromData(payload.Data)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, fmt.Errorf("failed to load purchase order from data: %v", err))
}
// update core document
oldCD, err := old.PackCoreDocument()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPackingCoreDocument, err)
}
collaborators := append([]string{ctxH.Self().ID.String()}, payload.Collaborators...)
po.CoreDocument, err = coredocument.PrepareNewVersion(*oldCD, collaborators)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPrepareCoreDocument, err)
}
return po, nil
}
// DerivePurchaseOrderData returns po data from the model
func (s service) DerivePurchaseOrderData(doc documents.Model) (*clientpopb.PurchaseOrderData, error) {
po, ok := doc.(*PurchaseOrder)
if !ok {
return nil, documents.ErrDocumentInvalidType
}
return po.getClientData(), nil
}
// DerivePurchaseOrderResponse returns po response from the model
func (s service) DerivePurchaseOrderResponse(doc documents.Model) (*clientpopb.PurchaseOrderResponse, error) {
cd, err := doc.PackCoreDocument()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPackingCoreDocument, err)
}
collaborators := make([]string, len(cd.Collaborators))
for i, c := range cd.Collaborators {
cid, err := identity.ToCentID(c)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentCollaborator, err)
}
collaborators[i] = cid.String()
}
header := &clientpopb.ResponseHeader{
DocumentId: hexutil.Encode(cd.DocumentIdentifier),
VersionId: hexutil.Encode(cd.CurrentVersion),
Collaborators: collaborators,
}
data, err := s.DerivePurchaseOrderData(doc)
if err != nil {
return nil, err
}
return &clientpopb.PurchaseOrderResponse{
Header: header,
Data: data,
}, nil
}
func (s service) getPurchaseOrderVersion(documentID, version []byte) (model *PurchaseOrder, err error) {
// get tenant ID
tenantID, err := s.config.GetIdentityID()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentConfigTenantID, err)
}
doc, err := s.repo.Get(tenantID, version)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentVersionNotFound, err)
}
model, ok := doc.(*PurchaseOrder)
if !ok {
return nil, documents.ErrDocumentInvalidType
}
if !bytes.Equal(model.CoreDocument.DocumentIdentifier, documentID) {
return nil, errors.NewTypedError(documents.ErrDocumentVersionNotFound, fmt.Errorf("version is not valid for this identifier"))
}
return model, nil
}
// GetLastVersion returns the latest version of the document
func (s service) GetCurrentVersion(documentID []byte) (documents.Model, error) {
model, err := s.getPurchaseOrderVersion(documentID, documentID)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentNotFound, err)
}
nextVersion := model.CoreDocument.NextVersion
for nextVersion != nil {
temp, err := s.getPurchaseOrderVersion(documentID, nextVersion)
if err != nil {
// here the err is returned as nil because it is expected that the nextVersion is not available in the db at some stage of the iteration
return model, nil
}
model = temp
nextVersion = model.CoreDocument.NextVersion
}
return model, nil
}
// GetVersion returns the specific version of the document
func (s service) GetVersion(documentID []byte, version []byte) (documents.Model, error) {
po, err := s.getPurchaseOrderVersion(documentID, version)
if err != nil {
return nil, err
}
return po, nil
}
// purchaseOrderProof creates proofs for purchaseOrder model fields
func (s service) purchaseOrderProof(model documents.Model, fields []string) (*documents.DocumentProof, error) {
po, ok := model.(*PurchaseOrder)
if !ok {
return nil, documents.ErrDocumentInvalidType
}
if err := coredocument.PostAnchoredValidator(s.identityService, s.anchorRepository).Validate(nil, po); err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
coreDoc, proofs, err := po.createProofs(fields)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentProof, err)
}
return &documents.DocumentProof{
DocumentID: coreDoc.DocumentIdentifier,
VersionID: coreDoc.CurrentVersion,
FieldProofs: proofs,
}, nil
}
// CreateProofs generates proofs for given document
func (s service) CreateProofs(documentID []byte, fields []string) (*documents.DocumentProof, error) {
model, err := s.GetCurrentVersion(documentID)
if err != nil {
return nil, err
}
return s.purchaseOrderProof(model, fields)
}
// CreateProofsForVersion generates proofs for specific version of the document
func (s service) CreateProofsForVersion(documentID, version []byte, fields []string) (*documents.DocumentProof, error) {
model, err := s.GetVersion(documentID, version)
if err != nil {
return nil, err
}
return s.purchaseOrderProof(model, fields)
}
// RequestDocumentSignature validates the document and returns the signature
// Note: this is document agnostic. But since we do not have a common implementation, adding it here.
// will remove this once we have a common implementation for documents.Service
func (s service) RequestDocumentSignature(contextHeader *header.ContextHeader, model documents.Model) (*coredocumentpb.Signature, error) {
if err := coredocument.SignatureRequestValidator(s.identityService).Validate(nil, model); err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
cd, err := model.PackCoreDocument()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPackingCoreDocument, err)
}
srvLog.Infof("coredoc received %x with signing root %x", cd.DocumentIdentifier, cd.SigningRoot)
idKeys, ok := contextHeader.Self().Keys[identity.KeyPurposeSigning]
if !ok {
return nil, errors.NewTypedError(documents.ErrDocumentSigning, fmt.Errorf("missing signing key"))
}
sig := signatures.Sign(contextHeader.Self().ID[:], idKeys.PrivateKey, idKeys.PublicKey, cd.SigningRoot)
cd.Signatures = append(cd.Signatures, sig)
err = model.UnpackCoreDocument(cd)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentUnPackingCoreDocument, err)
}
// get tenant ID
tenantID, err := s.config.GetIdentityID()
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentConfigTenantID, err)
}
// Logic for receiving version n (n > 1) of the document for the first time
if !s.repo.Exists(tenantID, cd.DocumentIdentifier) && !utils.IsSameByteSlice(cd.DocumentIdentifier, cd.CurrentVersion) {
err = s.repo.Create(tenantID, cd.DocumentIdentifier, model)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPersistence, err)
}
}
err = s.repo.Create(tenantID, cd.CurrentVersion, model)
if err != nil {
return nil, errors.NewTypedError(documents.ErrDocumentPersistence, err)
}
srvLog.Infof("signed coredoc %x with version %x", cd.DocumentIdentifier, cd.CurrentVersion)
return sig, nil
}
// ReceiveAnchoredDocument validates the anchored document and updates it on DB
// Note: this is document agnostic. But since we do not have a common implementation, adding it here.
// will remove this once we have a common implementation for documents.Service
func (s service) ReceiveAnchoredDocument(model documents.Model, headers *p2ppb.CentrifugeHeader) error {
if err := coredocument.PostAnchoredValidator(s.identityService, s.anchorRepository).Validate(nil, model); err != nil {
return errors.NewTypedError(documents.ErrDocumentInvalid, err)
}
doc, err := model.PackCoreDocument()
if err != nil {
return errors.NewTypedError(documents.ErrDocumentPackingCoreDocument, err)
}
// get tenant ID
tenantID, err := s.config.GetIdentityID()
if err != nil {
return errors.NewTypedError(documents.ErrDocumentConfigTenantID, err)
}
err = s.repo.Update(tenantID, doc.CurrentVersion, model)
if err != nil {
return errors.NewTypedError(documents.ErrDocumentPersistence, err)
}
ts, _ := ptypes.TimestampProto(time.Now().UTC())
notificationMsg := ¬ificationpb.NotificationMessage{
EventType: uint32(notification.ReceivedPayload),
CentrifugeId: hexutil.Encode(headers.SenderCentrifugeId),
Recorded: ts,
DocumentType: doc.EmbeddedData.TypeUrl,
DocumentId: hexutil.Encode(doc.DocumentIdentifier),
}
// Async until we add queuing
go s.notifier.Send(notificationMsg)
return nil
}
// Exists checks if an purchase order exists
func (s service) Exists(documentID []byte) bool {
// get tenant ID
tenantID, err := s.config.GetIdentityID()
if err != nil {
return false
}
return s.repo.Exists(tenantID, documentID)
}