mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-05-20 13:56:45 +00:00
70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
|
|
Kaspad
|
|
====
|
|
|
|
[](https://choosealicense.com/licenses/isc/)
|
|
[](http://godoc.org/github.com/kaspanet/kaspad)
|
|
|
|
Kaspad is the reference full node Kaspa implementation written in Go (golang).
|
|
|
|
## What is kaspa
|
|
|
|
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](https://eprint.iacr.org/2018/104.pdf), 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:
|
|
|
|
```bash
|
|
$ go version
|
|
```
|
|
|
|
- Run the following commands to obtain and install kaspad including all dependencies:
|
|
|
|
```bash
|
|
$ git clone https://github.com/kaspanet/kaspad
|
|
$ cd kaspad
|
|
$ go install . ./cmd/...
|
|
```
|
|
|
|
- Kaspad (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.
|
|
|
|
|
|
## Getting Started
|
|
|
|
Kaspad has several configuration options available to tweak how it runs, but all
|
|
of the basic operations work with zero configuration.
|
|
|
|
```bash
|
|
$ kaspad
|
|
```
|
|
|
|
## Discord
|
|
Join our discord server using the following link: https://discord.gg/YNYnNN5Pf2
|
|
|
|
## Issue Tracker
|
|
|
|
The [integrated github issue tracker](https://github.com/kaspanet/kaspad/issues)
|
|
is used for this project.
|
|
|
|
Issue priorities may be seen at https://github.com/orgs/kaspanet/projects/4
|
|
|
|
## Documentation
|
|
|
|
The [documentation](https://github.com/kaspanet/docs) is a work-in-progress
|
|
|
|
## License
|
|
|
|
Kaspad is licensed under the copyfree [ISC License](https://choosealicense.com/licenses/isc/).
|