search

Qitmeer / qitmeer

The guardian of trust. The core backend of the qitmeer network
ISC License
52 stars 27 forks source link

readme

:tada: Notice:balloon:

We happily announce that The Qitmeer network has been upgraded to QNG (Qitmeer Next Generation) network :confetti_ball:, This repository has been archived and read-only.

Qitmeer

Build Status Build Status Go Report Card FOSSA Status

The guardian of trust. The core backend of the qitmeer network.

Qitmeer Mainnet Notice

The Qitmeer Mainnet is OPENED on 2021/09/30. The latest compatible network is the Umayyad Network. Please Join the Umayyad Network !

Latest Testnet Compatible Qitmeer Vesion Start Date Type
Umayyad Network 1.0 (mainnet) v0.10.6 2021/09/30 Official Public Mainnet

Please know more details from the Qitmeer Mainnet

Qitmeer Testnet Notice

The latest compatible Public Testnet is the Umayyad Network. Please help support Public testnet !

Latest Testnet Compatible Qitmeer Vesion Start Date Type
Umayyad Network 1.0 (testnet) v0.10.6 2021/09/30 Official Public Testnet

Please know more details from the Qitmeer Testnet

Installation

Binary archives

Releases

Standalone installation archive for Linux, macOS and Windows are provided in the Releases section. Please download an archive for your operating system and unpack the content to a place accessible from command line.

Builds Release Date
Last GitHub release GitHub Release Date
Stable GitHub release GitHub Release Date

How to build

Golang at least 1.12 (required >= 1.12)

Check your golang version.

~ go version
go version go1.16 darwin/amd64
~ mkdir -p /tmp/work
~ cd /tmp/work
~ git clone https://github.com/Qitmeer/qitmeer.git
~ cd qitmeer
~ make
Done building.
  qitmeer version 0.9.2+dev-1f5defd (Go version go1.16))
Run "./build/bin/qitmeer" to launch.

How to Run

Memory Requirements

Make sure to have at least 1GB free memory to run qitmeer. Insufficient memory may lead to the process being killed unexpectedly when its running. See FAQ #3 for details.

Getting Started

Mainnet

The easiest way to connect to mainnet is run qitmeer directly without any argument by executing following command.

./qitmeer

you will see following information from the console when the qitmeer node is started successfully. 


         .__  __
    _____|__|/  |_  _____   ____   ___________    Qitmeer 0.10.6-release-xxxx
   / ____/  \   __\/     \_/ __ \_/ __ \_  __ \   Port: <your_port, 8130 by defaut>
  < <_|  |  ||  | |  Y Y  \  ___/\  ___/|  | \/   PID : <your_pid>
   \__   |__||__| |__|_|  /\___  >\___  >__|      Network : mainnet
      |__|              \/     \/     \/          https://github.com/Qitmeer/qitmeer

Several configuration options available to tweak how it runs. Please see details by using the help command

./qitmeer --help
Testnet

Please make sure use --testnet to connect to the test network.

./qitmeer --testnet

Running with Docker

You can also run qitmeer by using docker

docker run qitmeer/qitmeerd

Other useful qitmeer repository

qitmeer-wallet

The command-line wallet of the Qitmeer network

qitmeer-miner

The GPU miner for the Qitmeer netowrk.

qitmeer-cli

The command line utility of Qitmeer

How to Work with ZeroMQ

Block and Transaction Broadcasting with ZeroMQ for details on how this works.

How to use Token

Qitmeer Token for details on how this works.

FAQ

How to exit qitmeer properly.

You can use Ctrl+C to exit in the foreground, or kill or kill -2 if in the backgroud. Please don't use kill -9 to kill the qitmeer process , this terminates the process abruptly and may leave database files improperly closed. may result corrupt data files. In the worst case, you might need to do a refresh block synchronization.

How to clean up corrupt data

qitmeer --cleanup --testnet

Please be careful! the command results your data to be removed!

How to fix golang.org unrecognized Issue

If you got trouble to download the golang.org depends automatically

go: golang.org/x/crypto@v0.0.0-20181001203147-e3636079e1a4: unrecognized import path "golang.org/x/crypto" (https fetch: Get https://golang.org/x/crypto?go-get=1: dial tcp 216.239.37.1:443: i/o timeout)
go: golang.org/x/net@v0.0.0-20181005035420-146acd28ed58: unrecognized import path "golang.org/x/net" (https fetch: Get https://golang.org/x/net?go-get=1: dial tcp 216.239.37.1:443: i/o timeout)
go: golang.org/x/net@v0.0.0-20180906233101-161cd47e91fd: unrecognized import path "golang.org/x/net" (https fetch: Get https://golang.org/x/net?go-get=1: dial tcp 216.239.37.1:443: i/o timeout)

you might need to replace the download url (ex: using a mirror site like github.com) on your go.mod

replace (
    golang.org/x/crypto v0.0.0-20181001203147-e3636079e1a4 => github.com/golang/crypto v0.0.0-20181001203147-e3636079e1a4
    golang.org/x/net v0.0.0-20180906233101-161cd47e91fd => github.com/golang/net v0.0.0-20180906233101-161cd47e91fd
    golang.org/x/net v0.0.0-20181005035420-146acd28ed58 => github.com/golang/net v0.0.0-20181005035420-146acd28ed58
)

Qitmeer is killed unexpectedly

qitmeer is killed unexpectedly probably due to the Out of Memory, If you're using Ubuntu linux, you can verify it by following command.

dmesg -T| grep -E -i -B100 'killed process'

If you find similar output as follows, then that maybe the case

[Tue Mar  9 11:34:26 2021] Out of memory: Killed process 140587 (qitmeer) total-vm:1403144kB,
anon-rss:675828kB, file-rss:0kB, shmem-rss:0kB, UID:1001 pgtables:1532kB oom_score_adj:0

The minimum memory requirement is 1GB, and we strongly recommend upgrading the memory to 2GB.

If the memory resource restrictions is do your case, You might try to upgrade your Golang to the latest version and re-compile Qitmeer and try yourself. We have received feedbacks from community that the newly golang compiler have better memory optimizations, might work better wth low memory requirement, and especially for Ubuntu 20.04.

If you're using Ubuntu 18.04/20.04, then you can use the longsleep/golang-backports PPA and update to latest golang. then re-compile your qitmeer and try if works for you.

sudo add-apt-repository ppa:longsleep/golang-backports
sudo apt update
sudo apt install golang-go

Please note, it does not guarantee that compiling with the latest golang might work. Adding more computer memory is always the recommended way.

Compliing failed by missing the go.sum entries

If your golang version is 1.16 or above, you might see similar error as follows when compiling.

go: github.com/Qitmeer/crypto@v0.0.0-20200516043559-dd457edff06c: missing go.sum entry; to add it:
        go mod download github.com/Qitmeer/crypto
make: *** [Makefile:41: qitmeer-build] Error 1

It's due to go1.16 changes default mod rules by disabling auto fixing missing entry in go.sum file. see details here.

It's an known issue and fixed by the latest code, Please update Qitmeer to the latest version and do the compiling again.

If you somehow need to stick to the current version, please make sure to execute following command before you compile qitmeer:

go mod tidy

License

FOSSA Status