mantle

command module
v0.3.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 9, 2021 License: Apache-2.0 Imports: 19 Imported by: 0

README

Mantle

🚧 Under heavy construction! 🚧

This repository contains official indexers built on mantle-sdk.

Installation and run

Installation process is likely to change once it hits a major release! Current installation steps are intended for internal developers only.

In order to run an instance of mantle,

git clone https://github.com/terra-project/mantle.git
cd mantle
go mod download
# then, follow instructions
Dependencies

mantle depends on 3 modules:

Versions of these packages need to adjusted in go.mod file to match the version of the network you are trying to index.

The go.mod file in master branch is set to run with the latest mainnet.

Adjusting package versions

Unlisted networks are to be supported in the future.

terra-project/core

core version MUST match with the network version you're trying to index. Fix core's version in go.mod file accordingly.

  • columbus-3: github.com/terra-project/core v0.3.7
  • columbus-4: github.com/terra-project/core v0.4.0
  • tequila-4: github.com/terra-project/core v0.4.0-rc.5
terra-project/compatibility

Adjust package version accordingly:

  • columbus-3: github.com/terra-project/mantle-compatibility v1.2.1-columbus-3
  • columbus-4: github.com/terra-project/mantle-compatibility v1.2.1-tequila-rc4
  • tequila-4: github.com/terra-project/mantle-compatibility v1.2.1-tequila-rc4
terra-project/mantle

We recommed using the latest version of mantle.

Build
go build main.go
Load genesis file

You'll need to use the same genesis file for the network you're trying to index.

  • Download from here.
  • Save it as genesis.json.
Run mantle instance
GENESIS_PATH=genesis.json \
ENDPOINT=<your-network-tendermint-rpc> \
DB_DIR=mantle-db \
GRAPHQL_PORT=1337
./mantle
Access indexed data through graphql

Default graphql port is 1337, which you can change by setting GRAPHQL_PORT environmental variable.

There's also a graphql playground available. You can access it at http://localhost:1337.

LICENSE

This software is licensed under the Apache 2.0 license. Read more about it here.

© 2020 Terraform Labs, PTE.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL