gitmark 0.0.24 → 0.0.28

package/GENESIS.md

@@ -0,0 +1,49 @@
+## Genesis
+
+The genesis transaction output starts the chain of marks in git mark
+
+In order to start marking you will need a genesis transaction output
+
+This will also have a public address and a private key (secret exponent)
+
+You will need the transaction id and the secret exponent to start git marking
+
+One way to save the secret exponent is in git
+
+```
+git config gitmark.secret <secretexponent>
+```
+
+This is not terribly secure, but for small projects to get started it is convenient
+
+A useful way to generate an address and secret exponent would be:
+
+https://project-bitmark.github.io/brain/
+
+Use a very secure password for anything more than testing
+
+Once you have an address, send some coins there from a faucet, a friend, or by being marked
+
+The genesis id also doubles as the @id for a gitmark project
+
+Optionally it can be added a file, `gitmark.json` in the root directory of your repo
+
+It may look like this:
+
+```JSON
+{
+  "@id": "gitmark:b1fb9acb83f85887760b2e1a71e1df370976b1596be101bb0dbe8fd1c80f91cd:0",
+  "genesis": "gitmark:b1fb9acb83f85887760b2e1a71e1df370976b1596be101bb0dbe8fd1c80f91cd:0",
+  "nick": "myrepo",
+  "package": "./package.json",
+  "repository": "./"
+}
+```
+
+Once you have your genesis tx, you can make your first git mark by running, for example:
+
+```
+git mark --genesis b1fb9acb83f85887760b2e1a71e1df370976b1596be101bb0dbe8fd1c80f91cd:0
+```
+
+Do this after you have commited your first files, and as recommended a gitmark.json file too

package/README.md

@@ -93,6 +93,8 @@ After running this script, an empty commit message is generated which you can ch
 
 Congratulations! You have now marked your first git repo!
 
+See also: [Example Workflow](./WORKFLOW.md)
+
 ## How it works
 
 Gitmark simply uses [single use seals](https://petertodd.org/2017/scalable-single-use-seal-asset-transfer) 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

package/WORKFLOW.md

@@ -0,0 +1,44 @@
+## Example workflow
+
+1. Generate a [genesis](./GENESIS.md) address
+
+2. For example from here: https://project-bitmark.github.io/brain/
+
+3. Add funds to that address, from a faucet, from your coins, or by being marked
+
+4. Grab the transaction id of your new funds, that's the genesis of the mark chain, and also id of the git mark repo
+
+5. Commit your git tree
+
+6. [Optionally] add a gitmark.json e.g.
+
+```JSON
+{
+  "@id": "gitmark:b1fb9acb83f85887760b2e1a71e1df370976b1596be101bb0dbe8fd1c80f91cd:0",
+  "genesis": "gitmark:b1fb9acb83f85887760b2e1a71e1df370976b1596be101bb0dbe8fd1c80f91cd:0",
+  "nick": "myrepo",
+  "package": "./package.json",
+  "repository": "./"
+}
+```
+
+7. Commit gitmark.json
+
+8. Run:
+```
+git mark --genesis <txid:output>
+```
+
+9. Run the produced command to create a new tx
+
+10. If successful you will get a tx output which can be used in a tag or in a new commit message: 
+
+```
+git commit --allow-empty "<txid:output>
+```
+
+You are done! 
+
+You can now continue git marking as your project grows, and also push to whatever remotes that you have
+
+Full workflow is here for illustration.  Some or all of these steps can be automated, to make it a one click process

package/bin/git-mark

@@ -10,6 +10,7 @@ const gitlog = require('gitlog').default
 const fs = require('fs')
 const homedir = require('os').homedir()
 const exec = require('child_process').exec
+const $ = require('child_process').execSync
 const execSync = require('child_process').execSync
 
 // MODEL
@@ -176,7 +177,6 @@ var { address } = bitcoin.payments.p2pkh({
 })
 console.log('address computed from public', address)
 
-var fee = 1000
 var tx
 const gitmarkTxBase = homedir + '/.gitmark/tx'
 
@@ -185,6 +185,7 @@ try {
     tx = { total_output: '1', fees: '0.00001' }
   } else {
     tx = require(gitmarkTxBase + '/' + lastCommit[0] + '.json')
+    if (!tx.total_output) tx.total_output = tx.vout[0].value
   }
 } catch (e) {
   console.error(e)
@@ -198,14 +199,21 @@ try {
     '.json'
   )
   console.log('trying:')
-  var command = `curl "https://chainz.cryptoid.info/marks/api.dws?q=txinfo&t=${lastCommit[0]}" > ${gitmarkTxBase}/${lastCommit[0]}.json`
+  var explorerURI = $('git config gitmark.explorer || true').toString()?.replace('\n', '') || 'https://chainz.cryptoid.info/marks/api.dws?q=txinfo&t='
+
+  explorerURI = 'http://gitmark.me/'
+  var command = `curl "${explorerURI}${lastCommit[0]}.json" > ${gitmarkTxBase}/${lastCommit[0]}.json`
   console.log(command)
-  exec(command, console.log)
-  console.log('do not run more than once per 10s')
-  process.exit(-1)
+  $(command)
+  tx = JSON.parse(fs.readFileSync(gitmarkTxBase + '/' + lastCommit[0] + '.json').toString())
+  if (!tx.total_output) tx.total_output = tx.vout[0].value
+  // console.log('tx', tx)
+  // console.log('do not run more than once per 10s')
+  // process.exit(-1)
 }
 
