[#973] morph/subnet: Fix docs and comments of notification events

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2021-11-28 12:43:03 +03:00 committed by LeL
parent 52fc5bde6e
commit b27c72c02a
2 changed files with 11 additions and 8 deletions

View file

@ -28,7 +28,7 @@ func (x Delete) ID() []byte {
} }
// TxHash returns hash of the transaction which thrown the notification event. // TxHash returns hash of the transaction which thrown the notification event.
// Makes sense only in non-notary environments (see NotaryMainTx). // Makes sense only in notary environments.
func (x Delete) TxHash() util.Uint256 { func (x Delete) TxHash() util.Uint256 {
return x.txHash return x.txHash
} }

View file

@ -19,7 +19,7 @@ type Put struct {
id []byte id []byte
ownerID []byte owner []byte
info []byte info []byte
} }
@ -32,9 +32,9 @@ func (x Put) ID() []byte {
return x.id return x.id
} }
// Owner returns subnet owner's ID in a binary format of NeoFS API protocol. // Owner returns subnet owner's public key in a binary format.
func (x Put) Owner() []byte { func (x Put) Owner() []byte {
return x.ownerID return x.owner
} }
// Info returns information about the subnet in a binary format of NeoFS API protocol. // Info returns information about the subnet in a binary format of NeoFS API protocol.
@ -43,7 +43,7 @@ func (x Put) Info() []byte {
} }
// TxHash returns hash of the transaction which thrown the notification event. // TxHash returns hash of the transaction which thrown the notification event.
// Makes sense only in non-notary environments (see NotaryMainTx). // Makes sense only in notary environments.
func (x Put) TxHash() util.Uint256 { func (x Put) TxHash() util.Uint256 {
return x.txHash return x.txHash
} }
@ -87,12 +87,12 @@ func ParsePut(e *subscriptions.NotificationEvent) (event.Event, error) {
} }
// parse owner // parse owner
put.ownerID, err = client.BytesFromStackItem(items[1]) put.owner, err = client.BytesFromStackItem(items[1])
if err != nil { if err != nil {
return nil, fmt.Errorf("owner item: %w", err) return nil, fmt.Errorf("owner item: %w", err)
} }
// parse public key // parse info about subnet
put.info, err = client.BytesFromStackItem(items[2]) put.info, err = client.BytesFromStackItem(items[2])
if err != nil { if err != nil {
return nil, fmt.Errorf("info item: %w", err) return nil, fmt.Errorf("info item: %w", err)
@ -125,16 +125,19 @@ func ParseNotaryPut(e event.NotaryEvent) (event.Event, error) {
return nil, event.WrongNumberOfParameters(itemNumPut, ln) return nil, event.WrongNumberOfParameters(itemNumPut, ln)
} }
// parse info about subnet
put.info, err = event.BytesFromOpcode(prms[0]) put.info, err = event.BytesFromOpcode(prms[0])
if err != nil { if err != nil {
return nil, fmt.Errorf("info param: %w", err) return nil, fmt.Errorf("info param: %w", err)
} }
put.ownerID, err = event.BytesFromOpcode(prms[1]) // parse owner
put.owner, err = event.BytesFromOpcode(prms[1])
if err != nil { if err != nil {
return nil, fmt.Errorf("creator param: %w", err) return nil, fmt.Errorf("creator param: %w", err)
} }
// parse ID
put.id, err = event.BytesFromOpcode(prms[2]) put.id, err = event.BytesFromOpcode(prms[2])
if err != nil { if err != nil {
return nil, fmt.Errorf("id param: %w", err) return nil, fmt.Errorf("id param: %w", err)