Merge branch 'main' into rsk-cli-changes

.github/workflows/codeql.yml

@@ -28,18 +28,18 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@f779452ac5af1c261dce0346a8f964149f49322b #v3.26.13
+        uses: github/codeql-action/init@b6a472f63d85b9c78a3ac5e89422239fc15e9b3c #v3.28.1
         with:
           languages: ${{ matrix.language }}
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@f779452ac5af1c261dce0346a8f964149f49322b #v3.26.13
+        uses: github/codeql-action/autobuild@b6a472f63d85b9c78a3ac5e89422239fc15e9b3c #v3.28.1
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@f779452ac5af1c261dce0346a8f964149f49322b #v3.26.13
+        uses: github/codeql-action/analyze@b6a472f63d85b9c78a3ac5e89422239fc15e9b3c #v3.28.1
         with:
           category: "/language:${{ matrix.language }}"

.github/workflows/dependency-review.yml

@@ -12,10 +12,10 @@ jobs:
       pull-requests: write
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@4081bf99e2866ebe428fc0477b69eb4fcda7220a # v4.4.0
+        uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0
         with:
           fail-on-severity: high
           comment-summary-in-pr: true

.github/workflows/scorecard.yml

@@ -19,7 +19,7 @@ jobs:
 
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 #v4.2.1
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
         with:
           persist-credentials: false
 
@@ -33,7 +33,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 #v4.4.3
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 #v4.6.0
         with:
           name: SARIF file
           path: results.sarif
@@ -42,6 +42,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@c36620d31ac7c881962c3d9dd939c40ec9434f2b # v3.26.12
+        uses: github/codeql-action/upload-sarif@b6a472f63d85b9c78a3ac5e89422239fc15e9b3c # v3.28.1
         with:
           sarif_file: results.sarif

docs/02-developers/04-quickstart/foundry.md

@@ -2,14 +2,15 @@
 sidebar_label: Foundry
 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.'
