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

Updating documentation according to version 2.3 #202

Merged
merged 9 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions docs/02-developers/07-rpc-api/02-rootstock/01-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Get started with the Rootstock RPC Service to interact with Rootst
---

<div align="center">
<img width="50%" src="/img/tools/rpc-api/01-rpc-api-landing.png" alt="RPC Service Landing Page"/>
<img width="100%" src="/img/tools/rpc-api/01-rpc-api-landing.png" alt="RPC Service Landing Page"/>
</div>

:::info[Info]
Expand All @@ -19,7 +19,7 @@ The [Rootstock RPC API](https://rpc.rootstock.io/) is available on <Shield labe
Visit the [Rootstock RPC API](https://rpc.rootstock.io/) to create a **free** account, and click on _Sign up_

<div align="center">
<img width="50%" src="/img/tools/rpc-api/02-sign-up.png" alt="RPC Service Sign Up"/>
<img width="100%" src="/img/tools/rpc-api/02-sign-up.png" alt="RPC Service Sign Up"/>
</div>

## Get An API Key
Expand All @@ -29,27 +29,27 @@ To get an API key:
Log in to the dashboard, and click on _New API key_:

<div align="center">
<img width="50%" src="/img/tools/rpc-api/03-generate-new-api-key.png" alt="Generate an API key"/>
<img width="100%" src="/img/tools/rpc-api/03-generate-new-api-key.png" alt="Generate an API key"/>
</div>

Choose a name to identify your `apikey`, and the Network (either `Testnet` or `Mainnet`). You can also add a description (optional). Click on **Create**.

<div align="center">
<img width="50%" src="/img/tools/rpc-api/04-create-api-key.png" alt="Create API key"/>
<img width="100%" src="/img/tools/rpc-api/04-create-api-key.png" alt="Create API key"/>
</div>

## Make First API Call

Click on the newly created `apikey` to get the details:

<div align="center">
<img width="50%" src="/img/tools/rpc-api/05-make-first-api-call.png" alt="Make First API Call"></img>
<img width="100%" src="/img/tools/rpc-api/05-make-first-api-call.png" alt="Make First API Call"></img>
</div>

You can make your first api call by using one of the provided examples, or simply by adding a url and `apikey` to your application.

<div align="center">
<img width="50%" src="/img/tools/rpc-api/06-connect-api.png" alt="Connect API"/>
<img width="100%" src="/img/tools/rpc-api/06-connect-api.png" alt="Connect API"/>
</div>

### Example Request
Expand Down
4 changes: 2 additions & 2 deletions docs/03-node-operators/04-setup/02-installation/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To setup a Rootstock node using Java, you need to:

:::warning[Important]

Starting with [v6.4.0](/changelog/2024-11-05-introducing-arrowhead-6.4.0/), the minimum supported Java LTS version is Java 17. Previous Java versions will no longer be supported.
Starting with [v6.4.0](/changelog/), the minimum supported Java LTS version is Java 17. Previous Java versions will no longer be supported.

:::

Expand Down Expand Up @@ -182,5 +182,5 @@ To change networks on the RSKj node, use the following commands:
```

:::tip[Tip]
Replace `<PATH-TO-THE-RSKJ-FATJAR>` with the actual path to your jar file. For example: `C:/RskjCode/rskj-core-6.4.0-ARROWHEAD-all.jar`.
Replace `<PATH-TO-THE-RSKJ-FATJAR>` with the actual path to your jar file. For example: `C:/RskjCode/rskj-core-6.5.0-ARROWHEAD-all.jar`.
:::
2 changes: 1 addition & 1 deletion docs/03-node-operators/04-setup/04-node-runner/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Recommended IDEs:

:::warning[Important]

Starting with [v6.4.0](/changelog/2024-11-05-introducing-arrowhead-6.4.0/), the minimum supported Java LTS version is Java 17. Previous Java versions will no longer be supported.
Starting with [v6.4.0](/changelog/), the minimum supported Java LTS version is Java 17. Previous Java versions will no longer be supported.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/03-node-operators/04-setup/reproducible-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It's highly recommended to follow the steps by yourself to avoid contamination o

:::warning[Important]

Starting with [v6.4.0](/changelog/2024-11-05-introducing-arrowhead-6.4.0.md), the minimum supported Java LTS version is Java 17. Previous Java versions will no longer be supported. The following example for Linux OS is showing instructions for v6.3.1, and thus uses jdk 8, this must be replaced by jdk 17 for v6.4.0 and up.
Starting with [v6.4.0](/changelog/), the minimum supported Java LTS version is Java 17. Previous Java versions will no longer be supported. The following example for Linux OS is showing instructions for v6.3.1, and thus uses jdk 8, this must be replaced by jdk 17 for v6.4.0 and up.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/03-node-operators/08-public-nodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/rootstock/setup/) or use a third-party node provider, such as [Getblock](https://getblock.io/nodes/rsk/), [NowNodes](https://nownodes.io/nodes/rsk), [dRPC](https://drpc.org/chainlist/rootstock?utm_source=docs&utm_medium=rootstock) or [Blast API](https://blastapi.io/).
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), [dRPC](https://drpc.org/chainlist/rootstock?utm_source=docs&utm_medium=rootstock) or [Blast API](/dev-tools/node-rpc/blast-api/).
:::

## Testnet
Expand Down
13 changes: 13 additions & 0 deletions docs/04-resources/06-guides/powpeg-app/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,17 @@ See a list of terms about/related to the PowPeg App and their meanings.
- This comprises of the BTC amount + transaction fee selected.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="18">
<Accordion.Header as="h3">Flyover transactions</Accordion.Header>
<Accordion.Body>
- Click [here](/developers/integrate/flyover/) to know more about flyover transactions.
</Accordion.Body>
</Accordion.Item>
<Accordion.Item eventKey="19">
<Accordion.Header as="h3">What is the PowPeg App testnet</Accordion.Header>
<Accordion.Body>
- Click [here to open PowPeg](https://powpeg.testnet.rootstock.io/) on Testnet.
</Accordion.Body>
</Accordion.Item>

</Accordion>
11 changes: 8 additions & 3 deletions docs/04-resources/06-guides/powpeg-app/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,16 @@ The source code is available on github, and open source:

The PowPeg App, has two primary features, they are:

- Peg-in: A conversion from BTC to RBTC. See [Glossary](/resources/guides/powpeg-app/glossary/) page for more explanation.
- Peg-in: A conversion from BTC to RBTC. See [pegin](/resources/guides/powpeg-app/pegin/) for more explanation.
- **Note: The peg-in process is final and cannot be reverted**.
- **Native pegin transaction has 17 hours estimated time to completion**.
- **Flyover pegin transaction time to completion, deppends on the Liquidity Provider conditions**.
- See [Glossary](/resources/guides/powpeg-app/glossary/) page for more explanation.

- Peg-out: A conversion from RBTC to BTC. This current version of the PowPeg. See [pegout](/resources/guides/powpeg-app/pegout/) for more explanation.
- **Native pegin transaction has 34 hours estimated time to completion**.
- **Native pegout transaction has 34 hours estimated time to completion**.
- **Flyover pegout transaction time to completion, deppends on the Liquidity Provider conditions**.
- See [Glossary](/resources/guides/powpeg-app/glossary/) page for more explanation.

## Why use the PowPeg App?

Expand Down Expand Up @@ -80,4 +84,5 @@ All transactions need to be confirmed via the device used by the customer, wheth

* Convert [BTC to RBTC using the PowPeg App](/resources/guides/powpeg-app/pegin/).
* Convert [RBTC to BTC using the PowPeg App](/resources/guides/powpeg-app/pegout/).
* View [Advanced Operations](/resources/guides/powpeg-app/advanced-operations/)
* View [Advanced Operations](/resources/guides/powpeg-app/advanced-operations/)
* Comparing [PowPeg and Flyover](/developers/integrate/flyover/powpeg-vs-flyover/).
17 changes: 12 additions & 5 deletions docs/04-resources/06-guides/powpeg-app/pegin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,24 @@ In this section, we will learn how to perform a [peg-in](/resources/guides/powpe

To start using PowPeg App, you will need to connect your **RSK** wallet:

1. Connect your wallet:
![PowPeg (connect-your-wallet)](/img/resources/powpeg/connectyourwallet.png)
1. Click on Pegin option:

2. Once connected your will see your address and your balance:
![PowPeg (wallet-connected)](/img/resources/powpeg/walletconnected.png)
![PowPeg (click-pegin-option)](/img/resources/powpeg/pegin.png)

2. Select your wallet:
- Trezor hardware wallet
- Ledger hardware wallet
- Leather software wallet (chrome plugin)
- Xverse software wallet (chrome plugin)
- Enkrypt software wallet (chrome plugin)

![PowPeg (supported-wallets-pegin)](/img/resources/powpeg/pegin-wallets.png)

To get started, see the [Requirements for Pegin](/resources/guides/powpeg-app/prerequisites/) section.

We will do the following:

1. [Set up environment](/resources/guides/powpeg-app/prerequisites/)
1. For developers: [Set up environment](/resources/guides/powpeg-app/prerequisites/)
2. Perform a peg-in (BTC - RBTC) transaction using [Ledger Hardware Wallet](/resources/guides/powpeg-app/pegin/ledger/)
3. Perform a peg-in (BTC - RBTC) transaction using [Trezor Hardware Wallet](/resources/guides/powpeg-app/pegin/ledger/)
4. [View a transaction status](/resources/guides/powpeg-app/pegin/status/).
Expand Down
42 changes: 26 additions & 16 deletions docs/04-resources/06-guides/powpeg-app/pegin/leather.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@ description: "Here, we will learn how to perform a peg-in transaction using the
tags: [powpeg app, peg-in, peg-out, bridge, rsk, rootstock]
---


## Using Leather Software wallet to perform a peg-in

In this guide, we will be using the [PowPeg App](https://powpeg.rootstock.io/) for unlocking Leather, access peg-in to use Leather, and verify if peg-in is active.

### Acessing pegin to use Leather

![leather-pegin](/img/resources/powpeg/choose-your-wallet.png)
![leather-pegin](/img/resources/powpeg/pegin-wallets.png)

After click on **Leather** button, you will see the pegin Leather page, then the PowPeg will connect with your Leather wallet.

Expand All @@ -25,7 +24,9 @@ Unlock Leather using the same password that you created in the installation.

![leather-error](/img/resources/powpeg/leather-unlock-2.png)

![leather-unlocking](/img/resources/powpeg/leather-unlock.png)
<center>
<img src="/img/resources/powpeg/leather-unlock.png" title="leather unlocking" width="50%"/>
</center>

### Using Correct Network on Leather

Expand All @@ -35,9 +36,13 @@ If you see the message below, it means that your Leather wallet is in the incorr

Select the correct environment on Leather:

![leather-environment](/img/resources/powpeg/change-network1.png)
<center>
<img src="/img/resources/powpeg/change-network1.png" title="leather environment" width="50%"/>
</center>

![leather-environment-2](/img/resources/powpeg/change-network2.png)
<center>
<img src="/img/resources/powpeg/change-network2.png" title="leather environment 2" width="50%"/>
</center>

### Verifying if the plugin is active

Expand All @@ -47,9 +52,13 @@ If you see the message below, it means that your Leather wallet is not enabled,

Go to chrome (manage extensions)[chrome://extensions/] and active your Leather wallet

![leather-not-activated](/img/resources/powpeg/enable-leather.png)
<center>
<img src="/img/resources/powpeg/enable-leather.png" title="leather not activated" width="50%"/>
</center>

![leather-not-activated](/img/resources/powpeg/enable-leather2.png)
<center>
<img src="/img/resources/powpeg/enable-leather2.png" title="leather not activated" width="50%"/>
</center>

**Step 1: Creatting a transaction**

Expand Down Expand Up @@ -82,18 +91,19 @@ Also you can input a custom Rootstock address, different than the connected addr

Here, we can select the fee that will be used for this transaction, this is set on default to average.

**Step 5: View transaction summary**
**Step 5: Select Mode**

In this section, we will see 2 options, Fast Mode and Native Mode:
- Fast Mode uses [Flyover Protocol](/developers/integrate/flyover/) to search for quotes, is faster than Native Mode, is provided by an Liquidity Provider, which in turn charges a fee for the service, called a provider fee.

![Fast mode option](/img/resources/powpeg/fast-pegin-review-details.png)

In this section, we can confirm the selected values:
- Native Mode uses [PowPeg Protocol](/concepts/powpeg/) that is decentralized, permissionless and uncensorable protocol created by Rootstock Labs, generally is slower than Fast mode and the user needs to pay only the network fees.

- Destination Address
- Estimated time
- BTC fee (Network fee)
- Provider fee (always zero for this option)
- Amount to send
- Value to receive
![Native mode option](/img/resources/powpeg/native-pegin-review-details.png)

![Review Transaction](/img/resources/powpeg/ledger-pegin-review-details.png)
- Value to receive: The estimated amount to receive when transaction finishes.
- Total Fee (Network & Provider): The total fee paid, network fee (BTC Fee) + provider fee (not applied).

> - In the instance of an error on this transaction, the amount will be sent to the address indicated in the **refund Bitcoin address** located in your hardware wallet.
> - See the [glossary](/resources/guides/powpeg-app/glossary/) section for the meaning of these values.
Expand Down
Loading
Loading