search

5afe / safe-client-gateway

Gateway service for Safe apps that serves transaction data conforming with the UI of our mobile apps
MIT License
56 stars 87 forks source link
api-gateway ethereum gateway mainnet rinkeby rust

readme

Safe Client Gateway

Actions Status Coverage Status

⚠️ This project is no longer being maintained. A new version which supports the same API can be found on https://github.com/safe-global/safe-client-gateway-nest. For the teams running an instance of this service, we strongly advise using the new version as it will include new features and any security related updates.

Motivation

This project is a gateway between the Safe clients (Android/ iOS/ web) and the Safe backend services (transaction service and Ethereum nodes). It is providing a more UI-oriented mapping and multi-sourced data structures for ease of integration and rendering.

Documentation

Quickstart

This project requires rustup and redis

git clone https://github.com/safe-global/safe-client-gateway.git
cd safe-client-gateway
cp .env.sample .env
redis-server
cargo run
./add_rustfmt_git_hook.sh  # It installs a git precommit hook that will autoformat the code on every commit

After doing any change code must be formatted using Rustfmt

Configuration

Rocket specific configurations (including databases) can be configured via the Rocket.toml for local development (see https://rocket.rs/v0.4/guide/configuration/#rockettoml).

For configurations specific to this service the .env file can be used. See next section.

Environment

Place a .env file in the root of the project containing URL pointing to the environment in which you want the gateway to run.

The contents of the file should be the following (see .env.sample for an example)

Tests

In order to run the test suite of the project:

  1. Have an instance of Redis running (as some of them test the integration with Redis).
redis-server
  1. Make sure that the required environment variables are set (the following example assumes that Redis is runnning on the default port 6379):
export REDIS_URI=redis://localhost:6379
export REDIS_URI_MAINNET=redis://localhost:6379
  1. Run the tests
cargo test -- --test-threads 1

By default, cargo test will execute the tests in the test suite in parallel. Because some of the tests update some shared local state (eg.: environment variables) the tests should be executed on a single thread – thus --test-threads 1.