-var nextfee = tx.total_output - tx.fees
+var fee = tx?.fees || 0.00001
+var nextfee = tx.total_output - fee
 nextfee = Math.round((nextfee + Number.EPSILON) * 100000000) / 100000000
 
 var priv = data.genesis ? b1 : b5

package/bin/git-mark-init

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+
+// USAGE: git-mark [privkeyhex] [$(git rev-parse HEAD)]
+
+// IMPORTS
+const bitcoin = require('bitcoinjs-lib')
+const tiny = require('tiny-secp256k1')
+const argv = require('minimist')(process.argv.slice(2))
+const gitlog = require('gitlog').default
+const fs = require('fs')
+const homedir = require('os').homedir()
+const exec = require('child_process').exec
+const $ = require('child_process').execSync
+const execSync = require('child_process').execSync
+
+// MODEL
+// default privkey = brain for urn:json:bitmark
+globalThis.data = {
+  address: null,
+  sshkey: '$HOME/.ssh/id_rsa',
+  salt: null,
+  secret: null,
+  genesistxo: null,
+  faucet: 'http://faucet.gitmark.me/'
+}
+
+// FUNCTIONS
+function getConfig(key) {
+  try {
+    var cmd = `git config ${key}`
+    var secret = execSync(cmd)?.toString()?.replace('\n', '')
+    return secret
+  } catch (e) {
+  }
+}
+
+function init(str) {
+  return argv[str] || getConfig('gitmark.' + str) || data[str]
+}
+
+// INIT
+let NETWORK = require('../lib/networks.js').BITMARK
+if (process.env.NETWORK) {
+  NETWORK = require('../lib/networks.js')[process.env.NETWORK] || NETWORK
+}
+console.log('NETWORK', NETWORK)
+
+data.address = init('address')
+data.sshkey = init('sshkey')
+data.salt = init('salt')
+data.secret = init('secret')
+data.genesistxo = init('genesistxo')
+data.faucet = init('faucet')
+
+
+console.log('data', data)
+
+// MAIN
+// check if already init
+console.log('checking if init already')
+// how
+// config
+// gitmark.json
+// commits
+
+function getNewSecret() {
+  try {
+    var sshkey = `$HOME/.ssh/id_rsa`
+    var cmd = `pwd | ssh-keygen -Y sign -f ${sshkey} -n gitmark - | sha256sum | head -c 64`
+    var newSecret = $(cmd).toString()
+    return newSecret
+  } catch {
+
+  }
+}
+
+// get secret
+// generate secret if none
+if (data.secret) {
+  console.log('no secret found')
+  var newsecret = getNewSecret()
+  console.log('newsecret', newsecret)
+  data.secret = newsecret
+
+
+  // var gen = $(`git config gitmark.secret $(git config--get remote.origin.url | ssh - keygen - Y sign - f ~/.ssh/id_rsa - n gitmark - | sha256sum | head - c 40)`)
+  // console.log(gen)
+
+}
+
+console.log('using secret', data.secret)
+
+// generate address from secret
+const POINT = Buffer.from(data.secret, 'hex')
+var keyPair1 = bitcoin.ECPair.fromPrivateKey(POINT)
+console.log('public keys hex buffer')
+console.log(keyPair1.publicKey)
+console.log('private keys hex')
+var { address } = bitcoin.payments.p2pkh({
+  pubkey: keyPair1.publicKey,
+  network: NETWORK
+})
+console.log('pubkey address computed from private', address)
+
+// todo: put all in config, if not there
+
+
+// get faucet
+console.log('faucet', data.faucet)
+
+// add to faucet
+console.log('type', address, 'into', data.faucet, 'and wait for tx to get in a block')
+
+// todo get tx value
+
+// todo print to screen
+
+// create gitmark.json
+console.log('create gitmark.json and check in files')
+
+// git mark genesis
+console.log('run git mark --genesis tx')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitmark",
-  "version": "0.0.24",
+  "version": "0.0.28",
   "description": "gitmark",
   "main": "index.js",
   "scripts": {
@@ -14,7 +14,8 @@
     "gitmark"
   ],
   "bin": {
-    "git-mark": "bin/git-mark"
+    "git-mark": "bin/git-mark",
+    "git-mark-init": "bin/git-mark-init"
   },
   "author": "Melvin Carvalho",
   "license": "MIT",