Skip to content

Commit

Permalink
📝 Review readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KONFeature committed Dec 17, 2024
1 parent 1bfa692 commit 6e662e0
Showing 1 changed file with 5 additions and 30 deletions.
35 changes: 5 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,16 @@
# Frak Indexer
# Infra blockchain

Frak Indexer is an open-source project designed to index events from Frak smart contracts on the Arbitrum network. It combines the power of Ponder for building robust crypto apps with eRPC for efficient RPC caching and load balancing, all deployed using SST (Serverless Stack) on AWS infrastructure.
This repository contain all the blockchain related infra code for the [Frak](https://frak.id) project.

## Architecture Overview

The Frak Indexer consists of two main components:

1. **Ponder Service**: An open-source backend framework for building robust, performant, and maintainable crypto apps. In this project, it's used for indexing blockchain events from Frak smart contracts.
1.**[eRPC](https://github.com/erpc/erpc)**: RPC request caching and load balancing across multiple node providers

2. **eRPC Service**: A fault-tolerant EVM RPC load balancer with reorg-aware permanent caching and auto-discovery of node providers. It provides a layer of caching on top of other RPCs, enhancing performance and reliability.
2.**[Ponder](https://github.com/ponder-sh/ponder)**: Indexing blockchain events from Frak smart contracts.

Both services are deployed as containerized applications on AWS ECS (Elastic Container Service) using Fargate, with an Application Load Balancer (ALB) routing traffic between them.

## Deployment Architecture

- **VPC**: A dedicated VPC is created to house all components.
- **ECS Cluster**: Both Ponder and eRPC services run in the same ECS cluster.
- **Application Load Balancer**:
- Listens on port 80
- Routes traffic based on path patterns:
- `/rpc-main/*` -> eRPC service (for cached RPC requests)
- `/*` (all other paths) -> Ponder service (for indexed data access)
- **CloudFront Distribution**: Sits in front of the ALB to provide additional caching and global content delivery.

## Key Features

- **Efficient Indexing**: Utilizes Ponder to create a robust and maintainable indexing solution for Frak smart contract events.
- **Optimized RPC Access**: eRPC provides caching and load balancing across multiple RPC providers, improving performance and reliability.
- **Scalable**: Utilizes AWS Fargate for serverless container management.
- **High Availability**: Deployed across multiple availability zones.
- **Secure**: Uses AWS security groups and VPC for network isolation.
- **Observable**: Includes CloudWatch logs and metrics for monitoring.
- **Maintainable**: Infrastructure as Code (IaC) using SST for easy updates and version control.

## Contributing

We welcome contributions to the Frak Indexer project!
Both services are deployed as containerized applications on AWS ECS (Elastic Container Service) using Fargate, with a master Application Load Balancer (ALB) routing traffic between them.

## License

Expand Down

0 comments on commit 6e662e0

Please sign in to comment.