Skip to content

Latest commit

 

History

History
171 lines (119 loc) · 10.2 KB

README.md

File metadata and controls

171 lines (119 loc) · 10.2 KB

RSK Enveloping

System for users to pay for transactions in ERC-20 tokens.

CircleCI

Table of Contents

  1. Description
  2. Technical Overview
    2.1 Testnet Contracts
  3. Building project
    3.1 Testing
    3.2 Use Enveloping
    3.3 Create a Smart Wallet
    3.4 Run a Javascript Client
  4. Use MetaCoin
  5. Documentation
  6. Troubleshooting
    6.1 Running on macOS
    6.2 Common errors when testing
  7. Gas Station Network

1. Description

The main objective of the Enveloping System is to provide the RSK ecosystem with the means to enable blockchain applications and end-users (wallet-apps) to transact without RBTC. The system allows RSK users to pay transaction fees (gas) with tokens instead of RBTC, while maintaining their accounts as transaction senders. This is enabled by service providers who use their accounts to pay gas costs for transactions sent by "gas-less" users.

2. Technical Overview

The system is designed to achieve deployments at low cost. The cost of the relay provided by "sponsors" is agreed among the parties off-chain. The low cost of transactions on RSK contributes to keeping overall service costs low as well.

The core enveloping architecture is defined by the following components:

  • Relay Request - a structure that wraps the transaction sent by an end-user including the required data for the relay (e.g. address of the payer, address of the original requester, token payment data).
  • Relay Hub - a core contract on the blockchain which serves as the interface for the on-chain system. It manages the balances of the accounts involved and forwards Relay Requests to the rest of the contracts.
  • Paymaster - an abstract contract that authorizes a specific relay request.
  • Smart Wallet - a contract that verifies forwarded data and invokes the receipient contract of the transaction. The smart wallet is created counterfactually at the moment it is needed. This happens, for instance, when a user with some token balances wants to move those tokens without spending gas, i.e. using the enveloping system.
  • Relay Server - a relay service daemon, running as a HTTP service. Advertises itself (through the RelayHub) and waits for client requests.
  • Relay Client - a typescript library for a client to access the blockchain through a relay. Provides APIs to find a good relay, and to send transactions through it. The library hooks the local web3, so that any loade. Id contract API will go through the relay.

2.1 Testnet Contracts

Contract Address
StakeManager 0x4aD91a4315b3C060F60B69Fd0d1eBaf16c14148D
Penalizer 0xd3021763366708d5FD07bD3A7Cd04F94Fc5e1726
RelayHub 0x3f8e67A0aCc07ff2F4f46dcF173C652765a9CA6C
TestRecipient 0xFBE5bF13F7533F00dF301e752b41c96965c10Bfa
SmartWallet 0xE7552f1FF31670aa36b08c17e3F1F582Af6302d1
ProxyFactory 0xb7a5370F126d51138d60e20E3F332c81f1507Ce2
DeployPaymaster 0x3AD4EDEc75570c3B03620f84d37EF7F9021665bC
RelayPaymaster 0x053b4a77e9d5895920cBF505eB8108F99d929395

3. Building project

Clone the project. Then run the following from the project's root directory

  • yarn install (for instruction to install yarn here)
  • Move here

3.1. Test

Once the project is built, we can test it with truffle

  • yarn generate && npx truffle test --network rsk test/Flows.test.ts (with truffle)

3.2. Deploy

We can deploy the project with

  • npx truffle --network rsk migrate
  • yarn run dev

3.3 Create a Smart Wallet

As mentioned before, the moment we need to use the Enveloping system, we have to deploy a Smart Wallet (SW). For that, the Relay Provider exposes auxiliar function to create a Smart Wallet.

