Crates API and documentation about zk-nullifier-sig HOT 6 CLOSED

We should consider to release the crate with the traits which would define API and then use it in own implementations and enable foreign.

I'm not sure yet about downsides of this approach aside from some added complexity which would buy uniformity of all implementations. So counter arguments are welcome.

from zk-nullifier-sig.

I don't expect most people to use the crate anyways since it'll require custom logic to get the secret key in there and don't know any rust wallets.

Agree on adding docs and making name more uniform.

from zk-nullifier-sig.

from zk-nullifier-sig.

Got it -- that makes sense, I don't know anything about those. Traits seem fine to me -- the complexity shouldn't be that high on our side right, just implementing the trait twice? As long as almost everything is pub, I'm OK with that.

from zk-nullifier-sig.

Can you make a gitbook or mdbook and make this? Also, can you publish a cargo crate -- there should automatically be cargo docs from the docstrings right?

from zk-nullifier-sig.

Can you make a gitbook or mdbook and make this? Also, can you publish a cargo crate -- there should automatically be cargo docs from the docstrings right?

Yep. Here it's needed to groom the interfaces and write those docstring.

from zk-nullifier-sig.