Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Mina Signer developer documentation #590

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Commits on Sep 11, 2023

  1. feat(docs): add Mina Signer documentation

    This commit introduces a new documentation file for the Mina Signer library. The documentation covers installation, usage, and examples for the library. It aims to provide developers with a comprehensive guide to integrating Mina Signer into their projects.
    MartinMinkov committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    ef8ca4d View commit details
    Browse the repository at this point in the history
  2. feat(sidebars.js): add 'zkapps/mina-signer' to the sidebar for better…

    … navigation and user experience
    MartinMinkov committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    6d44f11 View commit details
    Browse the repository at this point in the history
  3. fix(mina-signer.mdx): correct syntax error by adding missing semicolon

    feat(mina-signer.mdx): add nonce field to payment object to ensure uniqueness of transactions
    MartinMinkov committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    e3c89fb View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2023

  1. docs(mina-signer.mdx): add detailed usage guide for Mina Signer with …

    …o1js
    
    This commit adds a comprehensive guide on how to use Mina Signer with o1js for signing and verifying zkApp transactions. It includes a code snippet demonstrating the process and a tip advising when to use Mina Signer over o1js. This update is intended to provide better guidance for developers integrating Mina Signer into their projects.
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    e2b4c41 View commit details
    Browse the repository at this point in the history
  2. docs(mina-signer.mdx): add section on signing/verifying Field payloads

    This commit adds a new section to the Mina Signer documentation explaining how to sign and verify Field payloads. This is useful for developers who want to ensure their payloads have not been tampered with. The section includes code examples and notes on handling Field types from different libraries.
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    a7a4c74 View commit details
    Browse the repository at this point in the history
  3. docs(mina-signer.mdx): add section on nullifiers to provide more comp…

    …rehensive documentation on zkApp transactions, explaining their purpose and usage with an example code snippet.
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    96f2222 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    54a5645 View commit details
    Browse the repository at this point in the history
  5. docs(mina-signer.mdx): improve clarity and specificity in documentation

    1. Specify that the installation command is for Mina Signer for better context.
    2. Remove the definite article before Mina Signer for consistency.
    3. Add explanation for the need to specify the network during Mina Signer initialization.
    4. Move the default network information to a tip box for better visibility.
    5. Specify that Mina Signer supports signing and verifying of arbitrary Field payloads for better understanding.
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    395864a View commit details
    Browse the repository at this point in the history
  6. docs(mina-signer.mdx): update terminology and add more context to imp…

    …rove clarity
    
    1. Replace 'keys' with 'keypairs' for more accurate terminology.
    2. Add information about broadcasting signed payments or delegations to the network via the Mina Daemon.
    3. Add hyperlink to 'o1js' for better navigation and understanding.
    4. Modify description of Mina Signer's integration with 'o1js' to include signing/verifying Field payloads.
    5. Clarify that Mina Signer can sign a zkApp transaction that can easily be broadcasted with a Mina Daemon.
    6. Remove 'Examples' section as it seems to be empty and unnecessary.
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    d0a9a12 View commit details
    Browse the repository at this point in the history
  7. docs(mina-signer.mdx): update description field from 'TODO' to a brie…

    …f summary of the Mina Signer library to provide a clear and concise overview of the library's purpose and functionality
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    dcdb870 View commit details
    Browse the repository at this point in the history
  8. docs(mina-signer.mdx): improve readability and clarity of the documen…

    …tation
    
    - Reworded several sentences for better readability and clarity.
    - Organized the features of Mina Signer into a list for easier understanding.
    - Made the instructions for specifying the network more explicit.
    - Changed the headers to use '&' instead of '/' for consistency.
    - Expanded on the explanation of nullifiers for better understanding.
    - Made the instructions for generating a nullifier more explicit.
    MartinMinkov committed Sep 12, 2023
    Configuration menu
    Copy the full SHA
    8a92a1d View commit details
    Browse the repository at this point in the history

Commits on Sep 13, 2023

  1. docs(mina-signer.mdx): remove backticks from o1js for consistency and…

    … readability
    
    The backticks were removed from o1js to maintain consistency throughout the document and improve readability. The backticks are typically used for code snippets or commands, not for naming libraries or tools.
    MartinMinkov committed Sep 13, 2023
    Configuration menu
    Copy the full SHA
    502be72 View commit details
    Browse the repository at this point in the history