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

docs: use only RpcProvider #857

Merged
merged 6 commits into from
Dec 5, 2023

Conversation

PhilippeR26
Copy link
Collaborator

Motivation and Resolution

Following removal of Starknet sequencers, users shall only use RpcSequencer.
The guides are here updated in accordance.
It's also the opportunity to migrate in the guides from Pythonic Devnet to Starknet-devnet-rs.

Usage related changes

N/A

Development related changes

N/A

Checklist:

  • Rebased to the last commit of the target branch (or merged it into my branch)
  • All tests are passing

Copy link

netlify bot commented Nov 30, 2023

Deploy Preview for starknetjs ready!

Name Link
🔨 Latest commit 0ba3744
🔍 Latest deploy log https://app.netlify.com/sites/starknetjs/deploys/656ebe09fbbaa80008d18f68
😎 Deploy Preview https://deploy-preview-857--starknetjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@penovicp penovicp left a comment

Choose a reason for hiding this comment

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

I would suggest documenting that new RpcProvider({ nodeUrl: constants.NetworkName.SN_GOERLI }) and new RpcProvider() are also possible and note that when using them a random public node will be selected, but also advise that using a specific nodeUrl is the better approach.

It might also make sense to mostly use one of those two options in most of the documentation or something like new RpcProvider({ nodeUrl: `${someNodeUrl}` }) and use specific nodeUrl values within www/docs/guides/connect_network.md to simplify documentation maintenance (e.g. the Nethermind URLs will soon change).

@ivpavici
Copy link
Collaborator

I would suggest documenting that new RpcProvider({ nodeUrl: constants.NetworkName.SN_GOERLI }) and new RpcProvider() are also possible and note that when using them a random public node will be selected, but also advise that using a specific nodeUrl is the better approach.

It might also make sense to mostly use one of those two options in most of the documentation or something like new RpcProvider({ nodeUrl: `${someNodeUrl}` }) and use specific nodeUrl values within www/docs/guides/connect_network.md to simplify documentation maintenance (e.g. the Nethermind URLs will soon change).

This is the new Juno link, but didn't test it yet if it's live: https://free-rpc.nethermind.io/mainnet-juno/v0_5

english wording

Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com>
@PhilippeR26
Copy link
Collaborator Author

PhilippeR26 commented Nov 30, 2023

This is the new Juno link, but didn't test it yet if it's live: https://free-rpc.nethermind.io/mainnet-juno/v0_5

It's live (I have a script to batch check quickly a list of nodes). Is it a difference with
https://limited-rpc.nethermind.io/mainnet-juno/v0_5?

@ivpavici
Copy link
Collaborator

This is the new Juno link, but didn't test it yet if it's live: https://free-rpc.nethermind.io/mainnet-juno/v0_5

It's live (I have a script to batch check quickly a list of nodes). Is it a difference with https://limited-rpc.nethermind.io/mainnet-juno/v0_5?

This is the new Juno link, but didn't test it yet if it's live: https://free-rpc.nethermind.io/mainnet-juno/v0_5

It's live (I have a script to batch check quickly a list of nodes). Is it a difference with https://limited-rpc.nethermind.io/mainnet-juno/v0_5?

yes I think they will turn off the old link... so if it works, maybe best to update to the new one!

@PhilippeR26
Copy link
Collaborator Author

I would suggest documenting that new RpcProvider({ nodeUrl: constants.NetworkName.SN_GOERLI }) and new RpcProvider() are also possible and note that when using them a random public node will be selected, but also advise that using a specific nodeUrl is the better approach.

It might also make sense to mostly use one of those two options in most of the documentation or something like new RpcProvider({ nodeUrl: `${someNodeUrl}` }) and use specific nodeUrl values within www/docs/guides/connect_network.md to simplify documentation maintenance (e.g. the Nethermind URLs will soon change).

Honestly, I wasn't aware of this random access.
I will have a look at this, and update.

@PhilippeR26
Copy link
Collaborator Author

PhilippeR26 commented Dec 1, 2023

I completely rewrote connect_network.md, and I modified all node names as proposed.

PhilippeR26 and others added 2 commits December 4, 2023 15:59
Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com>
Co-authored-by: Ivan Pavičić <ivan.pavicic@live.com>
www/docs/guides/connect_network.md Outdated Show resolved Hide resolved
www/docs/guides/connect_network.md Outdated Show resolved Hide resolved
www/docs/guides/connect_network.md Outdated Show resolved Hide resolved
www/docs/guides/connect_network.md Outdated Show resolved Hide resolved
www/docs/guides/connect_network.md Outdated Show resolved Hide resolved
www/docs/guides/connect_network.md Outdated Show resolved Hide resolved
www/docs/guides/events.md Outdated Show resolved Hide resolved
www/docs/guides/interact.md Outdated Show resolved Hide resolved
www/docs/guides/what_s_starknet.js.md Outdated Show resolved Hide resolved
www/docs/guides/what_s_starknet.js.md Outdated Show resolved Hide resolved
@penovicp penovicp merged commit 7e0cffa into starknet-io:develop Dec 5, 2023
3 of 4 checks passed
Copy link

github-actions bot commented Dec 6, 2023

🎉 This PR is included in version 5.24.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Jul 3, 2024

🎉 This issue has been resolved in version 7.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants