Remove upstream tests, docs, examples, dev env and release tooling
Replace upstream's README with a short one for this fork, and add docs/fork-maintenance.md describing what was removed and how to maintain the rest. Keeps helper/update-fixed-output-derivation.sh for pkgs/mempool/generate.sh. There is no test suite. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,46 +0,0 @@
|
||||
#!/usr/bin/env nix-shell
|
||||
#!nix-shell -i bash -p bash coreutils curl jq gnupg gnugrep
|
||||
set -euo pipefail
|
||||
|
||||
scriptDir=$(cd "${BASH_SOURCE[0]%/*}" && pwd)
|
||||
|
||||
trap 'echo "Error at ${BASH_SOURCE[0]}:$LINENO"' ERR
|
||||
|
||||
repo=fort-nix/nix-bitcoin
|
||||
if [[ ! -v version ]]; then
|
||||
version=$(curl -fsS "https://api.github.com/repos/$repo/releases/latest" | jq -r '.tag_name' | tail -c +2)
|
||||
fi
|
||||
|
||||
TMPDIR=$(mktemp -d)
|
||||
trap 'rm -rf $TMPDIR' EXIT
|
||||
|
||||
export GNUPGHOME=$TMPDIR/gpg-home
|
||||
mkdir -m 700 "$GNUPGHOME"
|
||||
|
||||
# Import key
|
||||
gpg --import "$scriptDir/key-jonasnick.bin" &> /dev/null
|
||||
# Check that exactly one key was imported
|
||||
(($(gpg --list-keys --with-colons | grep -c pub) == 1))
|
||||
# Verify key fingerprint
|
||||
gpg --list-keys "36C7 1A37 C9D9 88BD E825 08D9 B1A7 0E4F 8DCD 0366" > /dev/null
|
||||
|
||||
# Fetch nar-hash of release
|
||||
cd "$TMPDIR"
|
||||
baseUrl=https://github.com/$repo/releases/download/v$version
|
||||
curl -fsS -L -O "$baseUrl/nar-hash.txt"
|
||||
curl -fsS -L -O "$baseUrl/nar-hash.txt.asc"
|
||||
|
||||
# Verify signature for nar-hash
|
||||
gpg --verify nar-hash.txt.asc nar-hash.txt &> /dev/null || {
|
||||
>&2 echo "Error: Signature verification failed. Please open an issue in the project repository."
|
||||
exit 1
|
||||
}
|
||||
|
||||
>&2 echo "Fetched and verified release $version"
|
||||
|
||||
cat <<EOF
|
||||
builtins.fetchTarball {
|
||||
url = "https://github.com/$repo/archive/v$version.tar.gz";
|
||||
sha256 = "$(cat nar-hash.txt)";
|
||||
}
|
||||
EOF
|
||||
Binary file not shown.
@@ -1,159 +0,0 @@
|
||||
{ configDir, shellVersion ? null, extraShellInitCmds ? (pkgs: "") }:
|
||||
let
|
||||
pinned = import ../pkgs/nixpkgs-pinned.nix;
|
||||
pkgs = import nixpkgs { config = {}; overlays = []; };
|
||||
inherit (pkgs) lib;
|
||||
inherit (pinned) nixpkgs;
|
||||
nbPkgs = import ../pkgs { inherit pkgs; };
|
||||
cfgDir = toString configDir;
|
||||
setPath = lib.optionalString pkgs.stdenv.isLinux ''
|
||||
export PATH="${lib.makeBinPath [ nbPkgs.pinned.extra-container ]}''${PATH:+:}$PATH"
|
||||
'';
|
||||
in
|
||||
pkgs.stdenv.mkDerivation {
|
||||
name = "nix-bitcoin-environment";
|
||||
|
||||
helpMessage = ''
|
||||
nix-bitcoin path: ${toString ../.}
|
||||
|
||||
Available commands
|
||||
==================
|
||||
deploy
|
||||
Run krops-deploy and eval-config in parallel.
|
||||
This ensures that eval failures appear quickly when deploying.
|
||||
In this case, deployment is stopped.
|
||||
|
||||
krops-deploy
|
||||
Deploy your node via krops
|
||||
|
||||
eval-config
|
||||
Evaluate your node system configuration
|
||||
|
||||
build-config
|
||||
Build your node system on your local machine
|
||||
|
||||
generate-secrets
|
||||
Create secrets required by your node configuration.
|
||||
Secrets are written to ./secrets/
|
||||
This function is automatically called by krops-deploy.
|
||||
|
||||
update-nix-bitcoin
|
||||
Fetch and use the latest version of nix-bitcoin
|
||||
'';
|
||||
|
||||
shellHook = ''
|
||||
export NIX_PATH="nixpkgs=${nixpkgs}:nix-bitcoin=${toString ../.}:."
|
||||
${setPath}
|
||||
export NIX_BITCOIN_EXAMPLES_DIR="${cfgDir}"
|
||||
export nixpkgsUnstable="${pinned.nixpkgs-unstable}"
|
||||
|
||||
# Set isInteractive=1 if
|
||||
# 1. stdout is a TTY, i.e. we're not piping the output
|
||||
# 2. the shell is interactive
|
||||
if [[ -t 1 && $- == *i* ]]; then isInteractive=1; else isInteractive=; fi
|
||||
|
||||
# Make this a non-environment var
|
||||
export -n helpMessage
|
||||
|
||||
help() { echo "$helpMessage"; }
|
||||
h() { help; }
|
||||
|
||||
fetch-release() {
|
||||
${toString ./fetch-release}
|
||||
}
|
||||
|
||||
update-nix-bitcoin() {(
|
||||
set -euo pipefail
|
||||
releaseFile="${cfgDir}/nix-bitcoin-release.nix"
|
||||
current=$(cat "$releaseFile" 2>/dev/null || true)
|
||||
new=$(fetch-release)
|
||||
if [[ $new == $current ]]; then
|
||||
echo "nix-bitcoin-release.nix already contains the latest release"
|
||||
else
|
||||
echo "$new" > "$releaseFile"
|
||||
echo "Updated nix-bitcoin-release.nix"
|
||||
if [[ $isInteractive ]]; then
|
||||
exec nix-shell
|
||||
fi
|
||||
fi
|
||||
)}
|
||||
|
||||
generate-secrets() {(
|
||||
set -euo pipefail
|
||||
config="${cfgDir}/krops/krops-configuration.nix"
|
||||
if [[ ! -e $config ]]; then
|
||||
config="${cfgDir}/configuration.nix"
|
||||
fi
|
||||
genSecrets=$(nix-build --no-out-link -I nixos-config="$config" \
|
||||
'<nixpkgs/nixos>' -A config.nix-bitcoin.generateSecretsScript)
|
||||
mkdir -p "${cfgDir}/secrets"
|
||||
(cd "${cfgDir}/secrets"; $genSecrets)
|
||||
)}
|
||||
|
||||
deploy() {(
|
||||
set -euo pipefail
|
||||
krops-deploy &
|
||||
kropsPid=$!
|
||||
if eval-config; then
|
||||
wait $kropsPid
|
||||
else
|
||||
# Kill all subprocesses
|
||||
kill $(pidClosure $kropsPid)
|
||||
return 1
|
||||
fi
|
||||
)}
|
||||
|
||||
krops-deploy() {(
|
||||
set -euo pipefail
|
||||
generate-secrets
|
||||
# Ensure strict permissions on secrets/ directory before rsyncing it to
|
||||
# the target machine
|
||||
chmod 700 "${cfgDir}/secrets"
|
||||
$(nix-build --no-out-link "${cfgDir}/krops/deploy.nix")
|
||||
)}
|
||||
|
||||
eval-config() {(
|
||||
set -euo pipefail
|
||||
system=$(getNodeSystem)
|
||||
NIXOS_CONFIG="${cfgDir}/krops/krops-configuration.nix" \
|
||||
nix-instantiate --eval ${nixpkgs}/nixos $system -A system.outPath | tr -d '"'
|
||||
echo
|
||||
)}
|
||||
|
||||
build-config() {(
|
||||
set -euo pipefail
|
||||
system=$(getNodeSystem)
|
||||
NIXOS_CONFIG="${cfgDir}/krops/krops-configuration.nix" \
|
||||
nix-build --no-out-link ${nixpkgs}/nixos $system -A system
|
||||
)}
|
||||
|
||||
getNodeSystem() {
|
||||
if [[ -e '${cfgDir}/krops/system' ]]; then
|
||||
echo -n "--argstr system "; cat '${cfgDir}/krops/system'
|
||||
elif [[ $OSTYPE == darwin* ]]; then
|
||||
# On macOS, `builtins.currentSystem` (`*-darwin`) can never equal
|
||||
# the node system (`*-linux`), so we can always provide a helpful error message:
|
||||
>&2 echo "Error, node system not set. See here how to fix this:"
|
||||
>&2 echo "https://github.com/fort-nix/nix-bitcoin/blob/master/docs/install.md#optional-specify-the-system-of-your-node"
|
||||
return 1
|
||||
fi
|
||||
};
|
||||
|
||||
pidClosure() {
|
||||
echo "$1"
|
||||
for pid in $(ps -o pid= --ppid "$1"); do
|
||||
pidClosure "$pid"
|
||||
done
|
||||
}
|
||||
|
||||
if [[ $isInteractive ]]; then
|
||||
${pkgs.figlet}/bin/figlet "nix-bitcoin"
|
||||
echo 'Enter "h" or "help" for documentation.'
|
||||
fi
|
||||
|
||||
# Don't run this hook when another nix-shell is run inside this shell
|
||||
unset shellHook
|
||||
|
||||
${extraShellInitCmds pkgs}
|
||||
'';
|
||||
}
|
||||
@@ -1,119 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
REPO=fort-nix/nix-bitcoin
|
||||
BRANCH=master
|
||||
GIT_REMOTE=origin
|
||||
OAUTH_TOKEN=
|
||||
DRY_RUN=
|
||||
releaseVersion=
|
||||
|
||||
trap 'echo "Error at ${BASH_SOURCE[0]}:$LINENO"' ERR
|
||||
|
||||
cd "${BASH_SOURCE[0]%/*}"
|
||||
|
||||
for arg in "$@"; do
|
||||
case $arg in
|
||||
--dry-run|-n)
|
||||
DRY_RUN=1
|
||||
;;
|
||||
*)
|
||||
releaseVersion="$arg"
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
latestVersion=$(curl -fsS https://api.github.com/repos/$REPO/releases/latest | jq -r '.tag_name' | tail -c +2)
|
||||
|
||||
if [[ ! $releaseVersion ]]; then
|
||||
# Increment the lowest/last part of `latestVersion`
|
||||
releaseVersion=$(echo "$latestVersion" | awk -F. '/[0-9]+\./{$NF++;print}' OFS=.)
|
||||
fi
|
||||
|
||||
if [[ $DRY_RUN ]]; then
|
||||
echo "Dry run"
|
||||
else
|
||||
OAUTH_TOKEN=$(pass show nix-bitcoin/github/oauth-token)
|
||||
if [[ ! $OAUTH_TOKEN ]]; then
|
||||
echo "Error fetching OAUTH_TOKEN"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "Latest release: $latestVersion"
|
||||
|
||||
if [[ ! $DRY_RUN ]]; then
|
||||
while true; do
|
||||
read -rp "Create release ${releaseVersion}? [yn] " yn
|
||||
case $yn in
|
||||
[Yy]* ) break;;
|
||||
[Nn]* ) exit;;
|
||||
* ) echo "Please answer y or n.";;
|
||||
esac
|
||||
done
|
||||
fi
|
||||
|
||||
nixosVersion=$(sed -nE 's|.*system.stateVersion = "(.*?)".*|\1|p' ../examples/configuration.nix)
|
||||
if [[ ! $nixosVersion ]]; then
|
||||
echo "Error fetching NixOS version"
|
||||
exit 1
|
||||
fi
|
||||
nixosVersionBranch=nixos-$nixosVersion
|
||||
|
||||
TMPDIR=$(mktemp -d)
|
||||
if [[ ! $DRY_RUN ]]; then trap 'rm -rf $TMPDIR' EXIT; fi
|
||||
ARCHIVE_NAME=nix-bitcoin-$releaseVersion.tar.gz
|
||||
ARCHIVE=$TMPDIR/$ARCHIVE_NAME
|
||||
|
||||
# Need to be in the repo root directory for archiving
|
||||
(cd "$(git rev-parse --show-toplevel)"; git archive --format=tar.gz -o "$ARCHIVE" "$BRANCH")
|
||||
|
||||
SHA256SUMS=$TMPDIR/SHA256SUMS.txt
|
||||
# Use relative path with sha256sums because it'll output the first
|
||||
# argument
|
||||
(cd "$TMPDIR"; sha256sum "$ARCHIVE_NAME" > "$SHA256SUMS")
|
||||
gpg -o "$SHA256SUMS.asc" -a --detach-sig "$SHA256SUMS"
|
||||
|
||||
pushd "$TMPDIR" >/dev/null
|
||||
|
||||
nix hash to-sri --type sha256 "$(nix-prefetch-url --unpack "file://$ARCHIVE" 2> /dev/null)" > nar-hash.txt
|
||||
gpg -o nar-hash.txt.asc -a --detach-sig nar-hash.txt
|
||||
|
||||
if [[ $DRY_RUN ]]; then
|
||||
echo "Created v$releaseVersion in $TMPDIR"
|
||||
echo "NixOS version branch: $nixosVersionBranch"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
#―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
|
||||
# Create release
|
||||
|
||||
POST_DATA="{ \"tag_name\": \"v$releaseVersion\", \"name\": \"nix-bitcoin-$releaseVersion\", \"body\": \"nix-bitcoin-$releaseVersion\", \"target_comitish\": \"$BRANCH\" }"
|
||||
RESPONSE=$(curl -fsS -H "Authorization: token $OAUTH_TOKEN" -d "$POST_DATA" https://api.github.com/repos/$REPO/releases)
|
||||
ID=$(echo "$RESPONSE" | jq -r '.id')
|
||||
if [[ $ID == null ]]; then
|
||||
echo "Failed to create release with $POST_DATA"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
post_asset() {
|
||||
GH_ASSET="https://uploads.github.com/repos/$REPO/releases/$ID/assets?name="
|
||||
curl -fsS -H "Authorization: token $OAUTH_TOKEN" --data-binary "@$1" -H "Content-Type: application/octet-stream" \
|
||||
"$GH_ASSET/$(basename "$1")"
|
||||
}
|
||||
post_asset nar-hash.txt
|
||||
post_asset nar-hash.txt.asc
|
||||
# Post additional assets for backwards compatibility.
|
||||
# This allows older nix-bitcoin installations to upgrade via `fetch-release`.
|
||||
post_asset "$ARCHIVE"
|
||||
post_asset "$SHA256SUMS"
|
||||
post_asset "$SHA256SUMS.asc"
|
||||
|
||||
popd >/dev/null
|
||||
|
||||
if [[ ! $DRY_RUN ]]; then
|
||||
git push "$GIT_REMOTE" "$BRANCH:release"
|
||||
git push "$GIT_REMOTE" "$BRANCH:$nixosVersionBranch"
|
||||
fi
|
||||
|
||||
echo "Successfully created" "$(echo "$POST_DATA" | jq -r .tag_name)"
|
||||
@@ -1,20 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Usage:
|
||||
# source "path/to/run-in-nix-env" "pkg1 pkg2 ..." "$@"
|
||||
#
|
||||
# Runs the calling script with pkgs1, pkg2, ... in PATH.
|
||||
# The packages are sourced from the nixpkgs input of the nix-bitcoin root flake.
|
||||
|
||||
if [[ ${_NIX_BITCOIN_ENV_PKGS:-} != "$1" ]]; then
|
||||
export _NIX_BITCOIN_ENV_PKGS=$1
|
||||
shift
|
||||
|
||||
_shell_pkgs=()
|
||||
for _pkg in $_NIX_BITCOIN_ENV_PKGS; do
|
||||
_shell_pkgs+=("nixpkgs#$_pkg")
|
||||
done
|
||||
# BASH_SOURCE[0] is this file
|
||||
# BASH_SOURCE[-1] is the root src file
|
||||
exec nix shell --inputs-from "${BASH_SOURCE[0]%/*}/.." "${_shell_pkgs[@]}" -c "${BASH_SOURCE[-1]}" "$@"
|
||||
fi
|
||||
@@ -1,12 +0,0 @@
|
||||
# Start an interactive bash session in the current bash environment.
|
||||
# This is helpful for debugging bash scripts like pkg update scripts,
|
||||
# by adding `source <path-to>/start-bash-session.sh` at the location to
|
||||
# be inspected.
|
||||
|
||||
|
||||
# BASH_ENVIRONMENT contains definitions of read-only variables like 'BASHOPTS' that
|
||||
# cause warnings on evaluation. Suppress these warnings while sourcing.
|
||||
#
|
||||
# shellcheck disable=SC2016
|
||||
BASH_ENVIRONMENT=<(declare -p; declare -pf) \
|
||||
bash --rcfile <(echo 'source $BASH_ENVIRONMENT 2>/dev/null')
|
||||
Reference in New Issue
Block a user