Skip to content

Commit

Permalink
Merge pull request #133 from rsksmart/docs/october-maintenenace-fixes-01
Browse files Browse the repository at this point in the history
Docs: Monthly maintenance for October
  • Loading branch information
owans authored Oct 30, 2024
2 parents 881662c + ac37e0d commit f48a4d2
Show file tree
Hide file tree
Showing 30 changed files with 193 additions and 256 deletions.
1 change: 1 addition & 0 deletions docs/01-concepts/powpeg/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/02-requirements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
127 changes: 0 additions & 127 deletions docs/02-developers/04-quickstart/alchemy.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/02-developers/04-quickstart/ape.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/foundry.md
Original file line number Diff line number Diff line change
@@ -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.'
Expand Down
4 changes: 2 additions & 2 deletions docs/02-developers/04-quickstart/hardhat.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
19 changes: 19 additions & 0 deletions docs/02-developers/04-quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'}
]}>
Expand Down Expand Up @@ -117,4 +118,22 @@ values={[
linkTitle="Use Ape"
description="Learn how to compile, deploy, and intereact with smart contracts with Ape on Rootstock"
/>
<FilterItem
value="beginner, rpc"
title="Get Started with Rootstock RPC API"
subtitle="RPC API"
color="orange"
linkHref="/developers/rpc-api/rootstock/setup/"
linkTitle="Use the RPC API"
description="The Rootstock RPC Service provides a seamless and intuitive web interface for developers to interact with Rootstock nodes via JSON-RPC methods."
/>
<FilterItem
value="beginner, rpc"
title="Get Started with Alchemy"
subtitle="RPC API"
color="orange"
linkHref="/developers/rpc-api/alchemy/"
linkTitle="Use the RPC API"
description="A step-to-step guide for developers to interact with Rootstock network with the Alchemy RPC Provider Service."
/>
</Filter>
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/remix.md
Original file line number Diff line number Diff line change
@@ -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.'
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/rootstock-etherspot.md
Original file line number Diff line number Diff line change
@@ -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.'
Expand Down
4 changes: 2 additions & 2 deletions docs/02-developers/04-quickstart/wagmi.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/web3-python.md
Original file line number Diff line number Diff line change
@@ -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.'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
60 changes: 39 additions & 21 deletions docs/02-developers/05-smart-contracts/02-hardhat/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
<Accordion>
<Accordion.Item eventKey="0">
<Accordion.Header as="h3">Error HH8: There's one or more errors in your config file</Accordion.Header>
<Accordion.Body>
```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.
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.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="1">
<Accordion.Header as="h3">Error: Nothing to Compile</Accordion.Header>
<Accordion.Body>
```shell
% npx hardhat compile
Nothing to compile
```
> - FIX 2: Delete artifacts folder and run the `npx hardhat compile` command to generate new artifacts.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="2">
<Accordion.Header as="h3">Error: "GET /MyToken.json" Error (404): "Not found"</Accordion.Header>
<Accordion.Body>
- 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.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="2">
<Accordion.Header as="h3">Error: HH601: Script scripts/deploy.js doesn't exist.</Accordion.Header>
<Accordion.Body>
- Ensure that you're running the `npx hardhat run --network hardhat scripts/deploy.js` command from the root directory.
</Accordion.Body>
</Accordion.Item>
</Accordion>
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

<Accordion>
<Accordion.Item eventKey="0">
<Accordion.Header as="h3">Error: Transaction dropped from the mempool or Error Transaction not completed</Accordion.Header>
<Accordion.Body>
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.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="1">
<Accordion.Header as="h3">Error Failed to get EIP-1559 fees</Accordion.Header>
<Accordion.Body>
- 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`.
</Accordion.Body>
</Accordion.Item>
</Accordion>
Loading

0 comments on commit f48a4d2

Please sign in to comment.