bitmarkd

module

v0.8.2 Latest Latest Go to latest Published: Oct 8, 2018 License: ISC

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bitmark-inc/bitmarkd

Links

Open Source Insights

README ¶

bitmarkd - Main program

Prerequisites

Install the go language package for your system
Configure environment variables for go system
install the ZMQ4, UCL, Argon2 libraries

For shell add the following to the shell's profile (remark the export CC=clang if you wish to use gcc)

# check for go installation
GOPATH="${HOME}/gocode"
if [ -d "${GOPATH}" ]
then
  gobin="${GOPATH}/bin"
  export GOPATH
  export PATH="${PATH}:${gobin}"
  # needed for FreeBSD 10 and later
  export CC=clang
else
  unset GOPATH
fi
unset gobin

On FreeBSD/PC-BSD

pkg install libzmq4 libargon2 libucl

On a Debian like system (as of Ubuntu 14.04 this only has V3, so need to search for PPA)

apt-get install libzmq4-dev
# lib ucl and argon2 need to be manually installed
# see the Makefile in c-libraries to set up local static copies

On a macosx (be sure that homebrew is installed correctly)

brew install libucl
brew install argon2

brew tap bitmark-inc/bitmark
brew install zeromq41

On Ubuntu (tested dor distribution 18.04)

Install following packages sudo apt install libargon2-0-dev autoconf libtool pkg-config uuid-dev libzmq3-dev

Compile and install ucl

git clone https://github.com/vstakhov/libucl.git
cd libucl
./autogen.sh
./configure --enable-utils
make
make install

To compile simply:

go get github.com/bitmark-inc/go-libucl
go get github.com/bitmark-inc/go-argon2
go get github.com/bitmark-inc/bitmarkd
go install -v github.com/bitmark-inc/bitmarkd/command/bitmarkd

Set up

Create the configuration directory, copy sample configuration, edit it to set up IPs, ports and local bitcoin testnet connection.

mkdir -p ~/.config/bitmarkd
cp command/bitmarkd/bitmarkd.conf.sample  ~/.config/bitmarkd/bitmarkd.conf
${EDITOR}   ~/.config/bitmarkd/bitmarkd.conf

To see the bitmarkd sub-commands:

bitmarkd --config-file="${HOME}/.config/bitmarkd/bitmarkd.conf" help

Generate key files and certificates.

bitmarkd --config-file="${HOME}/.config/bitmarkd/bitmarkd.conf" gen-peer-identity
bitmarkd --config-file="${HOME}/.config/bitmarkd/bitmarkd.conf" gen-rpc-cert
bitmarkd --config-file="${HOME}/.config/bitmarkd/bitmarkd.conf" gen-proof-identity

Start the program.

bitmarkd --config-file="${HOME}/.config/bitmarkd/bitmarkd.conf" start

Note that a similar process is needed for the prooferd (mining subsystem)

Coding

all variables are camel case i.e. no underscores
labels are all lowercase with '_' between words
imports and one single block
all break/continue must have label
avoid break in switch and select

Directories ¶

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

