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.

Sign up for GitHub

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

Rif-relay automated update of documentation update-from-rif-relay-20241218-223448 #230

Closed
wants to merge 1 commit into from
+46 −3
Closed

Rif-relay automated update of documentation update-from-rif-relay-20241218-223448 #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions docs/02-developers/06-integrate/01-rif-relay/integrate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -295,4 +296,6 @@ To implement and use your own replenish strategy:
1. In the folder `src` from the RIF Relay Server project, open `ReplenishFunction.ts` with a text editor.
2. On the function `replenishStrategy` write your new replenish strategy.
3. Re build the project `npm run build`
4. Change the config JSON file to set `customReplenish` on true.
4. Change the config JSON file to set `customReplenish` on true.

t
42 changes: 41 additions & 1 deletion docs/02-developers/06-integrate/01-rif-relay/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -15,3 +20,38 @@ 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.

<!--START IMPORTANT NOTE: In this region here, the information is omited in the Devportal -->
## Index
The project information is divided into different sections, which you can explore through the following links:

- [RIF Relay Integration](./docs/integrate.md)
- [RIF Relay Installation Requirements](./docs/installation-requirements.md)
- [How to use the RIF Relay Sample dApp SDK](./docs/sample-dapp.md)
- [RIF Relay Deployment](./docs/deployment.md)
- [RIF Relay Develop](./docs/develop.md)
- [RIF Relay - Contracts](./docs/contracts.md)
- [RIF Relay Smart Wallets](./docs/smart-wallets.md)
- [RIF Relay Versions](./docs/versions.md)
- [RIF Relay - Gas Costs](./docs/gas-costs.md)
- [RIF Relay - Architecture](./docs/architecture.md)
<!-- IMPORTANT NOTE: In this region here, the information is omited in the Devportal END-->

## 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
Loading