Questions about sv2_ffi crate

[plebhash]

While planning our strategic roadmap, @Fi3 mentioned FFI needs to be updated.

Also, I'm working on the documentation effort described on #845

This Github Discussion is meant to collect info (Q&A) for those tasks

[plebhash]

@Fi3 you mentioned this:

sv2 ffi needs to be updated also we don't expose everything

can you elaborate?
which APIs are currently being exposed, but shouldn't?

[Fi3]

We currently expose:

[dependencies]
codec_sv2 = { path = "../../../protocols/v2/codec-sv2", version = "^1.0.0" }
const_sv2 = { path = "../../../protocols/v2/const-sv2", version = "^1.0.0" }
binary_sv2 = { path = "../../../protocols/v2/binary-sv2/binary-sv2", version = "^1.0.0" }
common_messages_sv2 = { path = "../../../protocols/v2/subprotocols/common-messages", version = "^1.0.0" }
template_distribution_sv2 = { path = "../../../protocols/v2/subprotocols/template-distribution", version = "^1.0.0" }

from https://github.com/stratum-mining/stratum/blob/cffbe5cf70d2aedbdbe0b6c9152140f0b505a3af/protocols/v2/sv2-ffi/Cargo.toml

This is the stricter subset of the SRI core libs to run a TP. That cause this crate was initially intended to be imported in bitcoin core so the requirement were: (1) less code possible to review (2) no external dependency. As you can see there is no noise functionality here, that because in the first draft of the Sv2 specification the TP wasn't supposed to support an encrypted connection.

[plebhash]

ahh ok, I think I originally misunderstood your phrase!

I was thinking that we needed to reduce the number of APIs we are exposing, but it's actually the opposite: we need to expand! Is that correct?

so, is the goal to expose everything under protocols/v2?

[Fi3]

yep that what I was suggesting. Maybe we should discuss it, but to me seems the most natural thing to do.

[plebhash]

should we add a new example making use of these new crates?

[plebhash]

For future reference, this is an interesting resource for all-things Rust FFI:

https://nrc.github.io/big-book-ffi/intro.html

[Fi3]

here the instruction on how to use sv2-ffi crate:

https://github.com/stratum-mining/stratum/blob/main/examples/interop-cpp/README.md