From d85c6c9b8fc952b3e1cbf9c39d25725f915012f4 Mon Sep 17 00:00:00 2001 From: Owanate Amachree Date: Thu, 24 Oct 2024 11:54:39 +0200 Subject: [PATCH 1/5] Docs monthly maintenance --- docs/01-concepts/powpeg/index.md | 1 + .../02-hardhat/troubleshooting.md | 60 ++++++++++++------- .../05-foundry/troubleshooting.md | 17 +++++- .../07-rpc-api/03-alchemy/index.md | 16 +++-- .../04-resources/06-guides/powpeg-app/faqs.md | 39 ++++++++---- .../06-guides/powpeg-app/pegin/ledger.md | 2 + .../06-guides/powpeg-app/pegin/trezor.md | 2 + 7 files changed, 92 insertions(+), 45 deletions(-) diff --git a/docs/01-concepts/powpeg/index.md b/docs/01-concepts/powpeg/index.md index ef10bc21..28d165e4 100644 --- a/docs/01-concepts/powpeg/index.md +++ b/docs/01-concepts/powpeg/index.md @@ -13,6 +13,7 @@ Rootstock’s **PowPeg** protocol, has matured from its inception in 2018 as a f - The PowPeg App is available on [Testnet](https://powpeg.testnet.rootstock.io/) and [Mainnet](https://powpeg.rootstock.io/). - For general information about the design and architecture, how to perform a peg-in transaction using Ledger and Trezor, Frequently asked questions and advanced operations you can perform on the PowPeg, please refer to the [PowPeg user guide](/resources/guides/powpeg-app/). - Get information on the signatories and attestion in the [PowPeg HSM Firmware Attestation](/concepts/powpeg/hsm-firmware-attestation) section. +- Read [Introducing Fast Mode: Getting RBTC via the PowPeg, but Faster](https://blog.rootstock.io/noticia/get-rbtc-fast-mode/) to learn about the difference between Native Mode and Fast Modes when using the PowPeg. ::: ## The History of the PowPeg Protocol diff --git a/docs/02-developers/05-smart-contracts/02-hardhat/troubleshooting.md b/docs/02-developers/05-smart-contracts/02-hardhat/troubleshooting.md index 973aa448..6d48cd82 100644 --- a/docs/02-developers/05-smart-contracts/02-hardhat/troubleshooting.md +++ b/docs/02-developers/05-smart-contracts/02-hardhat/troubleshooting.md @@ -10,27 +10,45 @@ This section provides help on some potential issues you may run into and tips on ## Errors -- Error HH8: There's one or more errors in your config file - ```shell - % npx hardhat compile - Error HH8: There's one or more errors in your config file: + + + Error HH8: There's one or more errors in your config file + + ```shell + % npx hardhat compile + Error HH8: There's one or more errors in your config file: - * Invalid account: #0 for network: rskMainnet - Expected string, received undefined - * Invalid account: #0 for network: rskTestnet - Expected string, received undefined + * Invalid account: #0 for network: rskMainnet - Expected string, received undefined + * Invalid account: #0 for network: rskTestnet - Expected string, received undefined - To learn more about Hardhat's configuration, please go to https://hardhat.org/config/ + To learn more about Hardhat's configuration, please go to https://hardhat.org/config/ - For more info go to https://hardhat.org/HH8 or run Hardhat with --show-stack-traces - ``` - > - FIX 1: Ensure the values in the environment variables matches with the hardhat network configuration `hardhat.config.js` file. For bash, run `source .env` in the root directory for dotenv to enable the environment variables. -- Error: Nothing to Compile - ```shell - % npx hardhat compile - Nothing to compile - ``` - > - FIX 2: Delete artifacts folder and run the `npx hardhat compile` command to generate new artifacts. -- Error: "GET /MyToken.json" Error (404): "Not found" - - Check that contracts were compiled successfully, and artifacts folder was generated. - - Check that all the steps in [interacting with frontend](/developers/smart-contracts/hardhat/interact-with-frontend/) were followed sequentially. -- Error: HH601: Script scripts/deploy.js doesn't exist. - - Ensure that you're running the `npx hardhat run --network hardhat scripts/deploy.js` command from the root directory. \ No newline at end of file + For more info go to https://hardhat.org/HH8 or run Hardhat with --show-stack-traces + ``` + > - FIX 1: Ensure the values in the environment variables matches with the hardhat network configuration `hardhat.config.js` file. For bash, run `source .env` in the root directory for dotenv to enable the environment variables. + + + + Error: Nothing to Compile + + ```shell + % npx hardhat compile + Nothing to compile + ``` + > - FIX 2: Delete artifacts folder and run the `npx hardhat compile` command to generate new artifacts. + + + + Error: "GET /MyToken.json" Error (404): "Not found" + + - Check that contracts were compiled successfully, and artifacts folder was generated. + - Check that all the steps in [interacting with frontend](/developers/smart-contracts/hardhat/interact-with-frontend/) were followed sequentially. + + + + Error: HH601: Script scripts/deploy.js doesn't exist. + + - Ensure that you're running the `npx hardhat run --network hardhat scripts/deploy.js` command from the root directory. + + + \ No newline at end of file diff --git a/docs/02-developers/05-smart-contracts/05-foundry/troubleshooting.md b/docs/02-developers/05-smart-contracts/05-foundry/troubleshooting.md index 63a4b735..65ab6144 100644 --- a/docs/02-developers/05-smart-contracts/05-foundry/troubleshooting.md +++ b/docs/02-developers/05-smart-contracts/05-foundry/troubleshooting.md @@ -9,5 +9,18 @@ tags: [guides, developers, smart contracts, rsk, rootstock, foundry, dApps, ethe This section provides help on some potential issues you may run into and tips on how to resolve them. ## Errors -- Error Transaction dropped from the mempool or Error Transaction not completed: check the tx-id in the explorer. The tx may have went successful but the error is still in the logs. Here are the [mainnet](https://explorer.rootstock.io/) and [testnet](https://explorer.testnet.rootstock.io/) explorers. -- Error Failed to get EIP-1559 fees: EIP-1559 is not supported or not activated on the Rootstock RPC url. The `--legacy` flag is passed to use legacy transactions instead of `EIP-1559`. \ No newline at end of file + + + + Error: Transaction dropped from the mempool or Error Transaction not completed + + Check the `tx-id` in the explorer. The tx may have went successful but the error is still in the logs. Here are the [mainnet](https://explorer.rootstock.io/) and [testnet](https://explorer.testnet.rootstock.io/) explorers. + + + + Error Failed to get EIP-1559 fees + + - EIP-1559 is not supported or not activated on the Rootstock RPC url. The `--legacy` flag is passed to use legacy transactions instead of `EIP-1559`. + + + \ No newline at end of file diff --git a/docs/02-developers/07-rpc-api/03-alchemy/index.md b/docs/02-developers/07-rpc-api/03-alchemy/index.md index e7817e80..e22b2be5 100644 --- a/docs/02-developers/07-rpc-api/03-alchemy/index.md +++ b/docs/02-developers/07-rpc-api/03-alchemy/index.md @@ -14,7 +14,6 @@ In this guide you will learn: - How to create an **Alchemy** project to make your first API call. - View some options to interact with the node RPC with the **Alchemy** sdk and tools. - ## Prerequisites Before you start this guide, make sure you have the following: @@ -28,11 +27,11 @@ Before you start this guide, make sure you have the following: - Developers looking to interact with the Rootstock nodes. ## Features -### Easy Setup: +### Easy Setup - Create an API key effortlessly to initiate development. - Make your first API call in minutes. -### API Key Authentication: +### API Key Authentication - Provides secure authentication for decentralized applications (dApps). - Limits API requests on a daily or monthly basis. @@ -67,7 +66,7 @@ The next screen will display the services available for the Rootstock network, i ![Alchemy - App information](/img/developers/quickstart/5-alchemy.png) -#### Set Up Tab: +#### Set Up Tab In the `Setup` tab you will see different options for using the rpc node, depending on the ***Method***, ***Language*** and ***SDK*** you need to use for it. By default, the dashboard shows an example for the `get latest block` call on `Javascript` and `Viem`. @@ -90,7 +89,7 @@ console.log(block); However, you will have different language options available for the rpc call, included `CLI` (command line interface). -#### Language Options: +#### Language Options - **CLI (Command Line Interface):** No SDK options are available with this choice. - **JavaScript:** You can choose from ***Viem***, ***Ethers.js***, or ***Fetch*** as your SDK options. - **TypeScript:** Only the ***Viem*** SDK option is available for selection. @@ -108,7 +107,8 @@ curl -X POST https://rootstock-mainnet.g.alchemy.com/v2/\ "id": 1 }' ``` -And the response should be something like this: + +And the response should look like this: ```json {"jsonrpc":"2.0","id":1,"result":{"number":"0x67a9c4","hash":"0xe3d0d2b47eb0a06f04cea614355a6ba10935c62596e188e3d27dcafb7ddc746f","parentHash":"0x140a94c77bc08077133d874405252b4463bcbfe500cc7a9e48f4626cdfd91104","sha3Uncles":"0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347","logsBloom":"0x00000000000000000000101000000000000080000040000000000000000000000020400000010000000000000000001000002000000000000008800000000000000000000000000000000000000008000000000000000001000000000000000000000000000000000040000000000000000000000000000000000000020000000001000000000081000000000004000000000000000000000000000020000000000000000200100020000000000000000180000000000080001000020000000000000001000000000000000000008000000030000000000000200000100000000000000000000000002004000880000000000400000000000000200010000200" … ``` @@ -126,11 +126,9 @@ In this tab, you will find the Rootstock card, where you can copy the RPC url yo #### Settings Tab In this tab you find different configuration options of your app, like advanced config, allow list, JWT keys, or delete your app from the **Alchemy** dashboard. -## Final Comments - +## Conclusion The use of RPC API is an important part of the frontend and backend interaction with the blockchain. Alchemy is a poweful platform which contains a lot of tools that can be used for developers to create their code faster. ## Useful Links - - [Alchemy Dashboard](https://www.alchemy.com/) - [Rootstock RPC API Service](/developers/smart-contracts/foundry/) \ No newline at end of file diff --git a/docs/04-resources/06-guides/powpeg-app/faqs.md b/docs/04-resources/06-guides/powpeg-app/faqs.md index cd362582..07dfd5fd 100644 --- a/docs/04-resources/06-guides/powpeg-app/faqs.md +++ b/docs/04-resources/06-guides/powpeg-app/faqs.md @@ -68,36 +68,49 @@ Here, you can find a list of frequently asked questions (FAQs) about the PowPeg > - ![Read popup info](/img/resources/powpeg/pegin-popup.png) - - 10. How long does it take for a native pegout transaction to complete? + + 10. How long does it take for a pegin transaction to complete using the PowPeg (FAST MODE) option? - > - native pegin needs 34 hours to be completed - > - ![Read popup info](/img/resources/powpeg/pegin-popup.png) + > - Using fast mode, pegin time has been significantly reduced to ~20 mins. + > Note: In Fast Mode, we utilize Liquidity Providers (LPs) to expedite the transfer of funds to end users. These third-party providers can set their own transfer times. This information is displayed on the screen, allowing users to select the LP that offers the most suitable transfer speed for their needs. - 11. What are the min and max for pegin transaction? + 11. How long does it take for a native pegout transaction to complete? + + > - native pegout needs 34 hours to be completed + + + + 12. How long does it take for a pegout transaction to complete using the PowPeg (FAST MODE) option? + + > - Using fast mode, pegout time has been significantly reduced to ~20 mins. + > Note: In Fast Mode, we utilize Liquidity Providers (LPs) to expedite the transfer of funds to end users. These third-party providers can set their own transfer times. This information is displayed on the screen, allowing users to select the LP that offers the most suitable transfer speed for their needs. + + + + 13. What are the min and max for pegin transaction? > - The minimum values allowed when creating a peg-in transaction is 0.005 BTC. > - The maximum values allowed when creating a peg-in transaction is 10 BTC. - - 12. What are the min and max for pegout transaction? + + 14. What are the min and max for pegout transaction? - > - The minimum values allowed when creating a peg-in transaction is 0.004 RBTC. - > - The maximum values allowed when creating a peg-in transaction is 10 RBTC. + > - The minimum values allowed when creating a peg-out transaction is 0.004 RBTC. + > - The maximum values allowed when creating a peg-out transaction is 10 RBTC. - - 13.After making a native pegout, to which address will I receive my BTCs? + + 15.After making a native pegout, to which address will I receive my BTCs? > - During the pegout process, the destination address of your BTC is derived from your signature, this enables one to know which address will receive the BTCs. > - See the [Derivation details page](/resources/guides/powpeg-app/pegout/deriving-electrum/) - - 14.When using **Trezor** i'm receiving the error **Forbidden key path** ? + + 16.When using **Trezor** i'm receiving the error **Forbidden key path** ? > - The latest versions of Trezor Suite have implemented a security rule to disable its use with non-standard key paths. Therefore, the user must explicitly set **Perform Safety Checks** to **PROMPT** option in **Trezor Suite** in order to use the **Trezor wallet** in the PowPeg application. > - If is not enabled you will receive this error ![Trezor Error Key Path](/img/resources/powpeg/trezor-error.png) diff --git a/docs/04-resources/06-guides/powpeg-app/pegin/ledger.md b/docs/04-resources/06-guides/powpeg-app/pegin/ledger.md index c196553a..1c1f66b8 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegin/ledger.md +++ b/docs/04-resources/06-guides/powpeg-app/pegin/ledger.md @@ -72,6 +72,8 @@ Here, we are using the ledger hardware wallet to interact with the PowPeg. Selec The pop up shown in the image below describes the duration of the peg-in process which requires at least 100 confirmations on the Bitcoin network, this gives an estimate of around 17 hours in total. It also describes the three main steps involved which is; connecting to the hardware wallet, sending a signed transaction to the BTC network until the corresponding RBTC value is made available in the destination wallet and a receipt for this transaction. +> Note: Using fast mode, pegin time has been significantly reduced to ~20 mins. + ![Read popup info](/img/resources/powpeg/pegin-popup.png) > Click the checkbox - “Don’t show again” to turn off this pop-up in the future or close temporarily. diff --git a/docs/04-resources/06-guides/powpeg-app/pegin/trezor.md b/docs/04-resources/06-guides/powpeg-app/pegin/trezor.md index fba72991..2dd23ff8 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegin/trezor.md +++ b/docs/04-resources/06-guides/powpeg-app/pegin/trezor.md @@ -31,6 +31,8 @@ In this guide, we will be performing a peg in transaction using the [PowPeg App] The pop up shown in the image below describes the duration of the peg-in process which requires at least 100 confirmations on the Bitcoin network, this gives an estimate of around 17 hours in total. It also describes the three main steps involved which is; connecting to the hardware wallet, sending a signed transaction to the BTC network until the corresponding RBTC value is made available in the destination wallet and a receipt for this transaction. +> Note: Using fast mode, pegin time has been significantly reduced to ~20 mins. + ![Connect Trezor](/img/resources/powpeg/pegin-popup.png) **Step 1: Connecting to a trezor wallet** From 5465274a5408ad781178d9cdcc48322c1927ac9f Mon Sep 17 00:00:00 2001 From: ivegabr Date: Tue, 29 Oct 2024 15:28:38 +0100 Subject: [PATCH 2/5] fix order, broken links, description --- .../07-rpc-api/02-rootstock/01-setup.md | 38 ++++--------------- .../07-rpc-api/02-rootstock/02-methods.md | 10 ++--- .../07-rpc-api/02-rootstock/_category_.yml | 5 --- .../07-rpc-api/02-rootstock/index.md | 33 ++++++++++++++++ docs/02-developers/07-rpc-api/index.md | 10 ++--- 5 files changed, 50 insertions(+), 46 deletions(-) delete mode 100644 docs/02-developers/07-rpc-api/02-rootstock/_category_.yml create mode 100644 docs/02-developers/07-rpc-api/02-rootstock/index.md diff --git a/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md b/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md index 983592fc..c8e3980f 100644 --- a/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md +++ b/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md @@ -1,47 +1,23 @@ --- sidebar_label: Getting Started -sidebar_position: 100 -title: Getting Started with the RPC API +sidebar_position: 101 +title: Getting Started with the Rootstock RPC Service tags: [faucet, Rootstock, testnet, address, wallet, tools] -description: "Get started with the RPC API service to interact with Rootstock nodes." +description: "Get started with the Rootstock RPC Service to interact with Rootstock nodes." --- -The [RPC API](http://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/node-operators/json-rpc/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. -In this guide, you will learn: - -- How to create an account and [make your first API call](#getting-started) -- View a list of [JSON-RPC methods](/node-operators/json-rpc/methods/) available. - -
- - Use the RPC API -
- -## Who Is It For? - -* dApp Developers looking to interact with the Rootstock nodes - -## Features - -**Easy Setup:** -- Create an API key effortlessly to initiate development. -- Make the First API call in minutes. - -**API Key Authentication:** -- Provides secure authentication for decentralized applications (dApps). -- Limits API requests on a daily or monthly basis. ## Getting Started :::info[Note] -The [RPC API](https://rpc.rootstock.io/) is available on TESTNET and MAINNET. +The [Rootstock RPC Service](https://rpc.rootstock.io/) is available on TESTNET and MAINNET. ::: -Visit the [Rootstock RPC API](https://rpc.rootstock.io/) +Visit the [Rootstock RPC Service](https://rpc.rootstock.io/)
- RPC API Landing Page + RPC Service Landing Page
### Get A FREE Account @@ -49,7 +25,7 @@ Visit the [Rootstock RPC API](https://rpc.rootstock.io/) To create an account, click on _Sign up_
- RPC API Sign Up + RPC Service Sign Up
### Get An API Key diff --git a/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md b/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md index 98c6d121..dbaf8d44 100644 --- a/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md +++ b/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md @@ -1,17 +1,17 @@ --- -sidebar_label: RPC API Methods -sidebar_position: 200 -title: RPC API Methods +sidebar_label: Rootstock RPC Service Methods +sidebar_position: 102 +title: RPC Service Methods tags: [faucet, Rootstock, rpc api, testnet, address, wallet, tools] description: "Easily create, interact and deploy EVM compatible smart contracts using a robust set of JSON RPC methods available through the RPC API." --- -Find below a list of methods available on the RPC API. See [how to setup the RPC API](/developers/rpc-api/setup/). +Find below a list of methods available on the Rootstock RPC Service. See [how to setup the Rootstock RPC Service](/developers/rpc-api/rootstock/setup/). ## eth_accounts - _Method:_ `eth_accounts` - - Returns a list of addresses owned by the client. Since Rootstock RPC API does not store keys, this will always return empty. + - Returns a list of addresses owned by the client. Since Rootstock RPC Service does not store keys, this will always return empty. - _Params:_ None ```shell diff --git a/docs/02-developers/07-rpc-api/02-rootstock/_category_.yml b/docs/02-developers/07-rpc-api/02-rootstock/_category_.yml deleted file mode 100644 index f0707634..00000000 --- a/docs/02-developers/07-rpc-api/02-rootstock/_category_.yml +++ /dev/null @@ -1,5 +0,0 @@ -label: Rootstock RPC API -position: 6 -link: - type: generated-index - slug: /developers/rpc-api/ \ No newline at end of file diff --git a/docs/02-developers/07-rpc-api/02-rootstock/index.md b/docs/02-developers/07-rpc-api/02-rootstock/index.md new file mode 100644 index 00000000..1515bd2c --- /dev/null +++ b/docs/02-developers/07-rpc-api/02-rootstock/index.md @@ -0,0 +1,33 @@ +--- +sidebar_label: Rootstock RPC Service +sidebar_position: 100 +title: Rootstock RPC Service +tags: [faucet, Rootstock, testnet, address, wallet, tools] +description: "Get started with the RPC API service to interact with Rootstock nodes." +--- + +The [Rootstock RPC Service](https://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/developers/rpc-api/rootstock/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. + +In this guide, you will learn: + +- How to create an account and [make your first API call](/developers/rpc-api/rootstock/setup/) +- View a list of [JSON-RPC methods](/developers/rpc-api/rootstock/methods/) available on the Rootstock RPC Service. + +
+ + Use the RPC Service +
+ +## Who Is It For? + +* dApp Developers looking to interact with the Rootstock nodes + +## Features + +**Easy Setup:** +- Create an API key effortlessly to initiate development. +- Make the First API call in minutes. + +**API Key Authentication:** +- Provides secure authentication for decentralized applications (dApps). +- Limits API requests on a daily or monthly basis. \ No newline at end of file diff --git a/docs/02-developers/07-rpc-api/index.md b/docs/02-developers/07-rpc-api/index.md index 11a96615..34e6e78e 100644 --- a/docs/02-developers/07-rpc-api/index.md +++ b/docs/02-developers/07-rpc-api/index.md @@ -1,14 +1,14 @@ --- sidebar_label: RPC API sidebar_position: 5 -title: Get your RPC API Key to interact with Rootstock +title: Interact with Rootstock via JSON-RPC tags: [faucet, Rootstock, testnet, address, wallet, tools, alchemy, rpc, api] description: "RPC API services for interacting with Rootstock network" --- -Get started with the RPC API service to interact with Rootstock nodes. +Get started interacting with Rootstock with using JSON-RPC methods with different service providers. -| Resource | Description | +| Provider | Description | | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [Rootstock API KEY Service](/developers/rpc-api-service/rootstock/) | Get started with creating a dApps on Rootstock using Hardhat. | -| [Alchemy-Rootstock API KEY service](/developers/smart-contracts/foundry/) | How to write, test, and deploy smart contracts with Foundry | \ No newline at end of file +| [Rootstock RPC Service](/developers/rpc-api/rootstock/) | Interact with Rootstock using the Rootstock RPC Service. | +| [Alchemy RPC Service](/developers/rpc-api/alchemy/) | Interact with Rootstock using the Alchemy RPC Service. | \ No newline at end of file From a878914342cd43992e41d4e9f58b6cd6ebc95bd8 Mon Sep 17 00:00:00 2001 From: ivegabr Date: Tue, 29 Oct 2024 15:34:09 +0100 Subject: [PATCH 3/5] change title --- docs/02-developers/07-rpc-api/02-rootstock/02-methods.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md b/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md index dbaf8d44..a470102a 100644 --- a/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md +++ b/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md @@ -1,7 +1,7 @@ --- sidebar_label: Rootstock RPC Service Methods sidebar_position: 102 -title: RPC Service Methods +title: Rootstock RPC Service Methods tags: [faucet, Rootstock, rpc api, testnet, address, wallet, tools] description: "Easily create, interact and deploy EVM compatible smart contracts using a robust set of JSON RPC methods available through the RPC API." --- From f8d5482cf68a28d1800a80cbfebc6d755418f4f5 Mon Sep 17 00:00:00 2001 From: Owanate Amachree Date: Wed, 30 Oct 2024 13:57:25 +0200 Subject: [PATCH 4/5] Ensure consistency in naming and style, fix broken links --- docs/02-developers/02-requirements/index.md | 2 +- docs/02-developers/04-quickstart/alchemy.md | 127 ------------------ docs/02-developers/04-quickstart/ape.md | 6 +- docs/02-developers/04-quickstart/foundry.md | 2 +- docs/02-developers/04-quickstart/hardhat.md | 4 +- docs/02-developers/04-quickstart/index.md | 19 +++ docs/02-developers/04-quickstart/remix.md | 2 +- .../04-quickstart/rootstock-etherspot.md | 2 +- docs/02-developers/04-quickstart/wagmi.md | 4 +- .../04-quickstart/web3-python.md | 2 +- .../02-hardhat/configure-hardhat-rootstock.md | 2 +- .../07-rpc-api/02-rootstock/01-setup.md | 10 +- .../07-rpc-api/02-rootstock/02-methods.md | 4 +- .../07-rpc-api/02-rootstock/index.md | 6 +- .../07-rpc-api/03-alchemy/index.md | 9 +- docs/02-developers/07-rpc-api/_category_.yml | 7 + docs/02-developers/07-rpc-api/index.md | 14 -- docs/02-developers/index.md | 4 +- .../08-public-nodes/index.md | 2 +- .../04-tutorials/rootstock-metamask.md | 2 +- .../04-tutorials/rootstock-rust.md | 4 +- .../Homepage/HomepageSectionProducts/index.js | 6 +- vercel.json | 4 +- 23 files changed, 65 insertions(+), 179 deletions(-) delete mode 100644 docs/02-developers/04-quickstart/alchemy.md create mode 100644 docs/02-developers/07-rpc-api/_category_.yml delete mode 100644 docs/02-developers/07-rpc-api/index.md diff --git a/docs/02-developers/02-requirements/index.md b/docs/02-developers/02-requirements/index.md index 536a96ec..d69aa283 100644 --- a/docs/02-developers/02-requirements/index.md +++ b/docs/02-developers/02-requirements/index.md @@ -21,7 +21,7 @@ Participating in a Rootstock hackathon or Workshop? View the [Hackathon Resource - Interact with Rootstock using the [RPC API](https://rpc.rootstock.io/) :::tip[Get an API Key] -See how to setup the RPC API and get an [API Key](/developers/rpc-api/setup). +See how to setup the RPC API and get an [API Key](/developers/rpc-api/rootstock/setup/). ::: ## Connecting to a Wallet diff --git a/docs/02-developers/04-quickstart/alchemy.md b/docs/02-developers/04-quickstart/alchemy.md deleted file mode 100644 index b8032dfe..00000000 --- a/docs/02-developers/04-quickstart/alchemy.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -sidebar_label: Using Alchemy RPC Service -sidebar_position: 700 -title: Rootstock - Alchemy RPC Service -description: 'Short guide to interact with the Rootstock network using Alchemy RPC service.' -tags: [rsk, rootstock, tutorials, developers, alchemy, quick starts, dApps, smart contracts, rpc] ---- - -This guide provides a step-to-step for developers to interact with Rootstock network with the [Alchemy RPC Provider Service](https://www.alchemy.com/). - -It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. - -In this guide you will learn: -- How to create an **Alchemy** project to make your first API call. -- View some options to interact with the node RPC with the **Alchemy** sdk and tools. - - -## Prerequisites - -Before you start this guide, make sure you have the following: - -- Basic understanding of smart contracts and how to interact with them on the Rootstock blockchain. -- Familiarity with Ethereum-based dApp development can be helpful. -- Ensure you have a development environment set up for interacting with blockchain nodes. -- Basic programming knowledge of ***JavaScript***, ***Python***, or other supported languages to make `API calls`. And familiarity with making ***HTTP*** requests and handling ***JSON*** responses. - -## Who Is It For? -- Developers looking to interact with the Rootstock nodes. - -## Features -**Easy Setup:** -- Create an API key effortlessly to initiate development. -- Make your first API call in minutes. - -**API Key Authentication:** -- Provides secure authentication for decentralized applications (dApps). -- Limits API requests on a daily or monthly basis. - -## Getting Started - -To access the **Alchemy** tools, visit its [Dashboard Portal](https://www.alchemy.com/). If you don't already have an account, you can sign up for free. And then, simply log in to get started. - -### Step 1: Create New App -After logging in, you'll be directed to the main dashboard. From there, you have different options for interacting with **Alchemy** tools. - -![Alchemy - Create New App](/img/developers/quickstart/1-alchemy.png) - -Click the option `Create new app`, where you'll be prompted to provide the ***app's name***, ***description***, and specify its intended ***use case***. - -- **Name:** This is your app's unique identifier. Choose a meaningful and descriptive name to help you easily recognize the app in your dashboard. This name will appear throughout the platform and may be used in API references. -- **Description (Optional):** Provide additional information about the app's purpose or functionality. While this field is optional, it's a good practice to include a brief description to help you or your team members understand the app's role or features, especially when managing multiple apps. -- **Use Case:** Specify how you plan to use the app. **Alchemy** provides options such as ***Defi***, ***Analytics***, ***Gaming***, ***Wallet***, among others. Choosing the correct use case helps configure the app properly for its intended environment, ensuring it performs optimally for development, testing, or live deployment. - -![Alchemy - App Props](/img/developers/quickstart/2-alchemy.png) - -### Step 2: Choose Chains -After clicking `Next`, you'll be prompted to select the network for your dApp. In the Search field, type ***Rootstock***, then click on the Rootstock node. Once selected, click the `Next` button to proceed. - -![Alchemy - Choose Chain](/img/developers/quickstart/3-alchemy.png) - -### Step 3: Activate Services -The next screen will display the services available for the Rootstock network, including ***NODE API***. Click on Create app to complete the setup. - -![Alchemy - Activate Services](/img/developers/quickstart/4-alchemy.png) - - Your app information will now be visible, similar to the example shown. - -![Alchemy - App information](/img/developers/quickstart/5-alchemy.png) - -#### Set Up Tab: -In the `Set up` tab you will see different options for using the rpc node, depending on the ***Method***, ***Language*** and ***SDK*** you need to use for it. - -By default, the dashboard shows an example for the `get latest block` call on `Javascript` and `Viem`. - -```javascript -import { createPublicClient, http } from "viem"; -import { rootstock } from "viem/chains"; - -const client = createPublicClient({ - chain: rootstock, - transport: http("https://rootstock-mainnet.g.alchemy.com/v2/"), -}); - -const block = await client.getBlock({ - blockNumber: 123456n, -}); - -console.log(block); -``` - -However, you will have different language options available for the rpc call, included `CLI` (command line interface). - -#### Language Options: -- **CLI (Command Line Interface):** No SDK options are available with this choice. -- **JavaScript:** You can choose from ***Viem***, ***Ethers.js***, or ***Fetch*** as your SDK options. -- **TypeScript:** Only the ***Viem*** SDK option is available for selection. -- **Python:** You can select ***web3.py*** as the SDK option. - -Is it possible to test the CLI option easily in your console by pasting the following code: - -```bash -curl -X POST https://rootstock-mainnet.g.alchemy.com/v2/\ --H "Content-Type: application/json" \ --d '{ - "jsonrpc": "2.0", - "method": "eth_getBlockByNumber", - "params": ["latest", false], - "id": 1 -}' -``` -And the response should be something like this: -```json -{"jsonrpc":"2.0","id":1,"result":{"number":"0x67a9c4","hash":"0xe3d0d2b47eb0a06f04cea614355a6ba10935c62596e188e3d27dcafb7ddc746f","parentHash":"0x140a94c77bc08077133d874405252b4463bcbfe500cc7a9e48f4626cdfd91104","sha3Uncles":"0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347","logsBloom":"0x00000000000000000000101000000000000080000040000000000000000000000020400000010000000000000000001000002000000000000008800000000000000000000000000000000000000008000000000000000001000000000000000000000000000000000040000000000000000000000000000000000000020000000001000000000081000000000004000000000000000000000000000020000000000000000200100020000000000000000180000000000080001000020000000000000001000000000000000000008000000030000000000000200000100000000000000000000000002004000880000000000400000000000000200010000200" … -``` - -#### Metrics Tab -In this tab, you can see the analytics for your app, with the success rates and total requests. - -![Alchemy - Metrics Tab](/img/developers/quickstart/6-alchemy.png) - -#### Networks Tab -In this tab, you will find the Rootstock card, where you can copy the RPC url you will use in your dApp (mainnet or testnet). - -![Alchemy - Networks Tab](/img/developers/quickstart/7-alchemy.png) - -#### Settings Tab -In this tab you find different configuration options of your app, like advanced config, allow list, JWT keys, or delete your app from the **Alchemy** dashboard. diff --git a/docs/02-developers/04-quickstart/ape.md b/docs/02-developers/04-quickstart/ape.md index 303db177..3fa19230 100644 --- a/docs/02-developers/04-quickstart/ape.md +++ b/docs/02-developers/04-quickstart/ape.md @@ -1,12 +1,12 @@ --- section_position: 400 -sidebar_label: Using Ape -title: Getting Started with Apeworx +sidebar_label: Getting Started with Ape +title: Getting Started with Ape description: 'How to compile, deploy, and intereact with smart contracts with Ape on Rootstock' tags: [rsk, ape, apeworx, developers, developer tools, tRBTC, rootstock, testing, dApps, smart contracts] --- -[Ape Framework](https://apeworx.io/framework/) is an easy-to-use Web3 development tool. Developers can compile, test, and interact with smart contracts all in one command line session. With its [modular plugin system](https://github.com/ApeWorX/ape?tab=readme-ov-file#plugin-system), Ape supports multiple contract languages and chains including Rootstock. +The [Ape Framework](https://apeworx.io/framework/) is an easy-to-use Web3 development tool. Developers can compile, test, and interact with smart contracts all in one command line session. With its [modular plugin system](https://github.com/ApeWorX/ape?tab=readme-ov-file#plugin-system), Ape supports multiple contract languages and chains including Rootstock. In this guide, we will learn about the [Ape Framework](https://apeworx.io/framework/) and its benefits for smart contract development, how to setup your development environment, create a Ape project and execute a deployment script for Rootstock. diff --git a/docs/02-developers/04-quickstart/foundry.md b/docs/02-developers/04-quickstart/foundry.md index 139a4a13..2a8084ac 100644 --- a/docs/02-developers/04-quickstart/foundry.md +++ b/docs/02-developers/04-quickstart/foundry.md @@ -1,5 +1,5 @@ --- -sidebar_label: Using Foundry +sidebar_label: Rootstock Foundry Starter kit sidebar_position: 500 title: Rootstock Foundry Starter kit description: 'Whether you are a seasoned developer or just starting your journey into smart contract development, the foundry starter kit provides a solid foundation for building decentralized applications (dApps) on the Rootstock network.' diff --git a/docs/02-developers/04-quickstart/hardhat.md b/docs/02-developers/04-quickstart/hardhat.md index 0e4034c4..22606ccd 100644 --- a/docs/02-developers/04-quickstart/hardhat.md +++ b/docs/02-developers/04-quickstart/hardhat.md @@ -1,7 +1,7 @@ --- -sidebar_label: Using Hardhat +sidebar_label: Rootstock Hardhat Starter Kit sidebar_position: 400 -title: Rootstock Hardhat Starter dApp +title: Rootstock Hardhat Starter Kit description: 'Whether you are a seasoned developer or just starting your journey into smart contract development, the hardhat starter kit provides a solid foundation for building decentralized applications (dApps) on the Rootstock network.' tags: [rsk, rootstock, tutorials, developers, hardhat, quick starts, dApps, smart contracts] --- diff --git a/docs/02-developers/04-quickstart/index.md b/docs/02-developers/04-quickstart/index.md index 61370ed7..0ebb32dd 100644 --- a/docs/02-developers/04-quickstart/index.md +++ b/docs/02-developers/04-quickstart/index.md @@ -14,6 +14,7 @@ values={[ {label: 'Remix', value: 'remix'}, {label: 'Wagmi', value: 'wagmi'}, {label: 'On-chain data', value: 'data'}, +{label: 'RPC API', value: 'rpc'}, {label: 'Ape', value: 'ape'}, {label: 'Port to Rootstock', value: 'port-dapps'} ]}> @@ -117,4 +118,22 @@ values={[ linkTitle="Use Ape" description="Learn how to compile, deploy, and intereact with smart contracts with Ape on Rootstock" /> + + diff --git a/docs/02-developers/04-quickstart/remix.md b/docs/02-developers/04-quickstart/remix.md index 3dc663b5..fa930fe0 100644 --- a/docs/02-developers/04-quickstart/remix.md +++ b/docs/02-developers/04-quickstart/remix.md @@ -1,5 +1,5 @@ --- -sidebar_label: Using Remix and Rootstock Explorer +sidebar_label: Deploy, Interact and Verify Smart Contracts using Remix and Rootstock Explorer sidebar_position: 600 title: Deploy, Interact and Verify Smart Contracts using Remix and Rootstock Explorer description: 'In this guide, we will use the Remix IDE to write, compile, deploy, interact and verify a smart contract on the Rootstock Explorer.' diff --git a/docs/02-developers/04-quickstart/rootstock-etherspot.md b/docs/02-developers/04-quickstart/rootstock-etherspot.md index 35e052ee..9282fe8c 100644 --- a/docs/02-developers/04-quickstart/rootstock-etherspot.md +++ b/docs/02-developers/04-quickstart/rootstock-etherspot.md @@ -1,5 +1,5 @@ --- -sidebar_label: Account Abstraction +sidebar_label: Account Abstraction using Etherspot Prime SDK sidebar_position: 600 title: Account Abstraction using Etherspot Prime SDK description: 'In this guide, you will learn how to use the Etherspot Prime SDK to deploy an Account Abstraction dApp on the Rootstock network. By following these steps, you will empower your users to interact with your dApp without managing private keys directly.' diff --git a/docs/02-developers/04-quickstart/wagmi.md b/docs/02-developers/04-quickstart/wagmi.md index d574ace2..7254f70c 100644 --- a/docs/02-developers/04-quickstart/wagmi.md +++ b/docs/02-developers/04-quickstart/wagmi.md @@ -1,7 +1,7 @@ --- -sidebar_label: Using Wagmi and React Hooks +sidebar_label: Rootstock Wagmi Starter Kit sidebar_position: 300 -title: Rootstock Wagmi Starter dApp +title: Rootstock Wagmi Starter Kit description: 'The Rootstock Wagmi Starter Kit provides a solid foundation for developing decentralized applications (dApps) on the Rootstock blockchain. It streamlines development by leveraging the React, Wagmi, and Shadcn libraries.' tags: [rsk, rootstock, developers, wagmi, quickstart, dApps, Smart Contracts] --- diff --git a/docs/02-developers/04-quickstart/web3-python.md b/docs/02-developers/04-quickstart/web3-python.md index fca4f7d0..a2a974f7 100644 --- a/docs/02-developers/04-quickstart/web3-python.md +++ b/docs/02-developers/04-quickstart/web3-python.md @@ -1,5 +1,5 @@ --- -sidebar_label: Using Web3.py +sidebar_label: Deploy and Interact with a Smart Contract using Web3.py sidebar_position: 200 title: Deploy and Interact with a Smart Contract using Web3.py description: 'Deploy and Interact with a Smart Contract Using Web3.py.' diff --git a/docs/02-developers/05-smart-contracts/02-hardhat/configure-hardhat-rootstock.md b/docs/02-developers/05-smart-contracts/02-hardhat/configure-hardhat-rootstock.md index 92c6c18f..12ef9d4c 100644 --- a/docs/02-developers/05-smart-contracts/02-hardhat/configure-hardhat-rootstock.md +++ b/docs/02-developers/05-smart-contracts/02-hardhat/configure-hardhat-rootstock.md @@ -66,7 +66,7 @@ To configure your `rskMainnet` and `rskTestnet` private keys, you'll need to upd }; ``` -> See how to [Get an API Key from the RPC API](/developers/rpc-api/setup/) +> See how to [Get an API Key from the RPC API](/developers/rpc-api/rootstock/setup/) > Replace `"your_mainnet_private_key"` and `"your_testnet_private_key"` with your private keys. For information on how to retrieve your private keys, see [How to export an account's private key](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key). diff --git a/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md b/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md index c8e3980f..cd07b848 100644 --- a/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md +++ b/docs/02-developers/07-rpc-api/02-rootstock/01-setup.md @@ -1,20 +1,18 @@ --- -sidebar_label: Getting Started +sidebar_label: Getting Started with the Rootstock RPC API sidebar_position: 101 -title: Getting Started with the Rootstock RPC Service +title: Getting Started with the Rootstock RPC API tags: [faucet, Rootstock, testnet, address, wallet, tools] description: "Get started with the Rootstock RPC Service to interact with Rootstock nodes." --- - - ## Getting Started :::info[Note] -The [Rootstock RPC Service](https://rpc.rootstock.io/) is available on TESTNET and MAINNET. +The [Rootstock RPC API](https://rpc.rootstock.io/) is available on TESTNET and MAINNET. ::: -Visit the [Rootstock RPC Service](https://rpc.rootstock.io/) +Visit the [Rootstock RPC API](https://rpc.rootstock.io/)
RPC Service Landing Page diff --git a/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md b/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md index a470102a..cdff10a7 100644 --- a/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md +++ b/docs/02-developers/07-rpc-api/02-rootstock/02-methods.md @@ -1,7 +1,7 @@ --- -sidebar_label: Rootstock RPC Service Methods +sidebar_label: Rootstock RPC API Methods sidebar_position: 102 -title: Rootstock RPC Service Methods +title: Rootstock RPC API Methods tags: [faucet, Rootstock, rpc api, testnet, address, wallet, tools] description: "Easily create, interact and deploy EVM compatible smart contracts using a robust set of JSON RPC methods available through the RPC API." --- diff --git a/docs/02-developers/07-rpc-api/02-rootstock/index.md b/docs/02-developers/07-rpc-api/02-rootstock/index.md index 1515bd2c..129a4031 100644 --- a/docs/02-developers/07-rpc-api/02-rootstock/index.md +++ b/docs/02-developers/07-rpc-api/02-rootstock/index.md @@ -1,12 +1,12 @@ --- -sidebar_label: Rootstock RPC Service +sidebar_label: Rootstock RPC API sidebar_position: 100 -title: Rootstock RPC Service +title: Rootstock RPC API tags: [faucet, Rootstock, testnet, address, wallet, tools] description: "Get started with the RPC API service to interact with Rootstock nodes." --- -The [Rootstock RPC Service](https://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/developers/rpc-api/rootstock/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. +The [Rootstock RPC API](https://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/developers/rpc-api/rootstock/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. In this guide, you will learn: diff --git a/docs/02-developers/07-rpc-api/03-alchemy/index.md b/docs/02-developers/07-rpc-api/03-alchemy/index.md index e22b2be5..5bed1038 100644 --- a/docs/02-developers/07-rpc-api/03-alchemy/index.md +++ b/docs/02-developers/07-rpc-api/03-alchemy/index.md @@ -1,12 +1,12 @@ --- -sidebar_label: Alchemy RPC API +sidebar_label: Rootstock - Alchemy RPC Provider sidebar_position: 300 -title: Rootstock - Alchemy RPC Service -description: 'Short guide to interact with the Rootstock network by using Alchemy RPC service.' +title: Rootstock - Alchemy RPC Provider +description: 'Guide to interacting with the Rootstock network using Alchemy.' tags: [rsk, rootstock, tutorials, developers, alchemy, quick starts, dApps, smart contracts, rpc] --- -This guide provides a step-to-step for developers to interact with Rootstock network with the [Alchemy RPC Provider Service](https://www.alchemy.com/). +A step-to-step guide for developers to interact with Rootstock network with the [Alchemy RPC Provider](https://www.alchemy.com/). It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain. @@ -27,6 +27,7 @@ Before you start this guide, make sure you have the following: - Developers looking to interact with the Rootstock nodes. ## Features + ### Easy Setup - Create an API key effortlessly to initiate development. - Make your first API call in minutes. diff --git a/docs/02-developers/07-rpc-api/_category_.yml b/docs/02-developers/07-rpc-api/_category_.yml new file mode 100644 index 00000000..b4fcbe01 --- /dev/null +++ b/docs/02-developers/07-rpc-api/_category_.yml @@ -0,0 +1,7 @@ + +label: RPC API Services available on Rootstock +position: 5 +link: + type: generated-index + slug: /developers/rpc-api/ + description: "RPC API services for interacting with Rootstock network." \ No newline at end of file diff --git a/docs/02-developers/07-rpc-api/index.md b/docs/02-developers/07-rpc-api/index.md deleted file mode 100644 index 34e6e78e..00000000 --- a/docs/02-developers/07-rpc-api/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -sidebar_label: RPC API -sidebar_position: 5 -title: Interact with Rootstock via JSON-RPC -tags: [faucet, Rootstock, testnet, address, wallet, tools, alchemy, rpc, api] -description: "RPC API services for interacting with Rootstock network" ---- - -Get started interacting with Rootstock with using JSON-RPC methods with different service providers. - -| Provider | Description | -| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [Rootstock RPC Service](/developers/rpc-api/rootstock/) | Interact with Rootstock using the Rootstock RPC Service. | -| [Alchemy RPC Service](/developers/rpc-api/alchemy/) | Interact with Rootstock using the Alchemy RPC Service. | \ No newline at end of file diff --git a/docs/02-developers/index.md b/docs/02-developers/index.md index 39703967..73050887 100644 --- a/docs/02-developers/index.md +++ b/docs/02-developers/index.md @@ -11,7 +11,7 @@ Welcome to the Rootstock Developers Overview section. This section enables developers getting started with the Rootstock blockchain. Developers can install a local development environment using Hardhat, etc, create and test contracts with the libraries provided and use the libraries to build decentralized applications :::info[Info] -* Looking to quickly test your dApp on testnet before deploying to mainnet? Use the [RPC API](https://rpc.rootstock.io/) or view the [json-rpc methods](/developers/rpc-api/methods/) available on the RPC API. +* Looking to quickly test your dApp on testnet before deploying to mainnet? Use the [Rootstock RPC API](https://rpc.rootstock.io/) or view the [json-rpc methods](/developers/rpc-api/rootstock/methods/) available on the RPC API. * Dive right in with [step-by-step guides](/developers/quickstart/) to get your development environment set up and deploy your first dApp. ::: @@ -24,7 +24,7 @@ This section enables developers getting started with the Rootstock blockchain. D | [Quick Starts](/developers/quickstart/) | Dive right in with step-by-step guides to get your development environment set up and deploy your first dApp.| | [Smart Contract Development](/developers/smart-contracts/) | Explore in-depth resources on building secure and scalable smart contracts on Rootstock.| | [Integration Guides](/developers/integrate/) | Deepen your knowledge with detailed guides and informative tutorials that cover various aspects of Rootstock development.| -| [JSON-RPC](/developers/rpc-api/setup/) | Test your dApps on testnet in minutes before deploying to mainnet using the RPC API.| +| [JSON-RPC](/developers/rpc-api/) | Test your dApps on testnet in minutes before deploying to mainnet using RPC API providers on Rootstock.| | [Libraries](/developers/libraries/) | Access essential tools and libraries to streamline your development process. | diff --git a/docs/03-node-operators/08-public-nodes/index.md b/docs/03-node-operators/08-public-nodes/index.md index a62458ea..4caaafbd 100644 --- a/docs/03-node-operators/08-public-nodes/index.md +++ b/docs/03-node-operators/08-public-nodes/index.md @@ -16,7 +16,7 @@ and in accordance with the bitcoiners' maxim: **Don't trust. Verify.** :::info[RPC Node Providers] The Rootstock public nodes do not expose WebSockets, they are `HTTP` only. -To work around this, you may either [run your own Rootstock node](/node-operators/setup/node-runner/), or use the [Rootstock RPC API](/developers/rpc-api/setup/) or use a third-party node provider, such as [Getblock](https://getblock.io/nodes/rsk/), [NowNodes](https://nownodes.io/nodes/rsk) or [dRPC](https://drpc.org/chainlist/rootstock?utm_source=docs&utm_medium=rootstock). +To work around this, you may either [run your own Rootstock node](/node-operators/setup/node-runner/), or use the [Rootstock RPC API](/developers/rpc-api/rootstock/setup/) or use a third-party node provider, such as [Getblock](https://getblock.io/nodes/rsk/), [NowNodes](https://nownodes.io/nodes/rsk) or [dRPC](https://drpc.org/chainlist/rootstock?utm_source=docs&utm_medium=rootstock). ::: ## Testnet diff --git a/docs/04-resources/04-tutorials/rootstock-metamask.md b/docs/04-resources/04-tutorials/rootstock-metamask.md index f54a7ca0..9e1a3dea 100644 --- a/docs/04-resources/04-tutorials/rootstock-metamask.md +++ b/docs/04-resources/04-tutorials/rootstock-metamask.md @@ -89,7 +89,7 @@ export const rskMainnet = { }; ``` -> See how to [Get an API Key from the RPC API](/developers/rpc-api/setup/) +> See how to [Get an API Key from the RPC API](/developers/rpc-api/rootstock/setup/) See full configuration on [GitHub](https://github.com/rsksmart/demo-code-snippets/blob/5cc5124fe5bddc85f09a82e49eba7591003543f0/switch-network-to-rsk/networks.js). diff --git a/docs/04-resources/04-tutorials/rootstock-rust.md b/docs/04-resources/04-tutorials/rootstock-rust.md index bea9c04c..e87cf7e4 100644 --- a/docs/04-resources/04-tutorials/rootstock-rust.md +++ b/docs/04-resources/04-tutorials/rootstock-rust.md @@ -85,7 +85,7 @@ Next, update the `rootstock-rs/src/main.rs` file with the program below: :::info[Info] -Replace `API_KEY` with your RPC API Key. To get an API_KEY, see the [RPC Docs](/developers/rpc-api/setup/). +Replace `API_KEY` with your RPC API Key. To get an API_KEY, see the [RPC Docs](/developers/rpc-api/rootstock/setup/). ::: @@ -190,7 +190,7 @@ async fn main() -> eyre::Result<()> { :::info[Info] -Replace `API_KEY` with your RPC API Key. To get an API_KEY, see the [RPC Docs](/developers/rpc-api/setup/). Also replace RIF Testnet contract addresses with your own address as you would be required to use a private key later. +Replace `API_KEY` with your RPC API Key. To get an API_KEY, see the [RPC Docs](/developers/rpc-api/rootstock/setup/). Also replace RIF Testnet contract addresses with your own address as you would be required to use a private key later. ::: diff --git a/src/components/Homepage/HomepageSectionProducts/index.js b/src/components/Homepage/HomepageSectionProducts/index.js index c61465ef..41894896 100644 --- a/src/components/Homepage/HomepageSectionProducts/index.js +++ b/src/components/Homepage/HomepageSectionProducts/index.js @@ -76,17 +76,17 @@ const data = { color: 'yellow', description: ( <> - Deploy and interact with EVM compatible smart contracts on Rootstock using JSON RPC methods. + Deploy and interact with EVM compatible smart contracts on Rootstock using JSON RPC methods using the Rootstock RPC API. ), list: [ { title: 'Make First API Call', - href: '/developers/rpc-api/setup/', + href: '/developers/rpc-api/rootstock/setup/', }, { title: 'View JSON RPC Methods', - href: '/developers/rpc-api/methods/', + href: '/developers/rpc-api/rootstock/methods/', } ], }, diff --git a/vercel.json b/vercel.json index 30f45fe9..15716a23 100644 --- a/vercel.json +++ b/vercel.json @@ -632,6 +632,8 @@ {"source" : "/guides/dex/dex-vs-cex", "destination" : "https://blog.rootstock.io/noticia/dex-vs-cex/"}, {"source" : "/guides/get-crypto-on-rsk/cryptocurrency-vs-token", "destination" : "https://blog.rootstock.io/noticia/cryptocurrency-vs-token/"}, {"source" : "/guides/stablecoin/stablecoin-vs-digital-assets", "destination" : "https://blog.rootstock.io/noticia/stablecoin-vs-digital-asset/"}, - {"source" : "/guides/dex/features-of-a-dex", "destination" : "https://blog.rootstock.io/noticia/features-of-a-dex/"} + {"source" : "/guides/dex/features-of-a-dex", "destination" : "https://blog.rootstock.io/noticia/features-of-a-dex/"}, + {"source" : "/developers/quickstart/alchemy/", "destination" : "/developers/rpc-api/alchemy/"}, + {"source" : "/developers/rpc-api/setup/", "destination" : "/developers/rpc-api/rootstock/setup/"} ] } \ No newline at end of file From ac37e0d6b1bd9e3b6e0c289fbcff07702cad9770 Mon Sep 17 00:00:00 2001 From: Owanate Amachree Date: Wed, 30 Oct 2024 14:02:07 +0200 Subject: [PATCH 5/5] minor fix --- docs/02-developers/07-rpc-api/_category_.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-developers/07-rpc-api/_category_.yml b/docs/02-developers/07-rpc-api/_category_.yml index b4fcbe01..f43799ed 100644 --- a/docs/02-developers/07-rpc-api/_category_.yml +++ b/docs/02-developers/07-rpc-api/_category_.yml @@ -1,5 +1,5 @@ -label: RPC API Services available on Rootstock +label: RPC API position: 5 link: type: generated-index