UXUY Indexer
  • INTRODUCTION
    • 🎃Overview
    • 🤓Protocol Highlights
    • 📽️Feature Highlights
    • 🛣️Roadmap
  • 🌲INDEXS PROTOCOL
    • Recipes
    • Inscriptions RFC
    • Supported
    • Partner
    • Work Mechanism
      • Arch
      • INDS
    • Quick Start
    • Indexer
      • Get Started
      • Configuration
      • Running Indexer & API Server
      • API
      • Explorer
    • API Reference
      • About
      • API V1
        • Inscription.All
        • Inscription.Tick
        • Address.Transactions
        • Address.Balances
        • Address.Balance
        • Tick.Holders
        • Block.LastNumber
        • Tool.InscriptionTxOperate
        • Transaction.Info
      • API V1 Specification
      • API V2
        • Inds getTicks
        • Inds getTransactionByAddress
        • Inds getBalancesByAddress
        • Inds getHoldersByTick
        • Inds getLastBlockNumberIndexed
        • Inds getTickByCallData
        • Inds getTransactionByHash
        • Inds getTransactions
        • Inds getInscriptions
        • Inds getInscriptionTxOperate
        • Index getInscriptionByTick
        • Inds getAddressBalance
        • Inds getTickBriefs
        • Inds getAllChains
        • Inds search
      • API V2 Specification
    • Changelog
      • Version Alpha
    • Team
  • 🪄INDEXS FEATURES
    • Index
    • List
  • 🔐RISK & SECURITY
    • Credit Risk
  • 🌌ECOSYSTEM
    • Overview
  • 📚INDEXS GUIDES
    • Guides Overview
  • 🧙‍♂️FAQS
    • General
    • Resources
  • 💼WE'RE HIRING!
    • Open Positions
Powered by GitBook
On this page
  • Standalone
  • Prerequisites:
  • Docker
  • How to become contributor ?

Was this helpful?

  1. INDEXS PROTOCOL

Quick Start

PreviousINDSNextIndexer

Last updated 1 year ago

Was this helpful?

So far, UXUY Indexer has opensource and release alpha version.

Standalone

The UXUY Indexer has two parts, the first part is Indexer and the second one is API-Server.

Indexer has 3 modules, Scan Index Persistent.

Prerequisites:

  • Ensure Golang is installed.

  • Set up your Go workspace.

Blockchain Indexer Setup:

  1. Choose or deploy an Ethereum node; obtain its RPC endpoint (e.g., Infura).

  2. Set up MySQL on your server or use a cloud service.

Build & Run

git clone https://github.com/uxuycom/indexer.git
mysql -uroot -p < indexer/db/init_mysql.sql
// RUN Indexer
git clone https://github.com/uxuycom/indexer.git
cd indexer
make build && sudo make install

// Before do this, you needs to initial database first.
// mysql 
// Update the config follow the docs
indexer -c config.json

// Run Indexer JSONRPC API server
apiserver -c config.json

Docker

You can run Indexer and API use Docker soon.

How to become contributor ?

If you are a developer, you can join us to develop and make the indexer more powerful.

If you are interesting on this, feel free to join the community to make better place.

🌲
LogoGitHub - uxuycom/indexerGitHub