README
¶
zorkmid
Zorkmid is the reference node implementaiton for Zork crypto currency written in Go.
Zorkmid also known as:
- ZorkCoin™
- Zorkmid
- Zork
- Zorks™
- MilliZorks
- MicroZorks
- KiloZorks
- MegaZorks
- ZORK™
What is Zorkmid? aka Zorks?
Zorks are a proof-of-work cryptocurrency forked from Kaspa. It is based on the PHANTOM protocol, a generalization of Nakamoto consensus. The ZorkCoin currency is named after the epic game series of Zork. ZorkCoins are generically referenced as Zorks and the ticker symbol is ZORK.
We are happy to have forked our reference node from Kaspa and maintain it as a branch of the original source. This allows for easier maintenance of the future of Zorkmid since we can continue to update from our orinator, as well as provide bugfixes back to our origin. Though this does create some confusion when looking at some of the source since the name 'Kaspa' is not replaced through the entire source tree, instead the source is only modified where required to do so for the changes implemented in Zorks.
Note our transparency of any and all changes to the Kaspa code.
This Golang code is simply the start of the Zork Network.
Any & All Contributors are referenced as members of the Zork Underground.
Installation
Download & Use a Release
- As there are no releases yet there's not really a write-up to do it yet, but this placeholder exists to help you envision that there will be releases in the future!
Build from Source
Requirements
Tested with Go 1.23.4. Later should work, earlier might work.
-
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 the node including all dependencies:
git clone https://github.com/ZorkNetwork/zorkmid
cd zorkmid
go install . ./cmd/...
- The node and related 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
The node has several configuration options available to tweak how it runs, but all of the basic operations work with zero configuration.
zorkmid
Discord
Join the Zork Underground.
Issue Tracker
Since zorkmid was forked from the kaspanet/kaspad repository, many of the issues as related to that repository may also exist in this one. The integrated github issue tracker for kaspad can be used for issues that exists in both.
At this time zorkmid doesn't yet have a tracking system configured, so at this time use discord, or email Barbazzo Fernap
Documentation
Zork Network documentation is still in development. Join now to help guide the future of the netwrok!
The Kaspa documentation can be used for portions of this project.
License
Zorkmid is licensed under the copyfree ISC License. since it is forked from Kaspad.
Documentation
¶
Overview ¶
Copyright (c) 2025 Zork Network developers 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.
Zorkmid is a full-node zork coin implementation written in Go.
The default options are sane for most users. This means zorkmid 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:
zorkmid [OPTIONS]
For an up-to-date help message:
zorkmid --help
The long form of all option flags (except -C) can be specified in a configuration file that is automatically parsed when zorkmid starts up. By default, the configuration file is located at ~/.zorkcoin/zorkmid.conf on POSIX-style operating systems and %LOCALAPPDATA%\zorkcoin\zorkmid.conf on Windows. The -C (--configfile) flag can be used to override this location.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
appmessage
Package appmessage implements the kaspa appmessage protocol.
|
Package appmessage implements the kaspa appmessage protocol. |
|
cmd
|
|
|
kaspawallet/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 kaspad.
|
Package database provides a database for kaspad. |
|
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
|
|
|
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. |