Path	Synopsis
account types and functions for converting Bitmark accounts (the public key) and their signatures	types and functions for converting Bitmark accounts (the public key) and their signatures
announce network announcements	network announcements
asset Cache for assets temporary store assets just received until they are: a.	Cache for assets temporary store assets just received until they are: a.
avl an AVL balanced tree with the addition of parent pointers to allow iteration through the nodes Note: an individual tree is not thread safe, so either access only in a single go routine or use mutex/rwmutex to restrict access.	an AVL balanced tree with the addition of parent pointers to allow iteration through the nodes Note: an individual tree is not thread safe, so either access only in a single go routine or use mutex/rwmutex to restrict access.
background Simple skeleton for background processes	Simple skeleton for background processes
block current block data	current block data
blockdigest implementation block header hashing using a memory intensive argon2-d algorithm	implementation block header hashing using a memory intensive argon2-d algorithm
blockrecord the structure of the block header includes functions to pack/unpack []byte form	the structure of the block header includes functions to pack/unpack []byte form
blockring uses crc64 of recent blocks to produce a deterministic number for the issue hashing verification system	uses crc64 of recent blocks to produce a deterministic number for the issue hashing verification system
cache Package cache maintains the memory data store *** Data Structure * Pool Key Value ExpiresAfter \|___ PendingTransfer merkle.Digest (link) merkle.Digest (txid) 72h \|___ UnverifiedTxIndex merkle.Digest (txid) pay.PayId 72h \|___ UnverifiedTxEntries pay.PayId reservoir.unverifiedItem 72h \|___ VerifiedTx merkle.Digest (txid) reservoir.verifiedItem never \|___ OrphanPayment pay.PayId reservoir.orphanPayment 72h link ---------> txid -------------> payid ---------> unverifiedItem \|________________\|___________________\|_____________________\| PendingTransfer UnverifiedTxIndex UnverifiedTxEntries * Purpose *** PendingTransfer: indexed by link so that duplicate transfers can be detected data is the tx id so that the same transfer repeated can be distinguished from an invalid duplicate transfer UnverifiedTxIndex & UnverifiedTxEntries: unverified transaction (issue and transfer) VerifiedTx: verified transaction (issue and transfer) OrphanPayment: when possible payment is already found, but no transfer transaction is received yet put the payment in the pool to wait for	Package cache maintains the memory data store *** Data Structure * Pool Key Value ExpiresAfter \|___ PendingTransfer merkle.Digest (link) merkle.Digest (txid) 72h \|___ UnverifiedTxIndex merkle.Digest (txid) pay.PayId 72h \|___ UnverifiedTxEntries pay.PayId reservoir.unverifiedItem 72h \|___ VerifiedTx merkle.Digest (txid) reservoir.verifiedItem never \|___ OrphanPayment pay.PayId reservoir.orphanPayment 72h link ---------> txid -------------> payid ---------> unverifiedItem \|________________\|___________________\|_____________________\| PendingTransfer UnverifiedTxIndex UnverifiedTxEntries * Purpose *** PendingTransfer: indexed by link so that duplicate transfers can be detected data is the tx id so that the same transfer repeated can be distinguished from an invalid duplicate transfer UnverifiedTxIndex & UnverifiedTxEntries: unverified transaction (issue and transfer) VerifiedTx: verified transaction (issue and transfer) OrphanPayment: when possible payment is already found, but no transfer transaction is received yet put the payment in the pool to wait for
chain simple module to list the supported chains	simple module to list the supported chains
command
bitmark-cli to issue basic commands to a bitmarkd	to issue basic commands to a bitmarkd
bitmark-cli/configuration
bitmark-cli/encrypt
bitmark-cli/rpccalls
bitmark-dumpdb
bitmark-info
bitmarkd bitmarkd main program	bitmarkd main program
recorderd Proof-of-work program for bitmark system This program subscribes to potential blocks stream on a bitmarkd and determines an argon2 hash value that meets the current network difficulty value.	Proof-of-work program for bitmark system This program subscribes to potential blocks stream on a bitmarkd and determines an argon2 hash value that meets the current network difficulty value.
configuration parse a ucl configuration file The configuration supports variable expansion: ${VAR} variable provided bu optional map ${ENV_VAR} all environment variables are prefix with ENV_ However, if the VAR is undefined then the text is not expanded and remains as "${VAR}" which is normally not wanted.	parse a ucl configuration file The configuration supports variable expansion: ${VAR} variable provided bu optional map ${ENV_VAR} all environment variables are prefix with ENV_ However, if the VAR is undefined then the text is not expanded and remains as "${VAR}" which is normally not wanted.
constants constants that could be tuned	constants that could be tuned
counter thread safe counter	thread safe counter
currency types and functions for converting currencies to/from enumeration values	types and functions for converting currencies to/from enumeration values
bitcoin to validate bitcoin addresses	to validate bitcoin addresses
litecoin to validate litecoin addresses	to validate litecoin addresses
satoshi to convert satoshi values to integers	to convert satoshi values to integers
difficulty Implement the Bitcoin difficulty value and its various encodings	Implement the Bitcoin difficulty value and its various encodings
filters
fault error instances Provides a single instance of errors to allow easy comparison without having to resort to partial string matches	error instances Provides a single instance of errors to allow easy comparison without having to resort to partial string matches
genesis live and test genesis blocks	live and test genesis blocks
keypair
merkle merkle tree manipulation routines	merkle tree manipulation routines
messagebus a queue system to transfer transactions	a queue system to transfer transactions
mode simple module to record the global running mode	simple module to record the global running mode
ownership this handles low-level access to the ownership data in storage pool	this handles low-level access to the ownership data in storage pool
pay miscellaneous type for payment	miscellaneous type for payment
payment control of payment verification	control of payment verification
peer this module handles the peer to peer network server-side: * upstream sending of block, transactions * listener for RPC requests e.g.	this module handles the peer to peer network server-side: * upstream sending of block, transactions * listener for RPC requests e.g.
upstream maintain REQ/REP connection to clients this allow for push of blocks, transactions...	maintain REQ/REP connection to clients this allow for push of blocks, transactions...
proof prepare blocks for prooferd	prepare blocks for prooferd
publish this module handles publishing of events for add-on services e.g.	this module handles publishing of events for add-on services e.g.
reservoir Cache for transactions that have been verified	Cache for transactions that have been verified
rpc this is to setup and handle all of the incoming JSON RPC requests from clients requiring bitmarkd services standard golang RPC services can be used on the client side to access these services	this is to setup and handle all of the incoming JSON RPC requests from clients requiring bitmarkd services standard golang RPC services can be used on the client side to access these services
storage maintain the on-disk data store maintain separate pools of a number of elements in key->value form This maintains a LevelDB database split into a series of tables.	maintain the on-disk data store maintain separate pools of a number of elements in key->value form This maintains a LevelDB database split into a series of tables.
transactionrecord the structure of the transaction records includes functions to pack/unpack []byte form	the structure of the transaction records includes functions to pack/unpack []byte form
util miscellaneous small routines	miscellaneous small routines
zmqutil various comm ZMq routines shared be all commands	various comm ZMq routines shared be all commands