Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RPCs with what API is supported and more links and auth info #2314

Merged
merged 5 commits into from
Sep 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 160 additions & 38 deletions networks/mainnet/rpcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,170 @@ description: Public RPC endpoints are available for the Filecoin mainnet.

# RPCs

{% hint style="info" %}
[Chainlist](https://chainlist.org/?search=filecoin&testnets=true) contains a dynamically updated list of available Filecoin RPCs. [Find out more at chainlist.org's Filecoin listings](https://chainlist.org/?search=filecoin&testnets=true).
{% endhint %}

These endpoints are limited to [read-only Filecoin JSON RPC API calls](../../reference/json-rpc/) and [`MPoolPush`](../../reference/json-rpc/mpool.md) for sending messages that have already been signed.

## [Ankr](https://ankr.com)

* HTTPS: `https://rpc.ankr.com/filecoin`
* [Supported Filecoin API methods](https://www.ankr.com/docs/rpc-service/chains/chains-list/#filecoin)

## [ChainupCloud](https://cloud.chainup.com)

* HTTPS: `https://filecoin.chainup.net/rpc/v1`
* WebSocket: `wss://filecoin.chainup.net/rpc/v1`
* [ChainupCloud documentation](https://docs.chainupcloud.com/blockchain-api/filecoin/public-apis)

## [Glif](https://api.node.glif.io)

Please note that publicly available hosted endpoints **only guarantee 2000 of the latest blocks.**

* HTTPS: `https://api.node.glif.io/rpc/v1`
* WebSocket: `wss://wss.node.glif.io/apigw/lotus/rpc/v1`
* Lotus lite-node command:
[Chainlist](https://chainlist.org/?search=filecoin&testnets=true) provides a dynamically updated list of [available Filecoin - Mainnet RPCs](https://chainlist.org/?search=filecoin&testnets=false).

These endpoints are limited to [read-only Filecoin JSON RPC API calls](../../reference/json-rpc/) including [Filecoin Eth RPC methods](../../reference/json-rpc/eth.d). The only write operation are [`MPoolPush`](../../reference/json-rpc/mpool.md#mpoolpush) and [`EthSendRawTransaction`](../../reference/json-rpc/eth.md#ethsendrawtransaction)for sending already signed messages.

{% hint style="info" %} Please note that most publicly hosted endpoints **only guarantee recent state, i.e. 2000 of the latest blocks (last 16.67 hours).** To request an archival node you can contact a provider below. {% endhint %}


<table>
eshon marked this conversation as resolved.
Show resolved Hide resolved
<tr>
<td rowspan="5">
<a href="https://api.node.glif.io/">Glif Nodes</a>
</td>
<td>
HTTPS
</td>
<td>
<code>https://api.node.glif.io/rpc/v1</code>
</td>
</tr>
<tr>
<td>
WSS
</td>
<td>
<code>wss://wss.node.glif.io/apigw/lotus/rpc/v1</code>
</td>
</tr>
<tr>
<td>
Docs
</td>
<td>
<a href="https://api.node.glif.io">Glif Nodes - Docs</a>
</td>
</tr>
<tr>
<td>
API Support
</td>
<td>
All Filecoin and Eth JSON RPC methods including <a href="https://docs.filecoin.io/reference/json-rpc/mpool#mpoolpush">MPoolPush</a>
</td>
</tr>
<tr>
<td>
Contact
</td>
<td>
<a href='https://filecoinproject.slack.com/archives/C017HM9BJ8Z'>#fil-glif-node-hosting</a> in <a href='https://filecoin.io/slack'>Filecoin Slack</a>
</td>
</tr>
<tr>
<td rowspan="4">
<a href="https://ankr.com">Ankr</a>
</td>
<td>
HTTPS
</td>
<td>
<code>https://rpc.ankr.com/filecoin</code>
</td>
</tr>
<tr>
<td>
WSS
</td>
<td>
By request at: https://www.ankr.com/rpc/filecoin
</td>
</tr>
<tr>
<td>
Docs
</td>
<td>
<a href="https://www.ankr.com/docs/rpc-service/chains/chains-list/#filecoin">Ankr Docs - Filecoin</a>
</td>
</tr>
<tr>
<td>
API Support
</td>
<td>
All Filecoin and Eth JSON RPC methods including <a href="https://docs.filecoin.io/reference/json-rpc/mpool#mpoolpush">MPoolPush</a>
</td>
</tr>
<tr>
<td rowspan="3">
<a href="https://cloud.chainup.com/">Chainup Cloud</a>
</td>
<td>
HTTPS
</td>
<td>
<code>https://filecoin.chainup.net/rpc/v1</code>
</td>
</tr>
<tr>
<td>
WSS
</td>
<td>
<code>wss://filecoin.chainup.net/rpc/v1</code>
</td>
</tr>
<tr>
<td>
Docs
</td>
<td>
<a href="https://docs.chainupcloud.com/blockchain-api/filecoin/public-apis">Chainup Cloud Docs - Filecoin</a>
</td>
</tr>
<tr>
<td rowspan="2">
<a href="https://nownodes.io/">NOWNodes</a>
</td>
<td>
HTTPS
</td>
<td>
<code>https://fil.nownodes.io</code> (Free for 1 month with <a href="https://nownodes.io/pricing">signup</a>)
</td>
</tr>
<tr>
<td>
Docs
</td>
<td>
<a href="https://documenter.getpostman.com/view/13630829/TVmFkLwy">NOWNodes - Docs</a>
</td>
</tr>
<tr>
<td rowspan="2">
<a href="https://getblock.io/nodes/fil">GetBlock</a>
</td>
<td>
HTTPS
</td>
<td>
<code>https://filecoin.getblock.io</code> (Free with <a href="https://getblock.io/nodes/fil/">signup</a>)
</td>
</tr>
<tr>
<td>
Docs
</td>
<td>
<a href="https://getblock.io/docs/getblock-explorer/get-started/">GetBlock - Docs</a>
</td>
</tr>
</table>


## Additional Notes:

* Glif Nodes offers a [Lotus Lite node](https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node) endpoint with the following command:

```shell
FULLNODE_API_INFO=wss://wss.node.glif.io/apigw/lotus lotus daemon --lite
```

When using a lite-node, omit `/rpc/v1` from Glif’s WebSocket address.
* [Glif documentation](https://hosting.glif.io/)

* ## [GetBlock](https://getblock.io/nodes/fil/)

GetBlock offers users access to shared and dedicated nodes with a simple pricing model. Developers can try out their services with a free plan, after which paid options are available for continued access.

HTTPS: https://filecoin.getblock.io
[GetBlock documentation](https://getblock.io/docs/getblock-explorer/get-started/)

## [NOWNodes](https://nownodes.io/)
When using a Lotus Lite node, omit `/rpc/v1` from Glif’s WebSocket address.

A Lotus Lite node is a stripped down version of a Lotus full-node capable of running on lower-end hardware. It also allows for local signing for storage deals without a full Lotus node.

These nodes are available for free to users for the [first month](https://nownodes.io/pricing), after which the user will have to pay to maintain access.

* HTTPS: `https://fil.nownodes.io`
* [NOWNodes documentation](https://documenter.getpostman.com/view/13630829/TVmFkLwy)
Loading