+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.
 tags: [rsk, rootstock, tutorials, developers, foundry, quick starts, dApps, smart contracts]
 ---
 
 :::info[Note]
 If you wish to suggest changes on this document, please open a PR on the [Foundry Starter Kit Repository](https://github.com/rsksmart/rootstock-foundry-starterkit.git)
 :::
 
+
 # Rootstock Foundry Starter Kit
 
 Whether you’re 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.

docs/02-developers/06-integrate/01-rif-relay/architecture.md

@@ -2,10 +2,11 @@
 sidebar_label: Architecture
 sidebar_position: 980
 title: RIF Relay - Architecture
+description: RIF Relay Architeture.
 tags: [rif, envelope, relay, integrate]
-description: RIF Relay Architeture
 ---
 
+
 The RIF Relay system is designed to achieve transaction sponsorship at a low cost. The cost of the relay service provided by the “sponsors” is agreed upon among the parties off-chain. The low cost of transactions on Rootstock (RSK) contributes to keeping overall service costs low as well.
 
 The RIF Relay system is made up of various components, some of which are essential and others which are auxiliary.

docs/02-developers/06-integrate/01-rif-relay/contracts.md

@@ -2,10 +2,11 @@
 sidebar_label: Contracts
 sidebar_position: 700
 title: RIF Relay - Contracts
+description: RIF Relay Contracts.
 tags: [rif, envelope, relay, integrate]
-description: RIF Relay Contracts
 ---
 
+
 ## Mainnet
 
 ### Version 1

docs/02-developers/06-integrate/01-rif-relay/deployment.md

@@ -2,10 +2,11 @@
 sidebar_label: RIF Relay Deployment
 sidebar_position: 500
 title: RIF Relay Deployment
+description: RIF Relay deployment process.
 tags: [rif, envelope, relay, integration guide]
-description: RIF Relay deployment process
 ---
 
+
 ## Set Up RIF Relay Contracts and Server
 
 ### Deploy Contracts

docs/02-developers/06-integrate/01-rif-relay/develop.md

@@ -2,10 +2,11 @@
 sidebar_label: Develop
 sidebar_position: 600
 title: RIF Relay Develop
+description: RIF Relay deployment process.
 tags: [rif, envelope, relay, user, guide]
-description: RIF Relay deployment process
 ---
 
+
 ## Initializing the project
 
 To use RIF Relay, follow these steps to build the project.

docs/02-developers/06-integrate/01-rif-relay/gas-costs.md

@@ -2,10 +2,11 @@
 sidebar_label: Gas Costs
 sidebar_position: 950
 title: RIF Relay - Gas Costs
+description: RIF Relay Gas Costs.
 tags: [rif, envelope, relay, integrate]
-description: RIF Relay Gas Costs
 ---
 
+
 The overhead gas cost is the extra amount of gas required to process the relay call requested by the user. Let's call **X** the gas consumed by the destination contract method call, and **Y** the total gas consumed by the relay call, then the relay call cost (i.e. overhead gas cost) is: **Z = Y - X**.
 
 ## SmartWallet templates

docs/02-developers/06-integrate/01-rif-relay/installation-requirements.md

@@ -2,10 +2,11 @@
 sidebar_label: Setup
 sidebar_position: 300
 title: RIF Relay Installation Requirements
+description: Requirements for installing RIF Relay.
 tags: [rif, envelope, relay, user, guide]
-description: Requirements for installing RIF Relay
 ---
 
+
 To set up the RIF Relay system running locally there are some tools that are required. All of these tools are open source and have their own support page. The functionality of RIF Relay does not depend on these technologies and could be updated or replaced, if necessary.
 
 ## Hardware Requirements

docs/02-developers/06-integrate/01-rif-relay/integrate.md

@@ -2,10 +2,11 @@
 sidebar_label: Integrations
 sidebar_position: 200
 title: RIF Relay Integration
+description: Integrating RIF Relay in a dApp.
 tags: [rif, envelope, relay, integration guide]
-description: Integrating RIF Relay in a dApp
 ---
 
+
 This guide goes over the exposed RIF Relay methods that dApps and wallets can consume to provide relaying as a service, with the purpose of allowing users to pay transaction fees with tokens in a particular system.
 
 ## Introduction

docs/02-developers/06-integrate/01-rif-relay/overview.md

@@ -2,10 +2,15 @@
 sidebar_label: Overview
 sidebar_position: 100
 title: RIF Relay - Overview
+description: RIF Relay Overview.
 tags: [rif, envelope, relay, integrate, integration guide]
-description: RIF Relay Overview
 ---
 
+:::info[Note]
+If you wish to suggest changes on this document, please open a PR on the [Rif Relay Repository](https://github.com/rsksmart/rif-relay.git)
+:::
+
+# RIF Relay
 Most blockchains have native cryptocurrency to pay for transaction fees and gas consumption; this simple design has many benefits. First, to bootstrap an economy, the native cryptocurrency model creates an initial demand for it. Second, it simplifies the interaction between users and miners because it forces them to use the same means of payment. Third, it reduces the complexity of the consensus rules. Finally, it provides Denial of Service (DoS) protection to the network as full nodes can pay what the miners expect to include a received transaction. This way nodes can decide to propagate a transaction or not, preventing the free consumption of network bandwidth, and stop spam transactions.
 
 Cryptocurrencies tend to be associated with volatility and to counter measure this fact, Stablecoins were introduced. Stablecoins bridge the worlds of cryptocurrency and everyday fiat currency because their prices are pegged to a reserve asset like the U.S. dollar or gold.
@@ -15,3 +20,23 @@ But with the advent of Decentralized Finance (DeFi), several stable coins have b
 With this in mind, the main goal of the RIF Relay Project is to **provide the Rootstock (RSK) ecosystem with the means to allow blockchain applications and end-users (wallet-apps) to transact without needing RBTC**. The system should allow Rootstock (RSK) users to pay transaction fees with methods of payment (i.e., tokens) other than RBTC while maintaining their accounts as transaction senders.
 
 RIF Relay takes its inspiration from the [Gas Station Network (GSN) project](https://github.com/opengsn/gsn). GSN is a decentralized system that improves dApp usability without sacrificing security. In a nutshell, GSN abstracts away gas (used to pay transaction fees) to minimize onboarding and UX friction for dApps. With GSN, "gasless clients" can interact with smart contracts paying for gas with tokens instead of native-currency.
+
+
+## Modules
+
+RIF Relay is built in modules, the entire system is made up by 3 modules.
+
+1. [RIF Relay Contracts](https://github.com/rsksmart/rif-relay-contracts) contains all the contracts used by the RIF Relay System.
+2. [RIF Relay Client](https://github.com/rsksmart/rif-relay-client) contains a library to interact with the relay server.
+3. [RIF Relay Server](https://github.com/rsksmart/rif-relay-server) has all the relay server code. You can run the server directly from there.
+
+Each module has instructions for development and usage.
+
+[Deprecated Docs](docs/README.md)
+
+
+## Contribution Guidelines
+* Please refer to the Rootstock Contribution Guidelines for more information on how to contribute to this project.
+
+## License:
+MIT License - Copyright (c) 2023 Rootstock

docs/02-developers/06-integrate/01-rif-relay/sample-dapp.md

@@ -2,10 +2,11 @@
 sidebar_label: RIF Relay Sample dApp
 sidebar_position: 400
 title: How to use the RIF Relay Sample dApp SDK
+description: RIF Relay Sample dApp SDK Starter kit.
 tags: [rif, envelope, relay, integration guide]
-description: RIF Relay Sample dApp SDK Starter kit
 ---
 
+
 ## Getting Started
 
 This guide helps to quickly get started with setting up your environment to use RIF Relay and also use the sample dApp to test relay services.

docs/02-developers/06-integrate/01-rif-relay/smart-wallets.md

@@ -1,11 +1,12 @@
 ---
 sidebar_label: Smart Wallets
-sidebar_position: 700
+sidebar_position: 800
 title: RIF Relay Smart Wallets
+description: RIF Relay Smart Wallets.
 tags: [rif, envelope, relay, user, guide]
-description: RIF Relay Smart Wallet
 ---
 
+
 This guide is intended to explain more about the interaction and deployment of the Smart Wallets. We will be using additional testing contracts that were included in the project, like the `UtilToken(ERC20)`. All the utils scripts are executed from the account[0] from the regtest network. 
 
 ## Prerequisites

docs/02-developers/06-integrate/01-rif-relay/versions.md

@@ -2,8 +2,8 @@
 sidebar_label: Versions
 sidebar_position: 900
 title: RIF Relay Versions
+description: RIF Relay Versions.
 tags: [rif, envelope, rif relay, integration guide]
-description: "RIF Relay Versions"
 ---