Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

skip auto download when BITCOIND_SKIP_DOWNLOAD is set #154

Merged
merged 3 commits into from
Apr 4, 2024
Merged

skip auto download when BITCOIND_SKIP_DOWNLOAD is set #154

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
138a55f
skip auto download when SKIP_DOWNLOAD is set
RCasatta Apr 2, 2024
a4c044e
document SKIP_DOWNLOAD
RCasatta Apr 2, 2024
0a35cb2
rename SKIP_DOWNLOAD -> BITCOIND_SKIP_DOWNLOAD
RCasatta Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ mod download {
}

pub(crate) fn start() -> anyhow::Result<()> {
if std::env::var_os("SKIP_DOWNLOAD").is_some() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's ok if we don't care about the SKIP_DOWNLOAD value? ie if SKIP_DOWNLOAD is set to "false" or 0 and we skip the download

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what I intended, caller can unset the var if it doesn't need it.
I can change it as preferred of course

return Ok(());
}
let download_filename = download_filename();
let expected_hash = get_expected_sha256(&download_filename)?;
let out_dir = std::env::var_os("OUT_DIR").unwrap();
Expand Down
9 changes: 8 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ pub enum Error {
/// Returned when -rpcuser and/or -rpcpassword is used in `Conf` args
/// It will soon be deprecated, please use -rpcauth instead
RpcUserAndPasswordUsed,
/// Returned when expecting an auto-downloaded executable but `SKIP_DOWNLOAD` env var is set
SkipDownload,
}

impl fmt::Debug for Error {
Expand All @@ -135,7 +137,8 @@ impl fmt::Debug for Error {
Error::NoBitcoindExecutableFound => write!(f, "`bitcoind` executable is required, provide it with one of the following: set env var `BITCOIND_EXE` or use a feature like \"22_1\" or have `bitcoind` executable in the `PATH`"),
Error::EarlyExit(e) => write!(f, "The bitcoind process terminated early with exit code {}", e),
Error::BothDirsSpecified => write!(f, "tempdir and staticdir cannot be enabled at same time in configuration options"),
Error::RpcUserAndPasswordUsed => write!(f, "`-rpcuser` and `-rpcpassword` cannot be used, it will be deprecated soon and it's recommended to use `-rpcauth` instead which works alongside with the default cookie authentication")
Error::RpcUserAndPasswordUsed => write!(f, "`-rpcuser` and `-rpcpassword` cannot be used, it will be deprecated soon and it's recommended to use `-rpcauth` instead which works alongside with the default cookie authentication"),
Error::SkipDownload => write!(f, "expecting an auto-downloaded executable but `SKIP_DOWNLOAD` env var is set"),
}
}
}
Expand Down Expand Up @@ -496,6 +499,10 @@ pub fn downloaded_exe_path() -> anyhow::Result<String> {
/// Provide the bitcoind executable path if a version feature has been specified
#[cfg(feature = "download")]
pub fn downloaded_exe_path() -> anyhow::Result<String> {
if std::env::var_os("SKIP_DOWNLOAD").is_some() {
return Err(Error::SkipDownload.into());
}

let mut path: PathBuf = env!("OUT_DIR").into();
path.push("bitcoin");
path.push(format!("bitcoin-{}", versions::VERSION));
Expand Down
Loading