Git repository guide¶
This guide describes how to link a Git repository to the Bitcoin blockchain via the mainstay.xyz connector service, in order to obtain a trustless proof of a unique single history of Git commits.
The guide is split into three distinct sections for setting up the linking, performing repository attestations by the permissioned entity and verification.
The entity responsible for attesting the sidechain state to Bitcoin is called the administrator. The administrator is responsible for the agreement with the mainstay.xyz service for exclusive use of a connector service slot. This is obtained by signing up on the mainstay.xyz website, where the administrator will be given a slot position
slot_id and an API access token to perform attestations
token via email. For additional security, the administrator can optionally require that all repository attestations committed to the slot are signed by an administrator private key (the corresponding public key being provided on sign-up at mainstay.xyz).
To generate this key, the administrator can use the Mainstay client. For example (where entroy is any string to add additional entropy to the keygen),
msc keygen -g entropy > Private key: c66cb6eb7cd585788b294be28c8dcd6be4e37a0a6d238236b11c0beb25833bb9
This generates a hex encoded 32-byte private key (
privkey). The corresponding public key can be generated as follows:
msc keygen -g c66cb6eb7cd585788b294be28c8dcd6be4e37a0a6d238236b11c0beb25833bb9 > Public key: 03fe0c17d00e5d5fc879dd1c2d4fbe3d61eb6d851ce3cd31173219aaf72e13fcd9
The generated public key is then supplied at sign-up. The private key is stored in the
msc config file.
Once the mainstay.xyz slot is active, the base staychain Bitcoin transaction ID can be retrived as follows (e.g. for
slot_id = 3):
msc info -s 3
If the slot has been activated (usually within an hour of sign-up completion), the base ID will be returned. E.g.
> Base ID: 420d083de8ab078dbba5ea37f877cb35dd621e34f231cce997a16cd241449d51:3
If not active, the the following message will be returned:
> Slot 7 not active.
Git repository configuration¶
The base ID (which is the staychain base TxID and slot ID) must then be committed to the start of the Git repository, to verifiably and uniquely link it to the slot. This is performed by performing the initial commit of the repository with the base ID as the comment.
First initialise a new Git repository in the chosen directory
Then perform the inital commit, with the base ID as comment. E.g.:
git add . git commit -m '420d083de8ab078dbba5ea37f877cb35dd621e34f231cce997a16cd241449d51:3'
The repository can then be shared, or uploaded to a remote service like github.com.
Each time the repository is updated with a new commit, the administrator can perform an attestation to the mainstay.xyz slot (this may require pulling the latest changes from a remote master). This requires a single call of
msc with the path of the repository supplied with the
-g argument of the
attest command. E.g.
msc attest -g repo_path -s 3 -t token
The previous steps are performed solely by the administrator. Verification can be performed by anyone who has access to the repository. The first step is to clone the repository to a directory
repo_path on the verifiers machine. The verifier also requires the Mainstay client installed (
msc) and RPC access to a full
bitcoind node (alternatively a trusted block-explorer API can be used).
The initial step in the verification process is to retrieve the full proof sequence for the slot to the base ID of the repository. This is done with the
fetch command and the
-g argument specifying the repository (and the
-s argument specifying the slot ID).
msc fetch -g repo_path -s 3
Which returns information on the attestation history. E.g.:
Git repo initial commit ID: 420d083de8ab078dbba5ea37f877cb35dd621e34f231cce997a16cd241449d51:3 Sequence length: 48 Start: 7 Feb 2020 11:34:41 End: 10 Feb 2020 00:21:01
This will retrieve the full proof sequence from the latest attestation to the base ID in the first commit of the repository. This sequence proof is saved in the msc data directory (which can be found by running
msc config). The sequence proof can also be saved to any other file using the additional
After fetching the sequence proof, it is then verified in two stages: 1. Verification that it is fully committed to the valid (i.e. single output) Bitcoin staychain in the specified slot position. 2. That the slot commitments correspond fully (and in order) to the Git repository commit sequence.
The first stage is performed with supplied
bitcoind RPC credentials and URL (as
-b) and the slot ID (
msc verify -s 3 -b username1:password1@localhost:8332 -p 0
-p 0 specifies that the sequence proof to be verified against Bitcoin is located in the data directory. Alternatively the path of the sequence proof can be provided (
-p proof_path). If the verification is successful, the client will return the latest sidechain verified block. For example:
Verified proof sequence against staychain base 420d083de8ab078dbba5ea37f877cb35dd621e34f231cce997a16cd241449d51 slot 3 Start commitment in block a883c7cb269fd5767aebdf60691eaf4056f36a84fca99ebb1c1632c511626b3c height 601563 at 7 Feb 2020 11:34:41 End commitment in block fa968812fb93f5c949d13021881179e4398582ef650dc1a9e975951f9d411906 height 601611 at 10 Feb 2020 00:21:01 End commitment txout unspent
In addition, the client will state whether the last (
End) commitment is in an unspent Bitcoin transaction. If it is not, there may be further commitments not reflected in the repository - this may be because a new attestation has been performed since the sequence proof was fetched. If this is the case, run
msc fetch -u -s 3 to update the update the sequence proof to the latest attestation, and repeat the verification. The stored sequence proof will then be updated to include the Bitcoin block heights of each attestation.
Once the validity of the full sequence proof against the Bitcoin blockchain has been established, the second stage of verification is to confirm that the sequence of commtiments to the specified slot position correspond to the Git repository in a single, unbroken sequence. This is performed by using the
verify command with the
-g argument specifying the repository path. E.g.
msc verify -s 3 -g repo_path
If verification is successful, the client will return:
Verified proof sequence against commit history to acb15cc7004caa5bd3069ee57072454bca62b0aa Verified Git commit history unique Base txid: 420d083de8ab078dbba5ea37f877cb35dd621e34f231cce997a16cd241449d51 slot: 3
The first line gives the latest repository commit that has been attested. The second line confirms that the base ID and slot position was committed to the beggining of the repository (i.e. it is unqiuely bound to the slot and staychain).
If additional commits have been made to the repository that are not part of the verified sequence proof, a warning is given. E.g.
WARNING: last 2 commits not attested.