Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typos #403

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: fix typos #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b0cac1
Update json.go
cratiu222 Sep 17, 2024
60e468d
Update subscription.go
cratiu222 Sep 17, 2024
f08f0e2
Update REGISTRY.md
cratiu222 Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gethrpc/json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ func (c *jsonCodec) Closed() <-chan interface{} {
return c.closed
}

// parseMessage parses raw bytes as a (batch of) JSON-RPC message(s). There are no error
// parseMessage parses raw bytes as a (batch of) JSON-RPC message(s). There is no error
// checks in this function because the raw message has already been syntax-checked when it
// is called. Any non-JSON-RPC messages in the input return the zero value of
// jsonrpcMessage.
Expand Down
6 changes: 3 additions & 3 deletions gethrpc/subscription.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func NewID() ID {
return globalGen()
}

// randomIDGenerator returns a function generates a random IDs.
// randomIDGenerator returns a function that generates a random IDs.
func randomIDGenerator() func() ID {
seed, err := binary.ReadVarint(bufio.NewReader(crand.Reader))
if err != nil {
Expand Down Expand Up @@ -97,7 +97,7 @@ type Notifier struct {
// CreateSubscription returns a new subscription that is coupled to the
// RPC connection. By default subscriptions are inactive and notifications
// are dropped until the subscription is marked as active. This is done
// by the RPC server after the subscription ID is send to the client.
// by the RPC server after the subscription ID is sent to the client.
func (n *Notifier) CreateSubscription() *Subscription {
n.mu.Lock()
defer n.mu.Unlock()
Expand Down Expand Up @@ -152,7 +152,7 @@ func (n *Notifier) takeSubscription() *Subscription {
}

// activate is called after the subscription ID was sent to client. Notifications are
// buffered before activation. This prevents notifications being sent to the client before
// buffered before activation. This prevents notifications from being sent to the client before
// the subscription ID is sent to the client.
func (n *Notifier) activate() error {
n.mu.Lock()
Expand Down
4 changes: 2 additions & 2 deletions registry/REGISTRY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The GSRPC Registry can parse target metadata information into an in-memory regis

By leveraging the on-chain metadata, GSRPC is more robust to changes on types, allowing clients to only keep updated the types that are relevant to their business operation.

This registry can be used afterwards to decode data read from live chains (events & extrinsics).
This registry can be used afterwards to decode data read from live chains (events & extrinsic).

## How to parse events and its types
First we instantiate the API with the client node and open a connection:
Expand Down Expand Up @@ -80,4 +80,4 @@ On the other hand, since a great majority of chains do not need to change these
#### Using Chain Defaults
[TestExtrinsicRetriever_NewDefault](retriever/extrinsic_retriever_test.go#L179)
#### Using Custom core types
[TestLive_ExtrinsicRetriever_GetExtrinsics](retriever/extrinsic_retriever_live_test.go)
[TestLive_ExtrinsicRetriever_GetExtrinsics](retriever/extrinsic_retriever_live_test.go)