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.

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

Improve RPC docs #1281

Merged
merged 5 commits into from
Sep 13, 2024
Merged

Conversation

fabiorigam
Copy link
Member

No description provided.

@fabiorigam fabiorigam requested a review from a team as a code owner September 12, 2024 08:11
@fabiorigam fabiorigam linked an issue Sep 12, 2024 that may be closed by this pull request
2 tasks
Copy link

github-actions bot commented Sep 12, 2024

Test Coverage

Summary

Lines Statements Branches Functions
Coverage: 99%
99.41% (4073/4097) 98.3% (1279/1301) 99.75% (807/809)
Title Tests Skipped Failures Errors Time
core 794 0 💤 0 ❌ 0 🔥 1m 35s ⏱️
network 668 0 💤 0 ❌ 0 🔥 4m 16s ⏱️
errors 42 0 💤 0 ❌ 0 🔥 14.939s ⏱️

```

By default, the proxy is configured to be used with a solo node running on your local machine. If you want to change the
default behavior, create a config.json file and pass it to the command when launching the RPC Proxy:
By default, the proxy is configured to be used with a solo node running on your local machine. There are two options if you want to change the default behavior, or use a custom configuration:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be behaviour

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In US english it's behavior. I see we use it a lot on other parts of the SDK. We should decide and be consistent.

Copy link
Collaborator

@victhorbi victhorbi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LEGIT!

@fabiorigam fabiorigam merged commit 24218aa into main Sep 13, 2024
10 checks passed
@fabiorigam fabiorigam deleted the 1260-update-npm-documentation-of-rpc-proxy branch September 13, 2024 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update npm documentation of rpc-proxy
3 participants