Eng_wasm crate documentation

[levackt]

forum post

Hi. I was wondering why the eng_wasm, eng_wasm_derive, etc crates are not documented, for example on crates.io? Can documentation for these crates be expected soon?
I have appreciated your tutorials and guides, but there is no replacing documentation at the crate level.

For example, when there is a wildcard use statement like use eng_wasm::*; and then there are references to mysterious types like H160 without documentation it is hard to know what is going on, how to manage type conversions, etc.

Looking forward to this crate documentation! Thx.

Have responded with link to the supported types, are crate docs being considered too?
Not sure where the repo is to confirm, but we may only need to run rustdoc to generate the docs before release.

[levackt]

There's a follow up, not sure how best to respond to this one yet. @ainsleys

Thanks, @taariq . Those docs are a helpful start.

While we are waiting for more complete crate docs, one thing I am not sure how to handle are Results with Engima secret contracts.

I would like to follow a good Result and Error pattern, but I am getting a compiler error:

the trait "eng_wasm::eng_pwasm_abi::eth::AbiType" is not implemented for "core::result::Result<(), TGError>"

Can you provide a description of proper error handling and return values in secret contracts? I could not find anything in the docs or this forum about that. Thx.

[ainsleys]

Thanks for flagging this @levackt . @lacabra and I had discussed crates documentation before but we haven't come to a conclusion yet. I've raised this on the internal questions channel and hopefully we come up with a plan soon. We are also working on a more comprehensive guide to secret state / storage with enigma that can hopefully help these issues. @jlwaugh is helping with this.

EDIT : I see this issue is more specific to rust crates and not really about storage. My mistake -- will find the pertinent comment and add it there.

[ainsleys]

Just an update on here -- we've spoken w/ the engineers who would be responsible for adding documentation on the crate and should have an update next week. I'll let the user know we're on it.