rust-bitcoin-unsafe-fast/hashes/embedded
Andrew Poelstra 0aa539f836
hashes: remove engine/from_engine from embedded test
This commit illustrates the transformation I intend to make everywhere
we use newtyped hashes as "general hashes". *Within the module that the
newtype is defined* I encapsulate engine calls, which I do by calling
engine methods on the underlying general hash function. So within the
module there is a slight reduction in type safety, in the sense that I
need to make sure that I'm wrapping stuff properly.

But outside of the module, there will be no difference except that I
will no longer export engine/from_engine/hash/etc on newtyped hashes.
Instead callers will need to compute the newtyped hash only in ways
supported by the API.

In theory we could have a macro to produce engine/from_engine/etc for
newtypes that want to act as general hashes. But AFAICT there is no use
case for this.

Alternately, we could have a macro that produces *private* Engine types
and private engine/from_engine/etc methods for the hashes, which could
be used within the module and would provide stronger type safety within
the module. But in practice, raw hashing is usually only used within a
couple of methods, so all this infrastructure is way overkill and will
just make maintenance harder for everybody.
2024-06-24 13:51:23 +00:00
..
scripts ci: shellcheck checks 2024-05-11 18:08:53 +00:00
src hashes: remove engine/from_engine from embedded test 2024-06-24 13:51:23 +00:00
Cargo.toml Add bitcoin-units crate 2023-12-11 08:52:31 +11:00
README.md hashes/embedded: Add script dir and README 2023-07-18 10:27:48 +10:00
memory.x Import bitcoin_hashes crate into hashes 2022-11-08 08:58:09 +11:00

README.md

Running

To run the embedded test, first prepare your environment:

sudo ./scripts/install-deps
rustup +nightly target add thumbv7m-none-eabi

Then:

source ./scripts/env.sh && cargo +nightly run --target thumbv7m-none-eabi

Output should be something like:

hash:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad hash_check:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
hash:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad hash_check:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad

Cleanup

After sourcing scripts/env.sh and before building again using another target you'll want to unset RUSTFLAGS otherwise you'll get linker errors.

unset RUSTFLAGS