https://github.com/automata-network/1rpc-lite
A minimized 1RPC application which relays JSON-RPC requests.
https://github.com/automata-network/1rpc-lite
Last synced: 3 months ago
JSON representation
A minimized 1RPC application which relays JSON-RPC requests.
- Host: GitHub
- URL: https://github.com/automata-network/1rpc-lite
- Owner: automata-network
- License: apache-2.0
- Created: 2023-09-19T02:10:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-12T03:15:43.000Z (8 months ago)
- Last Synced: 2024-12-26T17:28:34.631Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 1RPC lite
[](LICENSE)
## About
This project is a minimized [1RPC](https://docs.1rpc.io) application which relays JSON-RPC requests.
In addition to normal relays, it sanitizes your JSON-RPC by masking out the metadata (like IP address, User-Agent) carried with HTTP requests, and breaks down special `eth_call`s which may leak your wallets relationship to ensure zero-tracking.
## Full attestation
### Attestation on Software Build
Leveraging the [attestable-build-tool](https://github.com/automata-network/attestable-build-tool), we achieve a reproducible build and result in the same MREnclave. If you're interested in the whole compilation process, you can download the source code and trigger an attestable build by yourself.
You can view the latest attestation report at its [release page](https://github.com/automata-network/1rpc-lite/releases).
### Attestation on Hardware
Currently 1RPC-lite is hosted in Azure Cloud and uses [Intel DCAP](https://github.com/intel/SGXDataCenterAttestationPrimitives) to complete the TEE attestation, ensuring that the hardware execution environment and the running code are matched as expected.
In Automata Testnet, we implement an [on-chain DCAP quote verification](https://explorer.ata.network/address/0xF470A9ac6e5DcCbfBC45656459fFA2A3F10b471c), and you can find the [current attestation](https://explorer.ata.network/tx/0xd703f17ad48f6538750ba1f8f495db064de9460e3969444904d820da7e41192f) it Automata Testnet.
## How to run
### 1. TLS cert & key
If you are going to run demo with https, plz prepare `domain.key` and `domain.crt`.
OR you just touch empty files at above locations for local test purpose.
```
> touch domain.key
> touch domain.crt
```
### 2. Config & Run
1RPC lite app can run in 2 modes:
* **relay mode**: relay jsonrpc requests, no protection details conveyed
* **demo mode**: not relay websocket jsonrpc requests, but instead send protection details via websocket channel
1. both modes load routes from static json config file (example in following section)
2. make sure no duplicate keys in routes
3. `wss` routes take no effect in demo mode
#### Run in relay mode
edit config-relay-example.json
```json
{
"eth": "http://127.0.0.1:8545", // <- replace with your prefered endpoint
"dot": "wss://rpc.polkadot.io", // etc
}
```
```
> RELEASE=1 ./scripts/1rpc.sh -r config-relay-example.json -d false --tls domain
```
(`--tls domain` is to lookup `domain.key` and `domain.crt`)
You can add env `SGX=1` to build&run the SGX version, before that you need to setup SGX
environment. You can find the [installation guides](https://download.01.org/intel-sgx/sgx-linux/2.9/docs/)
for Intel SGX software on the 01.org website. Besides, you need to prepare an account as well, to submit the dcap attestation in [Automata Testnet](https://docs.ata.network/protocol/testnet).
Test out:
1. make http jsonrpc requests to `http://127.0.0.1:3400/eth/$token`
2. or `wscat -c ws://127.0.0.1:3400/dot`, then make jsonrpc requests
#### Run in demo mode
edit config-demo-example.json
```json
{
"eth": "http://127.0.0.1:8545" // <- replace with your prefered endpoint
}
```
```
> RELEASE=1 ./scripts/1rpc.sh -r config-demo-example.json --tls domain
```
Test out:
0. choose some `token`
1. `wscat -c ws://127.0.0.1:3400/ws/$token` to open ws channel
2. make http jsonrpc requests to `http://127.0.0.1:3400/eth/$token`
3. you'll recv protection details in ws channel
## Contributing
Thank you for considering contributing to 1rpc-lite!
**Before You Contribute**:
* **Raise an Issue**: If you find a bug or wish to suggest a feature, please open an issue first to discuss it. Detail the bug or feature so we understand your intention.
* **Pull Requests (PR)**: Before submitting a PR, ensure:
* Your contribution successfully builds.
* It includes tests, if applicable.
Your efforts help make 1rpc-lite better, and we truly appreciate your support!