How do I deploy lsp-indexer on Railway?

You can deploy lsp-indexer on Railway by clicking the "Deploy Now" button on this page. Railway will automatically set up all the necessary services and configurations for you.

What are the system requirements?

Railway handles all the infrastructure requirements. You only need a web browser to deploy and manage your application.

Is this template free to use?

Yes, this template is free to use within your existing Railway account.

Can I customize this template?

Yes, you can fully customize this template. After deployment, you will have full control of what you've deployed in your Railway project.

How do I get support for this template?

You can get support through our community forum: lsp-indexer-763dea1b, or join our Discord community for more assistance.

Deploy and Host lsp-indexer on Railway

The LSP Indexer is an open-source tool that monitors the LUKSO blockchain, capturing key events like DataChanged, UniversalReceiver, and Transfer. It extracts and indexes data such as LSP3Profile and LSP4Metadata for easy querying and analysis, supporting developers and applications in the LUKSO ecosystem.

About Hosting lsp-indexer

Hosting lsp-indexer on Railway involves cloning the repository, installing dependencies with pnpm, and configuring environment variables like DB_URL, RPC_URL, and IPFS_GATEWAY. Build the project with pnpm build, apply database migrations, and start the indexer with pnpm start. Railway simplifies deployment by managing infrastructure, scaling, and database connectivity, ensuring seamless operation. A PostgreSQL database is required for data storage, and proper rate-limiting (RPC_RATE_LIMIT) prevents RPC overload. The monorepo structure, managed by pnpm workspaces, organizes packages for efficient event processing and indexing.

Common Use Cases

Real-time Event Monitoring: Track LUKSO blockchain events like Follow, Unfollow, or Transfer for live analytics or notifications.
Data Analysis for DApps: Index LSP3Profile and LSP4Metadata to power decentralized applications with structured blockchain data.
Smart Contract Interaction Tracking: Monitor Executed and UniversalReceiver events to analyze contract interactions and user activity.

Dependencies for lsp-indexer Hosting

Node.js: Required for running the indexer and managing pnpm dependencies.
PostgreSQL: Stores indexed blockchain data, configured via DB_URL.
pnpm: Manages the monorepo and dependencies across abi, indexer, and typeorm packages.

Deployment Dependencies

Implementation Details

To deploy on Railway, set up a new project, link the GitHub repository, and configure environment variables as per .env.example. Example .env setup:

DB_URL=postgresql://postgres:password@host:5432/postgres
RPC_URL=https://rpc.lukso.sigmacore.io
SQD_GATEWAY=https://v2.archive.subsquid.io/network/lukso-mainnet
IPFS_GATEWAY=https://api.universalprofile.cloud/ipfs/
RPC_RATE_LIMIT=10
FINALITY_CONFIRMATION=75
FETCH_LIMIT=10000
FETCH_BATCH_SIZE=1000
FETCH_RETRY_COUNT=5

Run pnpm build, pnpm migration:generate, and pnpm migration:apply during deployment setup. Railway automates scaling and database provisioning.

Why Deploy lsp-indexer on Railway?

Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying lsp-indexer on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.