Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
franciscotobar committed Jan 5, 2024
1 parent 56527db commit 8f65f6a
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Rif Relay
# RIF Relay

A secure transaction relay system to enable users to pay fees using ERC-20 tokens.

[![CircleCI](https://circleci.com/gh/rsksmart/rif-relay/tree/master.svg?style=shield)](https://circleci.com/gh/rsksmart/rif-relay/tree/master)

## Description

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.
Expand All @@ -16,15 +14,15 @@ It is important to recall that - as a security measure - the version 1 contracts

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.
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.

## Testing

This repository contains all the integration tests. These tests verify the behaviour of the entire system.
This repository contains all the integration tests. These tests verify the behavior of the entire system.
You have two ways to run tests:

1. Executing `npm test` will run all the test suite and verify all the system. This could take
Expand All @@ -34,7 +32,7 @@ that contains the test code inside will execute only that test and make the veri

**Important Note**: when you run the tests you will see folders like `contracts`, `migrations` and some other files
appearing during the tests and disappearing after, that’s because we need to have the contracts
on the same context as this repository during tests, this is a normal behaviour.
on the same context as this repository during tests, this is a normal behavior.

## Scripts

Expand Down

0 comments on commit 8f65f6a

Please sign in to comment.