Forest Explorer

Forest Explorer is a server-less inspector of the Filecoin blockchain.

Implementation

Rust + Leptos application which is compiled to a server WASM module and a client WASM module. The server module is hosted by CloudFlare. It pre-renders a HTML response and hydrates it (i.e. add reactivity) via the client WASM module.

Anything pushed to main will automatically be deployed at https://forest-explorer.chainsafe.dev.

Development

Installing node(LTS versions recommended).

Running corepack enable to opt-in corepack, see docs for details.

Running yarn or yarn --immutable once to install all required npm dependencies.

Running yarn start will spawn a local copy of the explorer.

To speed up the build during development, you can run yarn dev which will skip the optimization step.

You can define secrets for your local faucet in the .dev.vars file. This file is ignored by git.

SECRET_WALLET=
SECRET_MAINNET_WALLET=
SECRET_CALIBNET_USDFC_WALLET=
RATE_LIMITER_DISABLED=true

Note - the RATE_LIMITER_DISABLED variable is required to be set to true in order to bypass the rate limiter in the local environment if you want to test the faucet.

Dependencies

• wrangler
• wasm-pack
• worker-build

Custom deployments

Account & domain

Update these configurations in wrangler.toml:

1. Set account_id to your CloudFlare account ID.
2. Set the routes field to match your custom domain, or comment it out. By default, the worker will be deployed to: <YOUR_WORKER_NAME>.<YOUR_SUBDOMAIN>.workers.dev.

Rate limiter

1. Rate Limiter is enabled by default. To disable the rate limiter, run: npx wrangler@latest secret put RATE_LIMITER_DISABLED true.

⚠️ This is not recommended for production use as it will expose your service to abuse.

2. If you have a free CloudFlare account, use new_sqlite_classes instead of new_classes.

Wallets

Set SECRET_WALLET (calibnet) and/or SECRET_MAINNET_WALLET (mainnet) using npx wrangler@latest secret put (values are exported private keys, see forest-wallet export).

For USDFC, you can create a wallet using Metamask and then export the private key. Set the private key as SECRET_CALIBNET_USDFC_WALLET using the same commands as above.

Deployment

Run npx wrangler@latest deploy.

ℹ️ Note: To generate clean and consistent preview URLs, it's recommended to configure your CloudFlare Workers subdomain (account_name) as forest-explorer-preview in the CloudFlare dashboard (you only need to do this once).

Then, during deployment, use the --name option to set the preview worker name based on the latest Git commit hash:

npx wrangler@latest deploy --name $(git rev-parse --short HEAD)

This will deploy your worker to a URL like: https://<COMMIT_HASH>.forest-explorer-preview.workers.dev

🔒 Setting Secrets for Preview Workers

If you use a commit-based name, you must also specify it when setting secrets, so they are attached to the correct worker:

npx wrangler@latest secret put MY_SECRET --name $(git rev-parse --short HEAD)

End-to-End Testing

Prerequisites

• Grafana k6: Install k6 via the Official Grafana k6 Installation Guide
• Faucet: Start the faucet at http://localhost:8787 before running tests.

Run Tests

k6 run e2e/script.js