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 da7b5ec3..333ce30c 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 @@ -7,7 +7,7 @@ description: "Get started with the Rootstock RPC Service to interact with Rootst ---
- RPC Service Landing Page + RPC Service Landing Page
:::info[Info] @@ -19,7 +19,7 @@ The [Rootstock RPC API](https://rpc.rootstock.io/) is available on - RPC Service Sign Up + RPC Service Sign Up ## Get An API Key @@ -29,13 +29,13 @@ To get an API key: Log in to the dashboard, and click on _New API key_:
- Generate an API key + Generate an API key
Choose a name to identify your `apikey`, and the Network (either `Testnet` or `Mainnet`). You can also add a description (optional). Click on **Create**.
- Create API key + Create API key
## Make First API Call @@ -43,13 +43,13 @@ Choose a name to identify your `apikey`, and the Network (either `Testnet` or `M Click on the newly created `apikey` to get the details:
- Make First API Call + Make First API Call
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.
- Connect API + Connect API
### Example Request diff --git a/docs/03-node-operators/04-setup/02-installation/java.md b/docs/03-node-operators/04-setup/02-installation/java.md index 27819146..8c2f413f 100644 --- a/docs/03-node-operators/04-setup/02-installation/java.md +++ b/docs/03-node-operators/04-setup/02-installation/java.md @@ -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. ::: @@ -182,5 +182,5 @@ To change networks on the RSKj node, use the following commands: ``` :::tip[Tip] -Replace `` with the actual path to your jar file. For example: `C:/RskjCode/rskj-core-6.4.0-ARROWHEAD-all.jar`. +Replace `` with the actual path to your jar file. For example: `C:/RskjCode/rskj-core-6.5.0-ARROWHEAD-all.jar`. ::: \ No newline at end of file diff --git a/docs/03-node-operators/04-setup/04-node-runner/linux.md b/docs/03-node-operators/04-setup/04-node-runner/linux.md index 29dadbb8..51e8b274 100644 --- a/docs/03-node-operators/04-setup/04-node-runner/linux.md +++ b/docs/03-node-operators/04-setup/04-node-runner/linux.md @@ -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. ::: diff --git a/docs/03-node-operators/04-setup/reproducible-build.md b/docs/03-node-operators/04-setup/reproducible-build.md index 10b1fa14..fb42018f 100644 --- a/docs/03-node-operators/04-setup/reproducible-build.md +++ b/docs/03-node-operators/04-setup/reproducible-build.md @@ -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. ::: diff --git a/docs/03-node-operators/08-public-nodes/index.md b/docs/03-node-operators/08-public-nodes/index.md index a5adf71e..eed5f854 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/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 diff --git a/docs/04-resources/06-guides/powpeg-app/glossary.md b/docs/04-resources/06-guides/powpeg-app/glossary.md index a63d0a6b..5ca2a1ea 100644 --- a/docs/04-resources/06-guides/powpeg-app/glossary.md +++ b/docs/04-resources/06-guides/powpeg-app/glossary.md @@ -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. + + Flyover transactions + + - Click [here](/developers/integrate/flyover/) to know more about flyover transactions. + + + + What is the PowPeg App testnet + + - Click [here to open PowPeg](https://powpeg.testnet.rootstock.io/) on Testnet. + + + \ No newline at end of file diff --git a/docs/04-resources/06-guides/powpeg-app/overview.md b/docs/04-resources/06-guides/powpeg-app/overview.md index bdabca7c..174fa960 100644 --- a/docs/04-resources/06-guides/powpeg-app/overview.md +++ b/docs/04-resources/06-guides/powpeg-app/overview.md @@ -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? @@ -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/) \ No newline at end of file +* View [Advanced Operations](/resources/guides/powpeg-app/advanced-operations/) +* Comparing [PowPeg and Flyover](/developers/integrate/flyover/powpeg-vs-flyover/). \ No newline at end of file diff --git a/docs/04-resources/06-guides/powpeg-app/pegin/index.md b/docs/04-resources/06-guides/powpeg-app/pegin/index.md index 82e34290..db0257b7 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegin/index.md +++ b/docs/04-resources/06-guides/powpeg-app/pegin/index.md @@ -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/). diff --git a/docs/04-resources/06-guides/powpeg-app/pegin/leather.md b/docs/04-resources/06-guides/powpeg-app/pegin/leather.md index 6105c089..10c9607e 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegin/leather.md +++ b/docs/04-resources/06-guides/powpeg-app/pegin/leather.md @@ -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. @@ -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) +
+ +
### Using Correct Network on Leather @@ -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) +
+ +
-![leather-environment-2](/img/resources/powpeg/change-network2.png) +
+ +
### Verifying if the plugin is active @@ -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) +
+ +
-![leather-not-activated](/img/resources/powpeg/enable-leather2.png) +
+ +
**Step 1: Creatting a transaction** @@ -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. 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 1c1f66b8..8b21d123 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegin/ledger.md +++ b/docs/04-resources/06-guides/powpeg-app/pegin/ledger.md @@ -18,67 +18,59 @@ Ensure to complete the steps in [prerequisites](/resources/guides/powpeg-app/pre ### Ledger Hardware Wallet -![Choose Pegin Option](/img/resources/powpeg/pegin.png) - -![Connect Ledger](/img/resources/powpeg/connect-your-ledger.png) - -**Step 1: Connect to a ledger wallet** -- Plug your Ledger wallet by connecting the USB cable that comes with the Ledger. -- Enter your pin that has already been configured in [requirements](#requirements), to unlock the Ledger. - -**Step 2: Enter Pin** +A peg-in is the process of exchanging BTC for RBTC. See the [glossary](/resources/guides/powpeg-app/glossary/) section for more information. -![Enter Pin](/img/resources/powpeg/2-enter-pin.png) +:::tip[Tip] +The minimum values allowed when creating a peg-in transaction is **0.005 BTC**. +::: -**Step 3: Choose Wallet** +**Step 1: Select pegin option** -Here, we will use the Bitcoin Test wallet. For Mainnet, use the Bitcoin wallet. +![Choose Pegin Option](/img/resources/powpeg/pegin.png) -![Choose Wallet](/img/resources/powpeg/3-choose-wallet.png) +**Step 2: Select ledger wallet** -_Note: On the Nano S ledger, whenever you want to confirm an option, click on the 2 upper buttons at the same time._ +![PowPeg (supported-wallets-pegin)](/img/resources/powpeg/pegin-wallets.png) -**Step 4: Confirm connection to Bitcoin Testnet** +**Step 3: Read pop up information** -Once the above steps have been completed, a confirmation appears - “Bitcoin Testnet is ready”. +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. -![Confirm Connection Testnet](/img/resources/powpeg/4-confirm-connection-testnet.png) +> Note: Using fast mode, pegin time has been significantly reduced to ~20 mins. -Now, you have successfully connected your Ledger device to the Bitcoin network. +![Read popup info](/img/resources/powpeg/pegin-popup.png) -## Performing a peg-in transaction with Ledger +> Click the checkbox - “Don’t show again” to turn off this pop-up in the future or close temporarily. -A peg-in is the process of exchanging BTC for RBTC. See the [glossary](/resources/guides/powpeg-app/glossary/) section for more information. +**Step 4: Connect to a ledger wallet** -:::tip[Tip] -The minimum values allowed when creating a peg-in transaction is **0.005 BTC**. -::: +- Plug your Ledger wallet by connecting the USB cable that comes with the Ledger. +- Enter your pin that has already been configured in [requirements](#requirements), to unlock the Ledger. -Open [PowPeg](https://powpeg.testnet.rootstock.io/) on Testnet. +![Connect Ledger](/img/resources/powpeg/connect-your-ledger.png) -**Step 1: Select Conversion Type** +**Step 5: Enter Pin** -Since we are performing a peg-in, choose the BTC - RBTC conversion type, as shown in the image below; +![Enter Pin](/img/resources/powpeg/2-enter-pin.png) -![Select Conversion Type](/img/resources/powpeg/pegin.png) +**Step 6: Choose Wallet** -**Step 2: Choose Hardware Wallet** +Here, we will use the Bitcoin Test wallet. For Mainnet, use the Bitcoin wallet. -Here, we are using the ledger hardware wallet to interact with the PowPeg. Select your hardware wallet, ensure your device is already connected by inserting your pin into the Ledger device before clicking the Ledger option in the PowPeg. See the [connect to a ledger wallet](#ledger-hardware-wallet) section. +![Choose Wallet](/img/resources/powpeg/3-choose-wallet.png) -![Choose Hardware wallet](/img/resources/powpeg/choose-your-wallet.png) +_Note: On the Nano S ledger, whenever you want to confirm an option, click on the 2 upper buttons at the same time._ -**Step 3: Read pop up information** +**Step 7: Confirm connection to Network** -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. +Once the above steps have been completed, a confirmation appears - “Bitcoin Testnet is ready”. -> Note: Using fast mode, pegin time has been significantly reduced to ~20 mins. +![Confirm Connection Testnet](/img/resources/powpeg/4-confirm-connection-testnet.png) -![Read popup info](/img/resources/powpeg/pegin-popup.png) +Now, you have successfully connected your Ledger device to the Bitcoin network. -> Click the checkbox - “Don’t show again” to turn off this pop-up in the future or close temporarily. -**Step 4: Connect to the App** +**Step 8: Connect to the App** Click **Continue** to connect to the PowPeg App. @@ -95,8 +87,9 @@ To confirm successful connection to the PowPeg, you will be directed to the scre ![Peg-in screen](/img/resources/powpeg/pegin-screen.png) > - The balance of the accounts in your hardware wallet will be loaded, and this shows the balance of 3 different types of accounts: segwit, legacy, native segwit. See the [supported addresses](#supported-addresses) for the meaning of these types of accounts. +> - You can connect your destination wallet or paste your destination address. -**Step 5: Sending a transaction** +**Step 9: Sending a transaction** **Choose Account** @@ -122,20 +115,26 @@ After selecting the account you will like to send BTC from, the next step is to > - Note that the amount sent in BTC is the same amount to be received in RBTC on the Rootstock network. -**Step 6: Enter address** +**Step 10: Enter address** To enter an address, we are provided with two options: - (1) Your connected Rootstock address. See [Account based addresses](/concepts/account-based-addresses/) - (2) Connect to a software wallet. E.g, Metamask. Here, the address is automatically filled in by the account that is connected to your metamask wallet. -![Enter address](/img/resources/powpeg/ledger-pegin-destination-address.png) +Connect your wallet: -**Step 6a: Add a custom address** +![Connect your wallet](/img/resources/powpeg/ledger-pegin-destination-address.png) + + +**Step 11: Add a custom address** Also you can input a custom Rootstock address, different than the connected address. -**Step 7: Select Transaction Fee** +Paste destination address: +![Paste address](/img/resources/powpeg/ledger-pegin-paste-destination-address.png) + +**Step 12: Select Transaction Fee** Here, we can select the fee that will be used for this transaction, this is set on default to average. @@ -144,31 +143,30 @@ Here, we can select the fee that will be used for this transaction, this is set > - The transaction fee is not part of the amount you’re sending via the PowPeg, it will only be used for the correct processing of the transaction on the Bitcoin network. Also see the different types of fees (slow, average, fast) and their corresponding cost in TBTC and USD, depending on preference, you can choose any of those three. See the [adjusting network fees](/resources/guides/powpeg-app/advanced-operations#adjusting-network-fees) section for more information. > - The time for each type of fee per transaction may vary depending on the number of transactions on the network and the fees charged at the time. -**Step 8: View transaction summary** +**Step 13: Select Mode** -In this section, we can confirm the selected values: +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. -- Destination Address -- Estimated time -- BTC fee (Network fee) -- Provider fee (always zero for this option) -- Amount to send -- Value to receive +![Fast mode option](/img/resources/powpeg/fast-pegin-review-details.png) -![Review Transaction](/img/resources/powpeg/ledger-pegin-review-details.png) +- 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. + +![Native mode option](/img/resources/powpeg/native-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. -![Review Summary](/img/resources/powpeg/ledger-pegin-review-summary.png) - -**Step 9: Confirm and sign transaction** +**Step 14: Confirm and sign transaction** -By clicking on the **Confirm** button, we can see all the transactions that will be made, their corresponding inputs and outputs, and the network fees that will be charged, all this information must be confirmed on your hardware wallet screen. +By clicking on the **Send** button, we can see all the transactions that will be made, their corresponding inputs and outputs, and the network fees that will be charged, all this information must be confirmed on your hardware wallet screen. ![View transaction summary](/img/resources/powpeg/ledger-pegin-confirm-and-send-transaction.png) -**Step 10: Send transaction in Ledger Device** +**Step 15: Send transaction in Ledger Device** After click on the send button, you can confirm or reject the transaction in your hardware wallet. Unlock ledger device to confirm the transaction. @@ -212,7 +210,7 @@ The user needs to review and approve all outputs, the value of the transaction a > After signing, the transaction is sent to the network to be processed, taking into account the fee value selected previously. -**Step 11: View transaction status** +**Step 16: View transaction status** This shows the status of your transaction, with a transaction ID and a link to check the transaction on the explorer. 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 2dd23ff8..da533812 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegin/trezor.md +++ b/docs/04-resources/06-guides/powpeg-app/pegin/trezor.md @@ -10,7 +10,9 @@ In this guide, we will be performing a peg in transaction using the [PowPeg App] ## Access Pegin Page -![Connect Trezor](/img/resources/powpeg/pegin.png) +
+ +
## Verify if you have enabled **Perform Safety Checks** to **PROMPT** @@ -20,7 +22,7 @@ In this guide, we will be performing a peg in transaction using the [PowPeg App] ## Select Trezor Wallet -![Connect Trezor](/img/resources/powpeg/wallets.png) +![Connect Trezor](/img/resources/powpeg/pegin-wallets.png) ## Trezor Hardware Wallet @@ -42,30 +44,44 @@ Plug your Trezor wallet by connecting the USB cable that comes with Trezor. **Step 2: Export multiple addresses** In this step, the user is redirected to Trezor's site and needs to click on export to export the addresses. -![Export Testnet Addresses](/img/resources/powpeg/34-export-testnet-addresses.png) +
+ +
**Step 3: Enter Pin and confirm** Enter a pin for your Trezor, displayed on your hardware wallet. Click **confirm**. -![Insert Trezor Wallet Pin](/img/resources/powpeg/35-insert-trezor-wallet-pin.png) +
+ +
-![Insert Wallet Pin - Trezor](/img/resources/powpeg/35a-insert-wallet-pin-trezor.png) +
+ +
**Step 4: Unlock Trezor with passphrase** -![Enter passphrase](/img/resources/powpeg/36-enter-passphrase.png) +
+ +
Step 5: - Type Trezor passphrase - Trezor will display the message: 'Please enter your passphrase using the computer's keyboard'. -![Enter Passphrase using Keyboard](/img/resources/powpeg/36a-enter-passphrase-keyboard.png) +
+ +
The user fills the passphrase, and confirms passphrase fields, using the Trezor Connect application. The user will see this screen on Trezor: "Access Hidden Wallet?". -![Access hidden wallet notification](/img/resources/powpeg/37-access-hidden-wallet-notification.png) +
+ +
-![Use passphrase](/img/resources/powpeg/37a-use-passphrase.png) +
+ +
Now, you have successfully connected your Trezor to the Bitcoin network. @@ -83,10 +99,18 @@ The PowPeg shows the pop-up with the connected usb ledger devices, if your devic To confirm successful connection to the PowPeg, you will be directed to the screen below, where we will perform a Peg-in transaction. -![Peg-in screen](/img/resources/powpeg/pegin-transaction-page.png) +
+ +
> - The balance of the accounts in your hardware wallet will be loaded, and this shows the balance of 3 different types of accounts: segwit, legacy, native segwit. See the [supported addresses](#supported-addresses) for the meaning of these types of accounts. +**Choose Account** + +Select the account you would like to send BTC from, by clicking on the dropdown as shown in the image below. + +![Select Testnet Bitcoin Account](/img/resources/powpeg/select-btc-account.png) + **Step 5: Sending a transaction** **Choose Account** @@ -95,7 +119,13 @@ Select the account you would like to send BTC from, by clicking on the dropdown ![Select Testnet Bitcoin Account](/img/resources/powpeg/select-btc-account.png) -> Note that for each selected account type, we will see a corresponding balance. +:::info[Info] +For each selected account type, we will see a corresponding balance.ente +::: + +
+ +
**Enter Amount** @@ -126,6 +156,9 @@ To enter an address, we are provided with two options: **Step 6a: Add a custom address** Also you can input a custom Rootstock address, different than the connected address. + +Paste destination address: +![Paste address](/img/resources/powpeg/ledger-pegin-paste-destination-address.png) **Step 7: Select Transaction Fee** @@ -136,29 +169,28 @@ Here, we can select the fee that will be used for this transaction, this is set > - The transaction fee is not part of the amount you’re sending via the PowPeg, it will only be used for the correct processing of the transaction on the Bitcoin network. Also see the different types of fees (slow, average, fast) and their corresponding cost in TBTC and USD, depending on preference, you can choose any of those three. See the [adjusting network fees](/resources/guides/powpeg-app/advanced-operations#adjusting-network-fees) section for more information. > - The time for each type of fee per transaction may vary depending on the number of transactions on the network and the fees charged at the time. -**Step 8: View transaction summary** +**Step 8: Select Mode** -In this section, we can confirm the selected values: +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. -- Destination Address -- Estimated time -- BTC fee (Network fee) -- Provider fee (always zero for this option) -- Amount to send -- Value to receive +![Fast mode option](/img/resources/powpeg/fast-pegin-review-details.png) -![Review Transaction](/img/resources/powpeg/ledger-pegin-review-details.png) +- 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. -> - 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. +![Native mode option](/img/resources/powpeg/native-pegin-review-details.png) -![Review Summary](/img/resources/powpeg/ledger-pegin-review-summary.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. -**Step 9: Accept and send the transaction to be broadcasted to the network.** +**Step 9: Confirm and sign transaction** +By clicking on the **Send** button, we can see all the transactions that will be made, their corresponding inputs and outputs, and the network fees that will be charged, all this information must be confirmed on your hardware wallet screen. -> After signing, the transaction is sent to the network to be processed, taking into account the fee value selected previously. +![View transaction summary](/img/resources/powpeg/ledger-pegin-confirm-and-send-transaction.png) **Step 10: View transaction status** diff --git a/docs/04-resources/06-guides/powpeg-app/pegout/deriving-electrum.md b/docs/04-resources/06-guides/powpeg-app/pegout/deriving-electrum.md index ec33ab29..46f7bcf8 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegout/deriving-electrum.md +++ b/docs/04-resources/06-guides/powpeg-app/pegout/deriving-electrum.md @@ -48,11 +48,15 @@ We will learn how to view a derived address using [Metamask](#using-metamask) to **Step 5**: Fill out wallet password and click on “Confirm” -![metamask - fill_wallet_password](/img/resources/powpeg/metamask/fill_wallet_password.png) +
+ +
-**Step 6**: Copy the private key and click on “Done” +**Step 6**: Copy the private key and click on “Done”. -![metamask - copy_assets](/img/resources/powpeg/metamask/copy_assets.png) +
+ +
### Converting RBTC to BTC @@ -99,7 +103,9 @@ Follow the steps below to get started; Step 1: Visit the url: [https://learnmeabitcoin.com/technical/wif](https://learnmeabitcoin.com/technical/wif) -![metamask - WIF](/img/resources/powpeg/other/wif.png) +
+ +
> You will find the [Ruby](https://www.ruby-lang.org/en/) code and a tool to convert the private key into a WIF. @@ -133,8 +139,6 @@ puts wif ## Import key in Electrum ---- - [Electrum](https://electrum.org/#download) is used to verify a derived address, this address will then be used to receive and verify the converted funds (RBTC - BTC) when the pegout process is finished. Step 1: Download Electrum for your OS from the [website](https://electrum.org/#download). @@ -158,7 +162,10 @@ Step 5: Fill out the WIF value of the private key and click on “Next” button Step 6: Create a new wallet password and click on the “Next” button -![electrum - new](/img/resources/powpeg/other/electrum.png) + +
+ +
> In this screen, you will see the address to receive the BTC funds. @@ -183,43 +190,61 @@ Step 3: Fill out the name in “Wallet” field and click on “Next” button Step 4: Select “Standard wallet” option and click on “Next” button -![wallet - electrum](/img/resources/powpeg/using-hd-wallets/electrum-hdw-1.png) +
+ +
Step 4: Select “Use a hardware device” option and click on “Next” button -![wallet - electrum-hardware-device](/img/resources/powpeg/using-hd-wallets/electrum-hdw-2.png) +
+ +
Step 5: Select the hardware wallet and click on “Next” button > NOTE: The follow screen is an example of usage the Trezor Hardware Wallet -![wallet - electrum-hardware-device-trezor](/img/resources/powpeg/using-hd-wallets/electrum-hdw-3.png) +
+ +
> NOTE: The follow screen is an example of usage the Ledger Hardware Wallet -![wallet - electrum-hardware-device-ledger](/img/resources/powpeg/using-hd-wallets/electrum-hdw-4.png) +
+ +
Step 6: Select “legacy (p2pkh)” option, fill out a custom derivation path field and click on “Next” button -``` +```text Custom derivation path: Mainnet: m/44'/137'/0' ``` -![wallet - electrum-derivation-pathx](/img/resources/powpeg/using-hd-wallets/electrum-hdw-5.png) +
+ +
> NOTE: Testnet: m/44'/37310'/0' -![wallet - electrum-derivation-legacy](/img/resources/powpeg/using-hd-wallets/electrum-hdw-6.png) +
+ +
> IMPORTANT: For Ledger it is necessary to approve the custom derivation path in the device -![wallet - electrum-ledger-confirmation](/img/resources/powpeg/using-hd-wallets/electrum-hdw-7.png) +
+ +
Step 7: Check “Encrypt wallet file” option and click on “Next” button -![wallet - electrum-encrypt](/img/resources/powpeg/using-hd-wallets/electrum-hdw-8.png) +
+ +
Step 8: Finally in Electrum go to “Addresses” tab and you can see your funds -![wallet - electrum-show-funds](/img/resources/powpeg/using-hd-wallets/electrum-hdw-9.png) \ No newline at end of file +
+ +
\ No newline at end of file diff --git a/docs/04-resources/06-guides/powpeg-app/pegout/index.md b/docs/04-resources/06-guides/powpeg-app/pegout/index.md index 5b811a00..c07774b5 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegout/index.md +++ b/docs/04-resources/06-guides/powpeg-app/pegout/index.md @@ -16,7 +16,10 @@ To start using PowPeg App, you will need to connect your **RSK** wallet: ![PowPeg (connect-your-wallet)](/img/resources/powpeg/connectyourwallet.png) 2. Once connected your will see your address and your balance: -![PowPeg App (wallet-connected)](/img/resources/powpeg/walletconnected.png) + +
+ +
> To get started, see the [Requirements for Pegout](/resources/guides/powpeg-app/prerequisites/) section. diff --git a/docs/04-resources/06-guides/powpeg-app/pegout/ledger-liquality.md b/docs/04-resources/06-guides/powpeg-app/pegout/ledger-liquality.md index a7c1a7e5..f9194577 100644 --- a/docs/04-resources/06-guides/powpeg-app/pegout/ledger-liquality.md +++ b/docs/04-resources/06-guides/powpeg-app/pegout/ledger-liquality.md @@ -1,12 +1,11 @@ --- sidebar_position: 1300 -sidebar_label: Peg-out using Metamask and any hardware wallet -title: "Performing a peg-out using Metamask and hardware wallet" +sidebar_label: Peg-out using Ledger and any software wallet +title: "Performing a peg-out using ledger and software wallet" description: "Here, we will learn how to perform a peg-out using Metamask and hardware wallet." tags: [powpeg app, peg-in, peg-out, bridge, rsk, rootstock] --- - ![PowPeg App (peg-out)](/img/resources/powpeg/pegout.gif) ## Performing a peg-out transaction using Ledger and Liquality @@ -26,11 +25,16 @@ We will perform a peg-out transaction using the Ledger Hardware Wallet and Liqua To perform a peg-out transaction using the Ledger device with Metamask, follow the steps below: Step 1: Open Metamask click on select account, and then in the **Add account or hardware wallet** button: -![Add account or hardware wallet](/img/resources/powpeg/add-account-or-hdwallet.png) + +
+ +
Step 2: Select **Add hardware wallet** option: -![Add account or hardware wallet](/img/resources/powpeg/nn-add-account.png) +
+ +
Step 3: The user will be redirected to wallet selection page: @@ -46,7 +50,9 @@ To connect with a Ledger Wallet: Now you can see "Ledger" or "Trezpr" label in your Metamask accounts -![Final screen](/img/resources/powpeg/trezor-wallet-imported-metamask.png) +
+ +
---- diff --git a/docs/04-resources/06-guides/tokenbridge/faq.md b/docs/04-resources/06-guides/tokenbridge/faq.md index 9eca6087..33d6d468 100644 --- a/docs/04-resources/06-guides/tokenbridge/faq.md +++ b/docs/04-resources/06-guides/tokenbridge/faq.md @@ -64,14 +64,13 @@ Find a list of frequently asked questions about the Token Bridge. Is there a limit on how many tokens can be bridged over? - - There is no limit on the total. Hypothetically, the entire circulating supply can be bridged, though this is unlikely happen as there will be strong use cases to use the tokens on either network. - - However, there is a minimum and maximum amount per transaction and daily quotas. You can see them on [https://dapp.tokenbridge.rootstock.io/](https://dapp.tokenbridge.rootstock.io/) + - Visit the [token crossing limit page](/resources/guides/tokenbridge/troubleshooting/) to view the min/max values. Can any token be bridged over? - - Only whitelisted tokens can cross the bridge, this curated list is used to avoid malicious contracts and DDoS attacks. + - Only whitelisted tokens can cross the bridge, this curated list is used to avoid malicious contracts and DDoS attacks. See the [list of supported tokens](/resources/guides/tokenbridge/troubleshooting/) diff --git a/docs/05-dev-tools/index.md b/docs/05-dev-tools/index.md index 999cbb76..db11c00d 100644 --- a/docs/05-dev-tools/index.md +++ b/docs/05-dev-tools/index.md @@ -109,7 +109,7 @@ description: "Explore a curated selection of smart contract development tools an title="GetBlock" subtitle="json rpc" color="orange" - linkHref="https://getblock.io/nodes/rsk/" + linkHref="/dev-tools/node-rpc/getblock/" linkTitle="Make First API Call" description="GetBlock provides instant connection to blockchain nodes including Rootstock, Bitcoin (BTC), Ethereum (ETH), among others." /> @@ -118,7 +118,7 @@ description: "Explore a curated selection of smart contract development tools an title="NOWNodes" subtitle="json rpc" color="orange" - linkHref="https://nownodes.io/nodes/rsk" + linkHref="/dev-tools/node-rpc/nownodes/" linkTitle="Make First API Call" description="NOWNodes is a blockchain-as-a-service enterprise solution that lets users get access to full Nodes and blockbook Explorers via an API." /> @@ -127,7 +127,7 @@ description: "Explore a curated selection of smart contract development tools an title="dRPC" subtitle="json rpc" color="orange" - linkHref="https://drpc.org/chainlist/rootstock?utm_source=docs&utm_medium=rootstock" + linkHref="/dev-tools/node-rpc/drpc/" linkTitle="Make First API Call" description="dRPC provides access to a distributed network of node providers." /> @@ -136,7 +136,7 @@ description: "Explore a curated selection of smart contract development tools an title="Blast API" subtitle="json rpc" color="orange" - linkHref="https://blastapi.io/" + linkHref="/dev-tools/node-rpc/blast-api/" linkTitle="Make First API Call" description="Blast API is a Blockchain-optimized cloud infrastructure for low-latency, cost-effective RPC services." /> diff --git a/docs/05-dev-tools/node-rpc/blast-api.md b/docs/05-dev-tools/node-rpc/blast-api.md index 9c2a35e1..8ad207d8 100644 --- a/docs/05-dev-tools/node-rpc/blast-api.md +++ b/docs/05-dev-tools/node-rpc/blast-api.md @@ -12,7 +12,7 @@ Blast API is a Blockchain-optimized cloud infrastructure for low-latency, cost-e - - Create an account at [Blast API](https://blastapi.io/login). + - Create an account on [Blast API](https://blastapi.io/login). - Generate your API key from the dashboard. diff --git a/docs/05-dev-tools/node-rpc/dRPC.md b/docs/05-dev-tools/node-rpc/dRPC.md index 4f4fba3a..1c6e5871 100644 --- a/docs/05-dev-tools/node-rpc/dRPC.md +++ b/docs/05-dev-tools/node-rpc/dRPC.md @@ -32,7 +32,7 @@ dRPC supports various blockchain networks, including: - - Create an account at [dRPC.io](https://www.drpc.io). + - Create an account on [dRPC.io](https://www.drpc.io). - Generate your API key from the dashboard. diff --git a/static/img/resources/powpeg/account-selected-pegin-ledger.png b/static/img/resources/powpeg/account-selected-pegin-ledger.png index 1a9072d8..850f7550 100644 Binary files a/static/img/resources/powpeg/account-selected-pegin-ledger.png and b/static/img/resources/powpeg/account-selected-pegin-ledger.png differ diff --git a/static/img/resources/powpeg/choose-your-wallet.png b/static/img/resources/powpeg/choose-your-wallet.png deleted file mode 100644 index 091e7606..00000000 Binary files a/static/img/resources/powpeg/choose-your-wallet.png and /dev/null differ diff --git a/static/img/resources/powpeg/enter-amount.png b/static/img/resources/powpeg/enter-amount.png index 1a9072d8..f7b27d15 100644 Binary files a/static/img/resources/powpeg/enter-amount.png and b/static/img/resources/powpeg/enter-amount.png differ diff --git a/static/img/resources/powpeg/fast-pegin-review-details.png b/static/img/resources/powpeg/fast-pegin-review-details.png new file mode 100644 index 00000000..defa33e0 Binary files /dev/null and b/static/img/resources/powpeg/fast-pegin-review-details.png differ diff --git a/static/img/resources/powpeg/ledger-pegin-confirm-and-send-transaction.png b/static/img/resources/powpeg/ledger-pegin-confirm-and-send-transaction.png index 6c2106cc..a2a102f2 100644 Binary files a/static/img/resources/powpeg/ledger-pegin-confirm-and-send-transaction.png and b/static/img/resources/powpeg/ledger-pegin-confirm-and-send-transaction.png differ diff --git a/static/img/resources/powpeg/ledger-pegin-destination-address.png b/static/img/resources/powpeg/ledger-pegin-destination-address.png index 58f8f7e5..486bd541 100644 Binary files a/static/img/resources/powpeg/ledger-pegin-destination-address.png and b/static/img/resources/powpeg/ledger-pegin-destination-address.png differ diff --git a/static/img/resources/powpeg/ledger-pegin-paste-destination-address.png b/static/img/resources/powpeg/ledger-pegin-paste-destination-address.png new file mode 100644 index 00000000..b9fde125 Binary files /dev/null and b/static/img/resources/powpeg/ledger-pegin-paste-destination-address.png differ diff --git a/static/img/resources/powpeg/native-pegin-review-details.png b/static/img/resources/powpeg/native-pegin-review-details.png new file mode 100644 index 00000000..0130ab62 Binary files /dev/null and b/static/img/resources/powpeg/native-pegin-review-details.png differ diff --git a/static/img/resources/powpeg/pegin-screen.png b/static/img/resources/powpeg/pegin-screen.png index 85ff35e9..e6cc6af3 100644 Binary files a/static/img/resources/powpeg/pegin-screen.png and b/static/img/resources/powpeg/pegin-screen.png differ diff --git a/static/img/resources/powpeg/pegin-wallets.png b/static/img/resources/powpeg/pegin-wallets.png new file mode 100644 index 00000000..8e4b6035 Binary files /dev/null and b/static/img/resources/powpeg/pegin-wallets.png differ diff --git a/static/img/resources/powpeg/select-btc-account.png b/static/img/resources/powpeg/select-btc-account.png index 2408de47..1b5e8d37 100644 Binary files a/static/img/resources/powpeg/select-btc-account.png and b/static/img/resources/powpeg/select-btc-account.png differ diff --git a/static/img/resources/powpeg/wallets.png b/static/img/resources/powpeg/wallets.png deleted file mode 100644 index e85897ca..00000000 Binary files a/static/img/resources/powpeg/wallets.png and /dev/null differ