gitmark
Getting Started
Introduction
Gitmark extends git to allow commits to be "marked" (using the command git mark
) by a supporting block chain. This "reinforces" or "finalizes" a given commit, to determine global consensus and a definitive project history
Installation
sudo npm install -g gitmark
Usage
git mark # marks the current commit
git mark [--genesis txoutput] # used for the genesis commit
Motivation
Gitmark, was originally created to facilitate the marking use case, which aims to allow global, distributed, reputation trees, to be grounded in a block chain
What is made possible, is a way to provide consensus on a definitive git branch/chain, in order to ensure that the history has not been tampered with
One can reconstruct the current state from the history, and this can also be used to preserve your reputation at any given time, say, if any provider ceases to operate
It's also possible to audit and verify the integrity of the git chain, to create a secure, finalized, state machine, with a definitive head, that is globally synced
The system can be extended beyond reputation trees, to use any git based store, and anchor it to a secure, verifyable chain of blocks, to determine the definitve history
Many thanks go to Peter Todd for his work on single use seals and Dr Maxim Orlovsky for his work on RGB
Gitmark is pre-alpha software, it should be considered experimental, and used at your own risk
Prerequisites
Because gitmark was designed to anchor reputation trees, the reputation of the underlying block chain must be unimpared. Gitmark only supports block chains that are provably fair. Bitcoin is regarded as the most secure and fairest of all block chains, and should be used for high value projects where cost is not an issue
Gitmark does not support projects that are premines, instamines, ICOs, have developer taxes or provably unfair consensus, such as proof of stake
In solving the reputation use case, we aim to innovate in the space, contribute back code, and operate as a testing ground
Bearing in mind that this is experimental software, the bitmark block chain, is the first chain on which gitmark is tested and implemented. As it inexpensive, easily obitained, and was designed for the grounding of reputation trees (gitmark is a play on the word bitmark). This also provides a testing ground for developers to get started. The Liquid network is also a possible target, and Litecoin appears to be another good possibility, as well as the various testnets
The first prerequisite is to obtain an unspent transaction on a supporting block chain. This can be in any coin, but to get started we suggest, getting hold of one Bitmark, which can be obtained inexpensively for example in the chat room as it is designed to be spread between helpful actors, to foster innovation
Getting started
After you have obtained some block chain currency, send those coins to an address for which you have the keypair. That becomes the genesis unspent transaction
Having created a genesis transaction, and recording the key pair safely, you are ready to start marking!
Install gitmark globally via npm, the executables will be in the bin directory which can be located with which git-mark
The genesis transaction provides the first input to the git mark
command, and the private key (secret exponent in hex) is needed to advance the genesis transaction in line with the current git HEAD
Git mark
Simply running git mark
on a repo will create your first marking
You will need a genesis address for the first run of the form tx:output
and supply that with the argument --genesis [tx]
You will also need the private key from that tx, which is an argument to the gitmark script, but can be also saved in a location as directed by the output from the git mark command. The key (ie 64 char hex secret exponent) should be stored in the indicated file with the json key "privkey"
Warning: do not use the default private key, that is set, in the script!
Git mark will generate a new address to send to, a fee, an amount, a spending private key and unspent tx data as inputs to an rpc or a simple script tx.sh
that lives in the bin directory. Future versions will use a transaction builder to send to a network directly
After running this script, an empty commit message is generated which you can check in, and points to the latest new unspent transaction, creating a two way link. The commit message is a gitmark URI
Congratulations! You have now marked your first git repo!
See also: Example Workflow
How it works
Gitmark simply uses single use seals to tweak the initial public key address of the genesis transaction by the commit hash of the git tree. The current git hash is added to the original, genesis, public key in the output transaction, creating a chain of commits in the block chain
In this way the block chain points to git. It then points the next commit back to the block chain tx, creating two way link, and therefore, strong binding, at one particular point in time
Similarly the definitive git tree forms a chain of commits that go forward in time, and so do the new transaction on the block chain. Further commits are periodically marked in time proving an auditable trail in both time on-chain of the evolution of the git tree. It also shows the latest confirmed state of a git tree that can be used for trading or in safe or smart contracts
The first use case for gitmark is marking of reputation trees, but it can be applied to any git system where the history is important
Recent git marks
Use Cases
- Distributed Reputation Trees
- Distributed Ledgers
- Registries
- Safe or Smart Contracts
- Asset Issuance
- Distributed Exchanges
- Reconstruct histories from Genesis
- Distributed Global Consensus
- Domain independent web sites
- Archiving and Time Travel through History
- Distributed Identity and PKI
- Federated Side Chains
- Auditing Histories
- Fraud Detection
- Supply Chains
Related work
Source code
Future work
-
Git marks can be extended to further layers by using git submodules hence creating almost unlimited space
-
Private git repositories can be supported out of the box, and given that private keys are used in each seal, encrypted backups can be made
-
The project git tree can be backed up or archived using git clone in multiple locations. It is natural that popular projects are cloned often in any case
-
Seals can be opened and closed using a federation, in order to try out multiple consensus and vefification methods
-
More robust verification frameworks can be built using node testing frameworks, and continusous integration, tho currently the distribution contains a git-mark-verify script
-
Lightweight Autonomous Marking Agents (LAMAs) can be created that listen to communities for marks and just work, without needing a human operator. The service can be deployed on a server or container, and be designed to bring itself up if it goes down in any one location
License
- MIT