o1-labs / docs2

Docs website for the Mina Protocol.
https://docs.minaprotocol.com
79 stars 123 forks source link

DX: improve Mina Signer docs #544

Open barriebyron opened 1 year ago

barriebyron commented 1 year ago

zkIgnite Cohort 1 Technical Feedback identified an issue that has been only lightly fixed and requires more content. O(1) Copy of [Open] Cohort 1 Technical Feedback SEE ROW 2 The mina-signer package for key pair generation and transaction signing related to (duplicate of?) https://app.zenhub.com/workspaces/zkapps-product-eng-6130fedb3b0fc600123d8796/issues/gh/o1-labs/docs2/257

Let's answer these questions:

https://docs.minaprotocol.com/node-operators/mina-signer supersedes the deprecated Client SDK doc but is incomplete and can be more helpful

See https://github.com/o1-labs/snarkyjs/pull/1026 for devs to use mina-signer to create Nullifiers in production, since it does not leak the private key of the user.

https://github.com/o1-labs/docs2/pull/443 introduced a quick fix:

barriebyron commented 1 year ago

potential for an explainer doc in the zkApp dev docs section how to use Mina Signer with zkApp