Remove Node.js hooks, require ots CLI only
- Delete hooks/post-commit-node (local proofs only, no attestation) - Delete hooks/pre-commit-node (no upgrade support) - Update hooks/install.sh to require ots CLI (no fallback) - Update documentation with clear ots CLI requirement - Add prominent warnings about Node.js limitations Rationale: The @opentimestamps/ots Node.js package only creates local proofs without calendar submission or Bitcoin attestation. For tamper-evident timestamps, ots CLI is the only complete implementation. No partial/fallback implementations.
This commit is contained in:
Otto
parent
b1e305d831
commit
b4e2eb3c12
6 changed files with 203 additions and 357 deletions
|
|
@ -1,6 +1,6 @@
|
|||
#!/bin/bash
|
||||
# Git OpenTimestamp Hooks Installer
|
||||
# Detects available tools and installs matching hooks
|
||||
# Requires: opentimestamps-client (ots CLI)
|
||||
|
||||
set -e
|
||||
|
||||
|
|
@ -14,44 +14,35 @@ if ! git rev-parse --git-dir > /dev/null 2>&1; then
|
|||
exit 1
|
||||
fi
|
||||
|
||||
HOOKS_DIR="$(git rev-parse --git-dir)/hooks"
|
||||
MODE=""
|
||||
|
||||
# Detect available tools
|
||||
if command -v ots &> /dev/null; then
|
||||
MODE="ots"
|
||||
echo "Detected: ots CLI"
|
||||
elif command -v node &> /dev/null && node -e "require('@opentimestamps/ots')" &> /dev/null 2>&1; then
|
||||
MODE="node"
|
||||
echo "Detected: @opentimestamps/ots (Node.js)"
|
||||
echo "Note: Node version creates local proofs only (no calendar submission)"
|
||||
echo ""
|
||||
|
||||
# Install node package locally if not already present
|
||||
if [ ! -d "node_modules/@opentimestamps" ]; then
|
||||
echo "Installing @opentimestamps/ots locally..."
|
||||
npm install @opentimestamps/ots
|
||||
echo "✓ Package installed"
|
||||
fi
|
||||
else
|
||||
echo "Error: Neither ots CLI nor @opentimestamps/ots found" >&2
|
||||
echo "Install one of:" >&2
|
||||
echo " pipx install opentimestamps-client (recommended)" >&2
|
||||
echo " npm install @opentimestamps/ots (local proofs only)" >&2
|
||||
# Check for ots CLI (required)
|
||||
if ! command -v ots &> /dev/null; then
|
||||
echo "Error: ots CLI not found" >&2
|
||||
echo "" >&2
|
||||
echo "OpenTimestamp client is required for full Bitcoin attestation." >&2
|
||||
echo "Install with one of:" >&2
|
||||
echo "" >&2
|
||||
echo " # Recommended (isolated install)" >&2
|
||||
echo " pipx install opentimestamps-client" >&2
|
||||
echo "" >&2
|
||||
echo " # Or with pip" >&2
|
||||
echo " pip install opentimestamps-client" >&2
|
||||
echo "" >&2
|
||||
echo " # Or from source" >&2
|
||||
echo " git clone https://github.com/opentimestamps/opentimestamps-client" >&2
|
||||
echo " cd opentimestamps-client && pip install ." >&2
|
||||
echo "" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Installing $MODE hooks to: $HOOKS_DIR"
|
||||
echo "✓ Detected: ots CLI ($(ots --version))"
|
||||
|
||||
# Copy appropriate hooks
|
||||
if [ "$MODE" = "ots" ]; then
|
||||
cp "$SCRIPT_DIR/post-commit-ots" "$HOOKS_DIR/post-commit"
|
||||
cp "$SCRIPT_DIR/pre-commit-ots" "$HOOKS_DIR/pre-commit"
|
||||
else
|
||||
cp "$SCRIPT_DIR/post-commit-node" "$HOOKS_DIR/post-commit"
|
||||
cp "$SCRIPT_DIR/pre-commit-node" "$HOOKS_DIR/pre-commit"
|
||||
fi
|
||||
HOOKS_DIR="$(git rev-parse --git-dir)/hooks"
|
||||
|
||||
echo "Installing hooks to: $HOOKS_DIR"
|
||||
|
||||
# Copy ots hooks
|
||||
cp "$SCRIPT_DIR/post-commit-ots" "$HOOKS_DIR/post-commit"
|
||||
cp "$SCRIPT_DIR/pre-commit-ots" "$HOOKS_DIR/pre-commit"
|
||||
|
||||
chmod +x "$HOOKS_DIR/post-commit" "$HOOKS_DIR/pre-commit"
|
||||
|
||||
|
|
@ -61,29 +52,18 @@ echo "✓ Pre-commit backfill hook installed"
|
|||
# Setup .gitignore
|
||||
GITIGNORE=".gitignore"
|
||||
if [ ! -f "$GITIGNORE" ]; then
|
||||
cat > "$GITIGNORE" << 'EOF'
|
||||
.ots/.attestation-cache
|
||||
node_modules/
|
||||
EOF
|
||||
echo ".ots/.attestation-cache" > "$GITIGNORE"
|
||||
echo "✓ Created .gitignore"
|
||||
elif ! grep -q ".ots/.attestation-cache" "$GITIGNORE"; then
|
||||
echo ".ots/.attestation-cache" >> "$GITIGNORE"
|
||||
if [ "$MODE" = "node" ] && ! grep -q "node_modules/" "$GITIGNORE"; then
|
||||
echo "node_modules/" >> "$GITIGNORE"
|
||||
fi
|
||||
echo "✓ Updated .gitignore"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Mode: $MODE"
|
||||
if [ "$MODE" = "ots" ]; then
|
||||
echo " - Full Bitcoin attestation via calendars"
|
||||
echo " - Proofs submitted to remote calendars"
|
||||
else
|
||||
echo " - Local proofs only (no calendar submission)"
|
||||
echo " - For full attestation, use: pipx install opentimestamps-client"
|
||||
fi
|
||||
|
||||
echo "Configuration:"
|
||||
echo " - Full Bitcoin attestation via remote calendars"
|
||||
echo " - Proofs submitted to 4+ calendar servers"
|
||||
echo " - Attestation available after ~10 min (Bitcoin confirmation)"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo "1. Make a test commit"
|
||||
|
|
|
|||
|
|
@ -1,49 +0,0 @@
|
|||
#!/bin/bash
|
||||
# Git OpenTimestamp Post-Commit Hook (Node.js version)
|
||||
# Requires: @opentimestamps/ots (npm install)
|
||||
|
||||
set -e
|
||||
|
||||
OUTPUT_DIR=".ots"
|
||||
OUTPUT_FILE="$OUTPUT_DIR/proof.ots"
|
||||
|
||||
mkdir -p "$OUTPUT_DIR"
|
||||
|
||||
COMMIT_HASH=$(git rev-parse HEAD)
|
||||
|
||||
# Generate proof using Node.js
|
||||
node -e "
|
||||
const ots = require('@opentimestamps/ots');
|
||||
const fs = require('fs');
|
||||
const hash = '$COMMIT_HASH';
|
||||
const output = '$OUTPUT_FILE';
|
||||
const hashBuffer = Buffer.from(hash, 'hex');
|
||||
|
||||
ots.Timestamp.hash(hashBuffer).then(timestamp => {
|
||||
// Note: This creates a local proof only, not submitted to calendars
|
||||
// For full Bitcoin attestation, use the ots CLI version
|
||||
const proof = {
|
||||
hash: hash,
|
||||
timestamp: new Date().toISOString(),
|
||||
status: 'pending',
|
||||
note: 'Local proof only - use ots CLI for calendar submission'
|
||||
};
|
||||
fs.writeFileSync(output, JSON.stringify(proof, null, 2));
|
||||
console.log('[ots-node] Generated local proof: ' + hash.substring(0, 8));
|
||||
}).catch(err => {
|
||||
console.error('[ots-node] Error:', err.message);
|
||||
process.exit(1);
|
||||
});
|
||||
"
|
||||
|
||||
# Save previous commit for chaining
|
||||
PREV_COMMIT=$(git rev-parse HEAD^1 2>/dev/null || echo "")
|
||||
if [ -n "$PREV_COMMIT" ]; then
|
||||
echo "$PREV_COMMIT" > "$OUTPUT_DIR/prev-commit.txt"
|
||||
fi
|
||||
|
||||
# Create individual proof file (JSON format for node version)
|
||||
INDIVIDUAL_PROOF="$OUTPUT_DIR/${COMMIT_HASH}.ots"
|
||||
cp "$OUTPUT_FILE" "$INDIVIDUAL_PROOF"
|
||||
|
||||
echo "[ots-node] Proof generated successfully"
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
#!/bin/bash
|
||||
# Git OpenTimestamp Pre-Commit Backfill Hook (Node.js version)
|
||||
# Requires: @opentimestamps/ots (npm install)
|
||||
# Note: Node version only generates local proofs, no calendar submission
|
||||
|
||||
set -e
|
||||
|
||||
OUTPUT_DIR=".ots"
|
||||
STATUS_CACHE="$OUTPUT_DIR/.attestation-cache"
|
||||
|
||||
mkdir -p "$OUTPUT_DIR"
|
||||
|
||||
# Initialize cache
|
||||
if [ ! -f "$STATUS_CACHE" ]; then
|
||||
echo "# Format: commit-hash:status:timestamp" > "$STATUS_CACHE"
|
||||
fi
|
||||
|
||||
get_cached_status() {
|
||||
local commit="$1"
|
||||
local cache_line=$(grep "^$commit:" "$STATUS_CACHE" 2>/dev/null | tail -1)
|
||||
if [ -n "$cache_line" ]; then
|
||||
local status=$(echo "$cache_line" | cut -d: -f2)
|
||||
local timestamp=$(echo "$cache_line" | cut -d: -f3)
|
||||
local now=$(date +%s)
|
||||
if [ "$((now - timestamp))" -lt 3600 ]; then
|
||||
echo "$status"
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
cache_status() {
|
||||
local commit="$1"
|
||||
local status="$2"
|
||||
echo "$commit:$status:$(date +%s)" >> "$STATUS_CACHE"
|
||||
}
|
||||
|
||||
generate_proof_node() {
|
||||
local hash="$1"
|
||||
local output="$2"
|
||||
|
||||
node -e "
|
||||
const ots = require('@opentimestamps/ots');
|
||||
const fs = require('fs');
|
||||
const hash = '$hash';
|
||||
const output = '$output';
|
||||
const hashBuffer = Buffer.from(hash, 'hex');
|
||||
|
||||
ots.Timestamp.hash(hashBuffer).then(timestamp => {
|
||||
const proof = { hash: hash, timestamp: new Date().toISOString(), status: 'pending' };
|
||||
fs.writeFileSync(output, JSON.stringify(proof, null, 2));
|
||||
}).catch(err => { console.error('Error:', err); process.exit(1); });
|
||||
"
|
||||
}
|
||||
|
||||
echo "[ots-node] Backfilling proofs (local only, no calendar)..."
|
||||
|
||||
COMMITS=$(git rev-list --reverse HEAD)
|
||||
TOTAL=$(echo "$COMMITS" | wc -l)
|
||||
CURRENT=0
|
||||
UPDATED=0
|
||||
|
||||
for COMMIT in $COMMITS; do
|
||||
CURRENT=$((CURRENT + 1))
|
||||
PROOF_FILE="$OUTPUT_DIR/${COMMIT}.ots"
|
||||
|
||||
if [ $CURRENT -le 3 ] || [ $CURRENT -eq $TOTAL ]; then
|
||||
echo "[ots-node] Processing $CURRENT/$TOTAL: ${COMMIT:0:8}"
|
||||
elif [ $CURRENT -eq 4 ]; then
|
||||
echo "[ots-node] ... processing remaining ..."
|
||||
fi
|
||||
|
||||
if [ -f "$PROOF_FILE" ]; then
|
||||
# Node version doesn't support upgrade, just check cache
|
||||
CACHED_STATUS=$(get_cached_status "$COMMIT" || echo "")
|
||||
[ "$CACHED_STATUS" = "attested" ] && continue
|
||||
|
||||
# Mark as pending (node can't attest)
|
||||
cache_status "$COMMIT" "pending"
|
||||
else
|
||||
if generate_proof_node "$COMMIT" "$PROOF_FILE"; then
|
||||
cache_status "$COMMIT" "pending"
|
||||
UPDATED=$((UPDATED + 1))
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
# Update latest proof
|
||||
LATEST_COMMIT=$(git rev-parse HEAD)
|
||||
[ -f "$OUTPUT_DIR/${LATEST_COMMIT}.ots" ] && cp "$OUTPUT_DIR/${LATEST_COMMIT}.ots" "$OUTPUT_DIR/proof.ots"
|
||||
|
||||
# Save commit chain
|
||||
rm -f "$OUTPUT_DIR/commit-chain.txt"
|
||||
git rev-list HEAD | while read COMMIT; do
|
||||
PREV=$(git rev-parse ${COMMIT}^1 2>/dev/null || echo "")
|
||||
[ -n "$PREV" ] && echo "$COMMIT:$PREV" >> "$OUTPUT_DIR/commit-chain.txt"
|
||||
done
|
||||
|
||||
echo "[ots-node] Backfill complete: $UPDATED generated (local proofs only)"
|
||||
Loading…
Add table
Add a link
Reference in a new issue