WalCDN Cloudflare Worker

Cloudflare worker used to retrieve and cache from the Filecoin PDP Storage Providers.

Development

Workflow

1. Install dependencies

   npm install
   

2. Run tests

   npm test
   

3. Fix linting and formatting issues:

   npm run lint:fix
   

Update auto-generated TypeScript definitions

After you make any change affecting the content of the env object, run the following command to update the auto-generated TypeScript definitions:

npm run build:types

Run the Retriever worker locally

1. Choose a base36 encoded wallet address you will use for the requests, e.g. 3rkdb89wnwzj3f2i7hnvuyna5vn7glk9vf3igtht9x6ejmboly.

2. Edit your /etc/hosts file and add an entry for 3rkdb89wnwzj3f2i7hnvuyna5vn7glk9vf3igtht9x6ejmboly.localhost:

   127.0.0.1»foo.localhost
   

3. Start the retriever worker locally

   npm start -w retriever
   

Reset the local database

Run the following command to reset the wrangler local environment, including the local database:

rm -rf  db/.wrangler

Deployment (Github Actions)

In order to deploy your worker via Github Actions, you need to have a Cloudflare API token.

Add generated API token to Github secrets as CLOUDFLARE_API_TOKEN.

After setting up secrets, you can push your code to Github and worker will be deployed to production environment automatically.

Measure response time

You can measure retrieval response times using the scripts/measure-response-time.js script. This script compares response times between the aggregator and worker, both with and without caching enabled.

To run the script, use the following command:

node scripts/measure-response-time.js <blobID>