Removed divide char and added comment restriction
What is Moonstream?
Moonstream creates economic infrastructure for web3 projects with a focus on blockchain games.
This repository contains Moonstream's complete data analysis stack. The emphasis of it is on collecting actionable data related to the blockchain. The repository contains:
- Database management tools
- Blockchain node management tools
- Blockchain data crawlers
- Access-controlled API which exposes collected data
Who uses Moonstream?
People from different backgrounds who are interested in data, crypto and code. Moonstream tools are often used by game designers and economists, data scientists, smart contract developers, backend engineers, and teams managing loyalty programs for blockchain projects.
Some projects currently using Moonstream:
Please read the Game Master's Guide to Moonstream Solutions if you want to know how Moonstream tools are applied in web3 games.
Moonworm tool is used to build datasets of on-chain data related to market activity. The dataset with on-chain activity from the Ethereum NFT market (April 1 to September 25, 2021) is available on Kaggle. The full report on it is published on GitHub.
Proprietary technologies are not inclusive technologies, and we believe in inclusion.
You are and will always be free to host your own instance of Moonstream.
This monorepo contains the following components:
frontend: A web frontend for Moonstream. Allows users to create dashboards and monitor the activity of accounts and smart contracts on multiple blockchains. Built in React.
backend': The Moonstream API allows users to programmatically consume data about transactions and events taking place on blockchains crawled by Moonstream. Built in Python using Fast API.
crawlers: This part of the code base contains workers which extract data from blockchains, transaction pools, and other sources. We have many crawlers and each crawler can utilize a different tech stack.
db: Moonstream stores blockchain data in Postgres. This directory contains the code we use to manage the schema in our Postgres database. For sources that send higher volumes of data, we use a separate Postgres database and interface with it using Bugout.
Installation and setup
Run server with Docker Compose
If you want to deploy Moonstream in isolation against live services, then docker compose is your choice!
- Run script
backend/configs/docker_generate_env.bashwhich prepare for you:
backend/configs/docker.moonstreamapi.envwith environment variables
- Run script
db/configs/docker_generate_env.bashwhich prepare for you:
db/configs/alembic.moonstreamdb.iniwith postgresql uri
- Run local setup
docker-compose up --build
We are working on contributing guidelines. In the meantime, please reach out to @zomglings on the Moonstream Discord.