Opensea Metadata Refresh Cron Job

This cron process refreshes an ERC-721 collection's metadata on Opensea on a given schedule. This utility makes it easy to keep OpenSea's offchain cache up-to-date for a given collection.

Thanks to BuidlGuidl for supporting this release.

Setup

Getting started

Clone this repository:

git clone https://github.com/yourusername/Opensea-Metadata-Refresh-Cron.git
cd Opensea-Metadata-Refresh-Cron

Install dependencies

This project uses pnpm as a package manager. If you don't have pnpm installed, install it globally using npm:

npm install -g pnpm

Then the project dependencies:

pnpm install

Configuration

Copy the .example.env file to a new file named .env. Fill out all fields in the .env file:

cp .example.env .env

Development

Start the development server using pnpm:

pnpm dev

Building for production

Build the application for production:

pnpm build

This command will compile the TypeScript files and output them to the dist directory.

Deployment

This application is designed to be run continuously on a production server using a process manager such as pm2.

You can start the application without installing pm2 globally as it is already in the project dependencies:

pnpm start

This will start the application and keep it running, even if the server restarts.

Logs

You can view the application logs using the provided scripts:

pnpm logs

Stopping the Application

To stop the application:

pnpm stop

Restarting the Application

To restart the application:

pnpm restart

Removing the Application

To remove the application from pm2:

pnpm delete

Killing pm2

To kill the pm2 daemon:

pnpm kill