nautiliad

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

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

Go to latest
Published: Mar 4, 2024 License: ISC Imports: 3 Imported by: 0

README

Nautiliad

ISC License GoDoc

Nautiliad is the reference full node Nexellia implementation written in Go (golang).

What is Nexellia

Nexellia is a fork of Kaspa with an ASIC resistance implementation Kaspa is an attempt at 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.18 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 nautiliad including all dependencies:
$ git clone https://github.com/shatll-s/nautiliad/
$ cd nautiliad
$ go install . ./cmd/...
  • Nautiliad (and utilities) should now be installed in $(go env GOPATH)/bin. If you did not already add the bin directory to your system path during Go installation, you are encouraged to do so now.

  • Open your shell configuration file. For example, for Bash, you can use the following command:

$ nano ~/.bashrc
  • Add the following line to the end of the file:
 export PATH=$PATH:$(go env GOPATH)/bin

Getting Started

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

Creating a wallet

  • To create a wallet, you need to run nautiliad with utxoindex
$ nautiliad --utxoindex
  • Open another terminal
$ nautiluswallet create
  • You will be asked to choose a password for the wallet (a password must be at least 8 characters long, and it won't be shown on the screen you as you entering it). After that you should run this command in order to start the wallet daemon:
$ nautiluswallet start-daemon
  • Do not close the first 2 terminals and open a new terminal and then run this in order to request an address from the wallet:
$ nautiluswallet new-address
  • Your screen will show you something like this:

The wallet address is: nautilus:0123456789abcdef0123456789abcdef0123456789

  • To see your secret seed phrase :
$ nautiluswallet dump-unencrypted-data

Note: Every time you ask nautiluswallet for an address you will get a different address. This is perfectly fine. Every secret key is associated with many different public addresses and there is no reason not to use a fresh one for each transaction.

At this point your can close the wallet daemon, though you should keep it running of you want to be able to check your balance and make transactions

Discord

Join our discord server using the following link: https://discord.gg/qWcUUgww4d

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

The documentation is a work-in-progress

License

Nautiliad is licensed under the copyfree ISC License.

Documentation

Overview

Copyright (c) 2018-2019 The kaspanet 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.

Nautiliad is a full-node kaspa implementation written in Go.

The default options are sane for most users. This means nautiliad 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:

nautiliad [OPTIONS]

For an up-to-date help message:

nautiliad --help

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

Directories

Path Synopsis
app
appmessage
Package appmessage implements the kaspa appmessage protocol.
Package appmessage implements the kaspa appmessage protocol.
rpc
cmd
nautiluswallet/libkaspawallet/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.
consensus/utils/txscript
Package txscript implements the kaspa transaction script language.
Package txscript implements the kaspa transaction script language.
dagconfig
Package dagconfig defines DAG configuration parameters.
Package dagconfig defines DAG configuration parameters.
infrastructure
db/database
Package database provides a database for nautiliad.
Package database provides a database for nautiliad.
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 Kaspa address manager.
Package addressmanager implements concurrency safe Kaspa address manager.
stability-tests
daa
testing
Package util provides kaspa-specific convenience functions and types.
Package util provides kaspa-specific convenience functions and types.
bech32
Package bech32 provides a Go implementation of the bech32 format.
Package bech32 provides a Go implementation of the bech32 format.

Jump to

Keyboard shortcuts

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