chore: add flake.nix including developer shell

[aldur]

Description

As someone who was configuring how to build this project for the first time, I thought it would be useful to have an easy way to install all build dependencies at once. I gave this a shot with nix.

The result is that if you have nix installed and configured, you can run nix develop to enter a shell having all dependencies installed. Well, all except Smithy, who doesn't have a nix package yet.

Closes: NA

Changes

• Add flake.nix for development shells.

Testing Information

• Install nix
• Make sure you have flakes enabled (the installer linked above takes care of it, else see here)
• Run nix develop

Checklist:

• I have performed a self-review of my code
• My changes generate no new warnings
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[cylewitruk]

Could you also update the repo readme with information on its (optional) use in the development workflow?

[cylewitruk]

Lgtm, but I'll tag @djordon and @matteojug for their opinions as well.

@aldur It might be worth taking an hour and writing a package for Smithy? I've never done it, but it doesn't look too involved?

Have you tried the main make commands with the nix shell, do they all work (after installing Smithy manually)?

[AshtonStephens]

Hey! Smithy shouldn't be used here anymore because we switched to using rust annotations to generate the Emily API template. Where are we needing this?

[djordon]

This looks good. I don't think we use Smithy anymore so I wouldn't worry about adding it, but I'd wait for @AshtonStephens to verify.

[aldur]

Oh, I wish I had read your comments before 7b8075c. I can make another commit and remove smithy from the README as well?

[AshtonStephens]

Yeah I'm sorry, I should have updated the readme at the same time as I removed it. Though, smithy is used to generate some of the CLIs that we pull in as crates - I'd assume there's not dependency on smithy for those but I'm wondering if you somehow got smithy related errors

[aldur]

Yeah I'm sorry, I should have updated the readme at the same time as I removed it. Though, smithy is used to generate some of the CLIs that we pull in as crates - I'd assume there's not dependency on smithy for those but I'm wondering if you somehow got smithy related errors

Oh no I didn't (and was wondering why :)), but I still wanted to provide a full package.

[aldur]

Have you tried the main make commands with the nix shell, do they all work (after installing Smithy manually)?

Yep, they all run. Three integration tests fail, but that does not seem related to my changes:

running 3 tests
test validation::minimal_push_check ... FAILED
test validation::op_csv_disabled ... FAILED
test validation::tx_validation_from_mempool ... FAILED

failures:

---- validation::minimal_push_check stdout ----
thread 'validation::minimal_push_check' panicked at sbtc/src/testing/regtest.rs:113:18:
called `Result::unwrap()` on an `Err` value: JsonRpc(Transport(SocketError(Os { code: 61, kind: ConnectionRefused, message: "Connection refused" })))
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

---- validation::op_csv_disabled stdout ----
thread 'validation::op_csv_disabled' panicked at sbtc/src/testing/regtest.rs:113:18:
called `Result::unwrap()` on an `Err` value: JsonRpc(Transport(SocketError(Os { code: 61, kind: ConnectionRefused, message: "Connection refused" })))

---- validation::tx_validation_from_mempool stdout ----
thread 'validation::tx_validation_from_mempool' panicked at sbtc/src/testing/regtest.rs:113:18:
called `Result::unwrap()` on an `Err` value: JsonRpc(Transport(SocketError(Os { code: 61, kind: ConnectionRefused, message: "Connection refused" })))


failures:
    validation::minimal_push_check
    validation::op_csv_disabled
    validation::tx_validation_from_mempool

test result: FAILED. 0 passed; 3 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.02s

...but on the fact that I was not running Docker and the required services 🤦 fixing that.

Confirmed, they all run.

[cylewitruk]

but that does not seem related to my changes

Yeah, you didn't change anything there so that's unrelated to you.

The PR author gets the honors of clicking "Squash and merge" in this repo :)

[cylewitruk]

merged commit 2059739 into main

Wow, not every day you get to see a fully-numeric commit hash (prefix) :)