Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/aurora-is-near/aurora-relayer

[DEPRECATED] Web3-compatible relayer server for Aurora.
https://github.com/aurora-is-near/aurora-relayer
Last synced: 10 days ago
JSON representation
[DEPRECATED] Web3-compatible relayer server for Aurora.
Host: GitHub
URL: https://github.com/aurora-is-near/aurora-relayer
Owner: aurora-is-near
License: cc0-1.0
Created: 2020-12-10T08:48:23.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2023-04-10T11:10:00.000Z (over 1 year ago)
Last Synced: 2024-04-14T10:13:15.708Z (9 months ago)
Language: TypeScript
Homepage: https://aurora-is-near.github.io/aurora-relayer/
Size: 15.7 MB
Stars: 26
Watchers: 35
Forks: 13
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

        > **⚠ WARNING: This repository is deprecated. Please visit [Aurora Relayer V2](https://github.com/aurora-is-near/relayer2-public).

# Aurora Relayer

[![Project license](https://img.shields.io/badge/License-Public%20Domain-blue.svg)](https://creativecommons.org/publicdomain/zero/1.0/)

[![Discord](https://img.shields.io/discord/490367152054992913?label=Discord)](https://discord.gg/jNjHYUF8vw)

[![Lints](https://github.com/aurora-is-near/aurora-relayer/actions/workflows/lints.yml/badge.svg)](https://github.com/aurora-is-near/aurora-relayer/actions/workflows/lints.yml)

Implements a JSON-RPC server compatible with Ethereum's

[Web3 API](https://eth.wiki/json-rpc/API) for

[Aurora Engine](https://github.com/aurora-is-near/aurora-engine)

instances deployed on the NEAR Protocol.

## Prerequisites

- [Docker] and [Docker Compose]

[Docker]: https://docs.docker.com/engine/install/

[Docker Compose]: https://docs.docker.com/compose/install/

## Usage

### Usage for Testnet

To run the relayer locally, execute:

```bash

NEAR_ENV=testnet docker-compose up

```

You can customize the configuration by copying [`config/testnet.yaml`] to

`config/local.yaml` and editing that file. (The configuration settings in

`config/local.yaml` override the defaults from `config/testnet.yaml`.)

[`config/testnet.yaml`]: https://github.com/aurora-is-near/aurora-relayer/blob/master/config/testnet.yaml

### Usage for Testnet without Docker

1. `npm i`

2. Install postgresql and create database, [example](https://github.com/aurora-is-near/aurora-relayer/blob/master/.docker/docker-entrypoint-initdb.d/init.sh) of how to create database

3. Go to indexer directory `cd util/indexer`

4. Compile `indexer` binary, `go build`

5. Return to root directory of the project

6. Run Node.js server `NEAR_ENV=testnet node lib/index.js`

7. Run indexer `sh -c util/indexer/indexer | NEAR_ENV=testnet node lib/indexer_backend.js`

### Usage for Testnet without Docker and with live changes

To see local changes without restarting the Node.js server, instead of step 6, execute:

```

NEAR_ENV=testnet npm run start

npm run build:watch

```

### Run local specs

1. Apply mocks to local database `sh test/fixtures/mocks_init.sh`

2. Run indexer `sh -c util/indexer/indexer | NEAR_ENV=testnet node lib/indexer_backend.js`

3. Run local specs `npm run test`

### Usage for LocalNet

To run the relayer locally, first start [nearcore] and then execute:

```bash

NEAR_ENV=localnet docker-compose up

```

You can customize the configuration by copying [`config/localnet.yaml`] to

`config/local.yaml` and editing that file. (The configuration settings in

`config/local.yaml` override the defaults from `config/localnet.yaml`.)

[nearcore]: https://docs.near.org/docs/community/contribute/contribute-nearcore

[`config/localnet.yaml`]: https://github.com/aurora-is-near/aurora-relayer/blob/master/config/localnet.yaml

### Endpoint URL

The relayer's HTTP endpoint is served up on the TCP port 8545 by default.

For example, you can send a Web3 JSON-RPC request to the endpoint using

[HTTPie], as follows:

```bash

http post http://localhost:8545 jsonrpc=2.0 id=1 method=eth_blockNumber params:='[]'

```

[HTTPie]: https://httpie.io

## Configuration

To customize configuration settings, create a `config/local.yaml` file.

Configuration settings are loaded firstly from `config/default.yaml`, then from

`config/$NEAR_ENV.yaml`, and lastly from `config/local.yaml`. Settings in

files loaded later override the same settings from files loaded earlier.

### Configuring a signing key

To be able to call `eth_sendRawTransaction`, you must have a NEAR account and

signing key on the network you are relaying to, and said NEAR account must have

a sufficient Ⓝ balance to be able to send transactions.

To configure the signing account and private key, place the JSON key file

into the `config/` directory and edit `config/local.yaml` as follows:

```yaml

signer: you.testnet

signerKey: config/you.testnet.json

```

If you're using the [NEAR CLI], you will find your signing keys stored as JSON

key files under your `$HOME/.near-credentials/` directory.

[NEAR CLI]: https://docs.near.org/docs/tools/near-cli

## Status

Method | Status | Notes

------ | ------ | -----

[`web3_clientVersion`] | ✅ |

[`web3_sha3`] | ✅ |

[`net_listening`] | ✅ |

[`net_peerCount`] | ✅ |

[`net_version`] | ✅ |

[`eth_accounts`] | ✅ |

[`eth_blockNumber`] | ✅ |

[`eth_call`] | ✅ |

[`eth_chainId`] | ✅ |

[`eth_coinbase`] | ✅ |

[`eth_compileLLL`] | ❌ | Unsupported

[`eth_compileSerpent`] | ❌ | Unsupported

[`eth_compileSolidity`] | ❌ | Unsupported

[`eth_estimateGas`] | ✅ |

[`eth_gasPrice`] | ✅ |

[`eth_getBalance`] | ✅ |

[`eth_getBlockByHash`] | ✅ |

[`eth_getBlockByNumber`] | ✅ |

[`eth_getBlockTransactionCountByHash`] | ✅ |

[`eth_getBlockTransactionCountByNumber`] | ✅ |

[`eth_getCode`] | ✅ |

[`eth_getCompilers`] | ✅ |

[`eth_getFilterChanges`] | ✅ |

[`eth_getFilterLogs`] | ✅ |

[`eth_getLogs`] | ✅ |

[`eth_getProof`] | ❌ | EIP-1186

[`eth_getStorageAt`] | ✅ |

[`eth_getTransactionByBlockHashAndIndex`] | ✅ |

[`eth_getTransactionByBlockNumberAndIndex`] | ✅ |

[`eth_getTransactionByHash`] | ✅ |

[`eth_getTransactionCount`] | ✅ |

[`eth_getTransactionReceipt`] | ✅ |

[`eth_getUncleByBlockHashAndIndex`] | ✅ |

[`eth_getUncleByBlockNumberAndIndex`] | ✅ |

[`eth_getUncleCountByBlockHash`] | ✅ |

[`eth_getUncleCountByBlockNumber`] | ✅ |

[`eth_getWork`] | ❌ | Unsupported

[`eth_hashrate`] | ✅ |

[`eth_mining`] | ✅ |

[`eth_newBlockFilter`] | ✅ |

[`eth_newFilter`] | ✅ |

[`eth_newPendingTransactionFilter`] | ✅ |

[`eth_pendingTransactions`] | ✅ | [Undocumented](https://github.com/ethereum/go-ethereum/issues/1648#issuecomment-130591933)

[`eth_protocolVersion`] | ✅ |

[`eth_sendRawTransaction`] | ✅ |

[`eth_sendTransaction`] | ❌ | Unsupported

[`eth_sign`] | ❌ | Unsupported

[`eth_signTransaction`] | ❌ | Unsupported

[`eth_signTypedData`] | ❌ | Unsupported

[`eth_submitHashrate`] | ❌ | Unsupported

[`eth_submitWork`] | ❌ | Unsupported

[`eth_syncing`] | ✅ |

[`eth_uninstallFilter`] | ✅ |

[`db_getHex`] | ❌ | Deprecated

[`db_getString`] | ❌ | Deprecated

[`db_putHex`] | ❌ | Deprecated

[`db_putString`] | ❌ | Deprecated

[`shh_addToGroup`] | ❌ | Discontinued

[`shh_getFilterChanges`] | ❌ | Discontinued

[`shh_getMessages`] | ❌ | Discontinued

[`shh_hasIdentity`] | ❌ | Discontinued

[`shh_newFilter`] | ❌ | Discontinued

[`shh_newGroup`] | ❌ | Discontinued

[`shh_newIdentity`] | ❌ | Discontinued

[`shh_post`] | ❌ | Discontinued

[`shh_uninstallFilter`] | ❌ | Discontinued

[`shh_version`] | ❌ | Discontinued

[`txpool_content`] | ✅ | Geth extension

[`txpool_inspect`] | ✅ | Geth extension

[`txpool_status`] | ✅ | Geth extension

[`parity_pendingTransactions`] | ✅ | Parity extension

**Legend**: ❌ = not supported. 🚧 = work in progress. ✅ = supported.

[`web3_clientVersion`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#web3_clientversion

[`web3_sha3`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#web3_sha3

[`net_listening`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#net_listening

[`net_peerCount`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#net_peercount

[`net_version`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#net_version

[`eth_accounts`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts

[`eth_blockNumber`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_blocknumber

[`eth_call`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call

[`eth_chainId`]: https://eips.ethereum.org/EIPS/eip-695

[`eth_coinbase`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_coinbase

[`eth_compileLLL`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_compilelll

[`eth_compileSerpent`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_compileserpent

[`eth_compileSolidity`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_compile_solidity

[`eth_estimateGas`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_estimategas

[`eth_gasPrice`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gasprice

[`eth_getBalance`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getbalance

[`eth_getBlockByHash`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbyhash

[`eth_getBlockByNumber`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblockbynumber

[`eth_getBlockTransactionCountByHash`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbyhash

[`eth_getBlockTransactionCountByNumber`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getblocktransactioncountbynumber

[`eth_getCode`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcode

[`eth_getCompilers`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getcompilers

[`eth_getFilterChanges`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterchanges

[`eth_getFilterLogs`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getfilterlogs

[`eth_getLogs`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs

[`eth_getProof`]: https://eips.ethereum.org/EIPS/eip-1186

[`eth_getStorageAt`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getstorageat

[`eth_getTransactionByBlockHashAndIndex`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionbyblockhashandindex

[`eth_getTransactionByBlockNumberAndIndex`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionbyblocknumberandindex

[`eth_getTransactionByHash`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionbyhash

[`eth_getTransactionCount`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactioncount

[`eth_getTransactionReceipt`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionreceipt

[`eth_getUncleByBlockHashAndIndex`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getunclebyblockhashandindex

[`eth_getUncleByBlockNumberAndIndex`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getunclebyblocknumberandindex

[`eth_getUncleCountByBlockHash`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getunclecountbyblockhash

[`eth_getUncleCountByBlockNumber`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getunclecountbyblocknumber

[`eth_getWork`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getwork

[`eth_hashrate`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_hashrate

[`eth_mining`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_mining

[`eth_newBlockFilter`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newblockfilter

[`eth_newFilter`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter

[`eth_newPendingTransactionFilter`]: https://openethereum.github.io/JSONRPC-eth-module.html#eth_newpendingtransactionfilter

[`eth_pendingTransactions`]: https://github.com/ethereum/wiki/issues/685

[`eth_protocolVersion`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_protocolversion

[`eth_sendRawTransaction`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendrawtransaction

[`eth_sendTransaction`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sendtransaction

[`eth_sign`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign

[`eth_signTransaction`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_signtransaction

[`eth_signTypedData`]: https://eips.ethereum.org/EIPS/eip-712

[`eth_submitHashrate`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_submithashrate

[`eth_submitWork`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_submitwork

[`eth_syncing`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_syncing

[`eth_uninstallFilter`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_uninstallfilter

[`db_getHex`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#db_gethex

[`db_getString`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#db_getstring

[`db_putHex`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#db_puthex

[`db_putString`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#db_putstring

[`shh_addToGroup`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_addtogroup

[`shh_getFilterChanges`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_getfilterchanges

[`shh_getMessages`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_getmessages

[`shh_hasIdentity`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_hasidentity

[`shh_newFilter`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_newfilter

[`shh_newGroup`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_newgroup

[`shh_newIdentity`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_newidentity

[`shh_post`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_post

[`shh_uninstallFilter`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_uninstallfilter

[`shh_version`]: https://ethereum.org/en/developers/docs/apis/json-rpc/#shh_post

[`txpool_content`]: https://geth.ethereum.org/docs/rpc/ns-txpool#txpool_content

[`txpool_inspect`]: https://geth.ethereum.org/docs/rpc/ns-txpool#txpool_inspect

[`txpool_status`]: https://geth.ethereum.org/docs/rpc/ns-txpool#txpool_status

[`parity_pendingTransactions`]: https://openethereum.github.io/JSONRPC-parity-module#parity_pendingtransactions

## Contributing

1. Clone the repo

2. Create your branch

3. Add your changes

4. Run tests (`npm run test`, the local server must be running for the tests to pass). Fix if you broke something. Add your own tests

5. Format your code (`npm run format`)

6. Run linter (`npm run lint`)

7. Build changes (`npm run build`)

8. Commit your Changes (`git commit -m 'Resolved an issue'`)

9. Push to the Branch (`git push origin new_feature`)

10. Open a Pull Request