Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sweetmantech/myco-token-indexer
https://github.com/sweetmantech/myco-token-indexer
Last synced: about 16 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/sweetmantech/myco-token-indexer
- Owner: SweetmanTech
- License: mit
- Created: 2024-09-04T15:57:57.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T02:57:33.000Z (about 2 months ago)
- Last Synced: 2024-09-15T06:37:18.541Z (about 2 months ago)
- Language: JavaScript
- Size: 5.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Myco Token Indexer for Zora on Base
This project is a Node.js-based indexer for Zora protocol events on Base & Base Sepolia networks, designed to help developers building applications on Zora.
## Benefits for Zora Developers
This indexer provides several advantages for developers building applications on Zora:
1. **Stack.so Integration**: Automatically tracks events with Stack.so, enabling easy analytics and user engagement features.
2. **Real-time Event Tracking**: Automatically indexes and tracks Zora protocol events on Base networks.
3. **Customizable**: Can be easily modified to focus on specific Zora events or contracts of interest.
4. **Network Flexibility**: Supports both Base mainnet and Base Sepolia testnet.
5. **Efficient Data Processing**: Uses chunked requests and multiple RPC endpoints for reliable data fetching.
6. **Easy Integration**: Simplifies the process of accessing historical and real-time Zora event data.
By using this indexer, developers can focus on building their Zora applications without worrying about the complexities of event indexing and data management.
## Prerequisites
- Node.js (version 14 or higher recommended)
- npm (comes with Node.js)
## Installation
1. Clone the repository:
```
git clone https://github.com/SweetmanTech/myco-token-indexer
cd myco-token-indexer
```
2. Install dependencies:
```
npm install
```
3. Set up your environment variables:
Create a `.env` file in the root directory and add any necessary environment variables.
## Usage
To run the indexer:
1. Start the indexer:
```
npm start
```
2. The indexer will start processing events from the specified network (Base or Base Sepolia).
3. To switch between networks or customize the indexing process, you can modify the following environment variables in your `.env` file:
- `NETWORK`: Set to either `mainnet` for Base or `sepolia` for Base Sepolia
- `START_BLOCK`: The block number to start indexing from (optional)
- `END_BLOCK`: The block number to end indexing at (optional)
4. Monitor the console output for indexing progress and any potential errors.
5. The indexed data will be stored according to the implementation in `indexEventsForNetwork.js`.
## Event Indexed
This indexer specifically tracks the `UpdatedPermissions` event from the Zora Creator 1155 contract. This event is emitted when permissions are updated for a user on a specific token. It includes the following information:
- `tokenId`: The ID of the token for which permissions are being updated.
- `user`: The address of the user whose permissions are being updated.
- `permissions`: The new permissions value for the user.
By tracking this event, the indexer provides valuable data about permission changes within Zora collections, which can be useful for building a profile for creators.
## Customization
- To index different events or contracts, modify the `getEventSignature.js` file in the `lib/viem` directory to change the event being tracked.
- Adjust RPC endpoints in `lib/rpc.js` if needed.
- To modify how event data is processed or stored, update the `getEventPayload.js` file in the `lib/stack` directory.
## Deployment
This project is set up for automatic deployment to a DigitalOcean Droplet using GitHub Actions. Here's how to set up your own droplet for deployment:
1. **Create a DigitalOcean Droplet**:
- Sign up for a DigitalOcean account if you haven't already.
- Create a new Droplet, choosing Ubuntu as the operating system.
- Select a plan that suits your needs (Basic plan is often sufficient for starting).
- Choose a datacenter region close to your target audience.
- Add your SSH key for secure access.
2. **Initial Droplet Setup**:
- SSH into your new Droplet: `ssh root@your_droplet_ip`
- Update the system:
```
sudo apt update
sudo apt upgrade -y
```
- Install Node.js and npm:
```
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs
```
- Install PM2 globally: `sudo npm install -g pm2`
3. **Configure GitHub Secrets**:
In your GitHub repository, go to Settings > Secrets and add the following:
- `DROPLET_IP`: Your DigitalOcean Droplet's IP address
- `DROPLET_USER`: The username for SSH access (usually 'root')
- `DROPLET_PASSWORD`: Your Droplet's root password or SSH key passphrase
4. **Prepare the Droplet for Deployment**:
- Create the project directory: `mkdir -p ~/myco-token-indexer`
- Set up Node.js version management (optional but recommended):
```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
source ~/.bashrc
nvm install 20
nvm use 20
```
5. **Configure Environment Variables**:
- Create a `.env` file in the project directory on your Droplet:
```
nano ~/myco-token-indexer/.env
```
- Add necessary environment variables (e.g., `STACK_API_KEY`, `BASE_SEPOLIA_FIRST_BLOCK`, etc.)
- Save the file by pressing `Ctrl + X`, then `Y`, and finally `Enter`.
6. **Update GitHub Workflow**:
Ensure your `.github/workflows/deploy.yml` file is correctly set up. It should include steps to:
- Check out the code
- Set up Node.js
- Install dependencies
- Run tests
- Deploy to the DigitalOcean Droplet
7. **Trigger Deployment**:
- Push changes to your GitHub repository.
- The GitHub Action will automatically deploy your project to the Droplet.
8. **Verify Deployment**:
- SSH into your Droplet and check if the process is running:
```
pm2 list
```
- You should see `myco-token-indexer` in the list of processes.
With these steps, your project should be automatically deployed to your DigitalOcean Droplet whenever you push changes to your GitHub repository.
## Troubleshooting
If you encounter any issues during deployment:
1. Check the GitHub Actions logs for any error messages.
2. Ensure all secrets are correctly set in your GitHub repository.
3. Verify that your Droplet has sufficient resources (CPU, RAM, disk space).
4. Check the PM2 logs on your Droplet: `pm2 logs myco-token-indexer`
For more detailed logs, you can modify the logging level in the indexer code.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.