Skip to content
README.md 561 B
Newer Older
Maciej Hirsz's avatar
Maciej Hirsz committed
# Substrate RPC Proxy

### Installation

```
Maciej Hirsz's avatar
Maciej Hirsz committed
yarn
Maciej Hirsz's avatar
Maciej Hirsz committed
```

### Running

```
Maciej Hirsz's avatar
Maciej Hirsz committed
yarn start
Maciej Hirsz's avatar
Maciej Hirsz committed
```

Maciej Hirsz's avatar
Maciej Hirsz committed
### Available paths

+ `/block` fetch latest finalized block details.
+ `/block/NUMBER` fetch block details at block height `NUMBER`.

Maciej Hirsz's avatar
Maciej Hirsz committed
### Configuration

Following ENV variables can be set:

Maciej Hirsz's avatar
Maciej Hirsz committed
+ `BIND_HOST`: address on which the server will be listening, defaults to `127.0.0.1`.
Maciej Hirsz's avatar
Maciej Hirsz committed
+ `BIND_PORT`: port on which the server will be listening, defaults to `8080`.
+ `NODE_WS_URL`: WebSocket URL to which the RPC proxy will attempt to connect to, defaults to `ws://127.0.0.1:9944`.