Skip to content

Commit

Permalink
morph/client: Tidy up ReceiveNotaryRequests method docs
Browse files Browse the repository at this point in the history
Transaction signer parameter is not a filter: it extends event stream
with specific notary requests, not filters out the other ones added the
same way.

Signed-off-by: Leonard Lyubich <[email protected]>
  • Loading branch information
cthulhu-rider committed Dec 7, 2023
1 parent 13c3c58 commit 598259b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pkg/morph/client/notifications.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,10 @@ func (c *Client) ReceiveBlocks() error {
}

// ReceiveNotaryRequests performs subscription for notary request payloads
// addition or removal events to this instance of client. Passed txSigner is
// used as filter: subscription is only for the notary requests that must be
// signed by txSigner. Events are sent to a returned channel.
// The channel is closed when connection to RPC nodes is lost.
// addition or removal events to this instance of client. Passed txSigner
// expands the flow of notary requests to those whose main transaction signers
// include the specified account. Events are sent to a returned channel. The
// channel is closed when connection to RPC nodes is lost.
//
// Returns ErrConnectionLost if client has not been able to establish
// connection to any of passed RPC endpoints.
Expand Down

0 comments on commit 598259b

Please sign in to comment.