deploySmartWallet - This function receives a GsnTransactionDetail and returns a transaction hash. The latter is formmed by the next parameters:

  • from: Address of the SW Owner.
  • to: Address of the optional custom logic.
  • data: Parameters (in bytes) for the optional custom logic.
  • tokenRecipient: Address of the account that gets paid for the deploy.
  • tokenContract: Address of the token used to pay for the deployment (address(0) indicated the deploy is subsidized).
  • tokenAmount: Amount of tokens paid for the deployment (0 if the deploy is subsidized).
  • factory: Address of the factory used to deploy the SW.
  • recoverer: Address of an optional recoverer account/contract (address(0) if there is not).
  • index: Numeric value used to generate several SW instances using the same paramaters defined above.
  • value: Not used here, only used in other scenarios where the worker account of the relay server needs to replenish balance. ** Any value put here wont be sent to the "to" property, it won't be moved at all.

calculateSmartWalletAddress - Given the next parameters, a user may know its SW address.

  • ownerEOA: Address of the SW owner.
  • recoverer: If there is, address of the recoverer account, otherwise address(0).
  • customLogic: An optional custom logic code (in bytes), that the wallet will proxy to (it can be address(0)).
  • walletIndex: Numeric value used to generatte different wallet insttances for the owner using the same parameters and factory.
  • logicInitParamsHash: If customLogic was defined in it need initialization parameters, they are passed as abi-encoded here, without include the function selector. If there are no initParams, logicInitParamsHash must not be passed, or, since (hash of empty byte array = null) must be passed as null or as zero.

3.4 Run a Javascript Client

In order to run an Enveloping instance, clone the project then run the following from the project's root directory:

  1. yarn install
  2. On the jsrelay directory npx webpack
  3. npm link
  4. On the project's root directory, run docker-compose build
  5. Run docker-compose up -d rskj
  6. On a new terminal run npx gsn start --network http://localhost:4444/. Keeping the Relay Hub address.
  7. Create an account from an mnemonic, and store the mnemonic in a file, then found it.
  8. In the jsrelay directory in the file gsn-relay-register add the Relay Hub address.
  9. On the project's root directory, run docker-compose up -d jsrelay
  10. Finally, run gsn relayer-register -n http://localhost:4444 -m <PATH.TO.MNEM> -f <0xADDRESS CREATED IN STEP 4>

For checking if it's working, run curl http://localhost:8090/getaddr

4. Use MetaCoin

Mint and send tokens without requiring RBTC for gas. Works on Regtest.

Try it: https://github.com/rsksmart/enveloping-metacoin

5. Documentation

For more detailed documentation, go here

6. Troubleshooting

6.1 Running on macOS

To run the project using Docker on a Mac, you must follow these steps or the scripts and web apps won't work.

  • Patch readlink The startup scripts assume that GNU's readlink command is available. But MacOS ships with BSD's readlink, which is incompatible with GNU's version. So you must patch readlink. This can be done as follows:
brew install coreutils
ln -s /usr/local/bin/greadlink /usr/local/bin/readlink

After this step, you must make sure that your PATH variable gives priority to /usr/local/bin over /usr/bin. You can do it with which readlink, which should output /usr/local/bin/readlink. Alternatively try executing readlink -f ., if it works you're ok.

6.2 Common errors when testing

Running a test throws the Error: Cannot find module 'directory-to-the-project/enveloping/rsknode/test/Flows.test.ts'

Ensure that you are in the project's root directory and that the test's name has no typos

Running Flows.test.ts test throws the error: http://localhost:8090 => Error: local view call to 'relayCall()' reverted: view call to 'relayCall'..

Stop the running node and delete the db used by the node.

Running some test and one of them throws: Error: listen EADDRINUSE: address already in use :::8090

The relay server running in the background. Run the bash file scripts/kill-relay-server.sh

7. Gas Station Network

This project is based on GSN and expands its capabilities and security model while reducing gas costs. It does this by:

  • Securely deploying counterfactual SmartWallet proxies for each user account: this eliminates the need for relying on _msgSender() and _msgData() functions.
  • Elimination of interaction with Uniswap: relay providers accumulate tokens on a paymaster under their control to later on decide what to do with funds.

Code here is based on Gas Stations Network (GSN). In a nutshell, GSN abstracts away gas to minimize onboarding & UX friction for dapps. With GSN, gasless clients can interact with Ethereum contracts without users needing ETH for transaction fees. The GSN is a decentralized system that improves dapp usability without sacrificing security.