anumad

command module
v0.0.0-...-a1266a9 Latest Latest
Warning

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

Go to latest
Published: Oct 6, 2024 License: ISC Imports: 0 Imported by: 0

README

Anumad (ANUM)

ISC License GoDoc

Anumad is the reference full node Anuma Testnet implementation written in Go (golang).

What is anuma

Anuma is a Kaspa-based asset, a proof-of-work cryptocurrency with instant confirmations and sub-second block times. It is based on the PHANTOM protocol, a generalization of Nakamoto consensus.

Requirements

Go 1.20 or later.

Installation

Build from Source
  • Install Go according to the installation instructions here: http://golang.org/doc/install

  • Ensure Go was installed properly and is a supported version:

$ go version
  • Run the following commands to obtain and install anumad including all dependencies:
$ git clone https://github.com/arumanetwork/anumad
$ cd anumad
$ go install . ./cmd/...
  • Anumad (and utilities) should now be installed in $(go env GOPATH)/bin (usually in /home/YOURUSER/go/bin). If you did not already add the bin directory to your system path during Go installation, you are encouraged to do so now, you can do it with the following commands:
$ export PATH=$PATH:/home/YOURUSER/go/bin

For more information, please visit: http://golang.org/doc/install

Getting Started

Anumad has several configuration options available to tweak how it runs, but all of the basic operations work with zero configuration.

$ anumad --utxoindex

Discord

Join our Discord server using the following link:

Telegram

Join our Telegram channel using the following link:

Web

Visit us at Anuma's website:

License

Anumad is licensed under the copyfree ISC License.

Documentation

Overview

Copyright (c) 2018-2019 The anumanet developers Copyright (c) 2013-2018 The btcsuite developers Copyright (c) 2015-2016 The Decred developers Copyright (c) 2013-2014 Conformal Systems LLC. Use of this source code is governed by an ISC license that can be found in the LICENSE file.

Anumad is a full-node anuma implementation written in Go.

The default options are sane for most users. This means anumad will work 'out of the box' for most users. However, there are also a wide variety of flags that can be used to control it.

Usage:

anumad [OPTIONS]

For an up-to-date help message:

anumad --help

The long form of all option flags (except -C) can be specified in a configuration file that is automatically parsed when anumad starts up. By default, the configuration file is located at ~/.anumad/anumad.conf on POSIX-style operating systems and %LOCALAPPDATA%\anumad\anumad.conf on Windows. The -C (--configfile) flag can be used to override this location.

Directories

Path Synopsis
app
appmessage
Package appmessage implements the anuma appmessage protocol.
Package appmessage implements the anuma appmessage protocol.
rpc
cmd
anumawallet/libanumawallet/bip32/base58
Package base58 provides an API for working with modified base58 and Base58Check encodings.
Package base58 provides an API for working with modified base58 and Base58Check encodings.
infrastructure
db/database
Package database provides a database for anumad.
Package database provides a database for anumad.
logger
Package logger defines an interface and default implementation for subsystem logging.
Package logger defines an interface and default implementation for subsystem logging.
network/addressmanager
Package addressmanager implements concurrency safe Anuma address manager.
Package addressmanager implements concurrency safe Anuma address manager.
stability-test
daa

Jump to

Keyboard shortcuts

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