https://github.com/iotexproject/iotex-client-gateway
Gateway service for Safe apps that serves transaction data conforming with the UI of our mobile apps.
https://github.com/iotexproject/iotex-client-gateway
Last synced: about 2 months ago
JSON representation
Gateway service for Safe apps that serves transaction data conforming with the UI of our mobile apps.
- Host: GitHub
- URL: https://github.com/iotexproject/iotex-client-gateway
- Owner: iotexproject
- License: mit
- Created: 2023-02-03T09:45:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T02:07:31.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T00:46:44.444Z (over 1 year ago)
- Language: Rust
- Size: 1.64 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Safe Client Gateway
[](https://github.com/safe-global/safe-client-gateway/actions)
[](https://coveralls.io/github/safe-global/safe-client-gateway)
## Motivation
This project is a gateway between the Safe clients ([Android](https://github.com/safe-global/safe-android)/ [iOS](https://github.com/safe-global/safe-ios)/ [web](https://github.com/safe-global/web-core)) and the Safe backend services ([transaction service](https://github.com/safe-global/safe-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
- [Client Gateway Docs](https://safe.global/safe-client-gateway/)
- [Swagger](https://safe-client.safe.global/index.html)
- [Safe developer documentation](https://docs.gnosis-safe.io/)
## Quickstart
This project requires `rustup` and `redis`
```bash
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](https://github.com/rust-lang/rustfmt)
- `cargo +nightly fmt --all`
Auto formatting can also [be configured in the most common code editors](https://github.com/rust-lang/rustfmt#running-rustfmt-from-your-editor)
## 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).
```bash
redis-server
```
2. Make sure that the required environment variables are set (the following example assumes that Redis is runnning on the default port `6379`):
```bash
export REDIS_URI=redis://localhost:6379
export REDIS_URI_MAINNET=redis://localhost:6379
```
3. Run the tests
```bash
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`.