From c2c23ca1628f62542fcc494536b5793b44db3d90 Mon Sep 17 00:00:00 2001 From: Philipp Kant Date: Wed, 21 Aug 2024 15:22:18 +0200 Subject: [PATCH] Add a page on standards --- docs/zkapps/standards.mdx | 23 +++++++++++++++++++++++ sidebars.js | 1 + 2 files changed, 24 insertions(+) create mode 100644 docs/zkapps/standards.mdx diff --git a/docs/zkapps/standards.mdx b/docs/zkapps/standards.mdx new file mode 100644 index 000000000..9a559797c --- /dev/null +++ b/docs/zkapps/standards.mdx @@ -0,0 +1,23 @@ +--- +id: standards +title: Standards +description: This page lists established and upcoming standards for the mina ecosystem +--- + +# Standards for the Mina Ecosystem + +## Standards Process + +Standards for Mina are established through an rfc/rfp process: rfcs can be opened in the [Core Grants repository](https://github.com/MinaFoundation/Core-Grants). After discussion on an rfc has concluded, development work can be performed either internally, or by community members after going through an rfp process and receiving a grant. + +Below, we list standards that have been established for Mina. + +## Established Standards + +### Fungible tokens + +We have released a standard implementation for fungible tokens on Mina. It allows for defining rules for minting tokens upon deployment. Tokens can be transferred, either by calling a `transfer` method of the token contract, or by manually constructing transactions from individual account updates. This enables interoperability with third party contracts. + +The standard implementation can be found on [Github](https://github.com/MinaFoundation/mina-fungible-token). Documentation around how to use the standard can be found [here](https://minafoundation.github.io/mina-fungible-token/introduction.html). + +The fungible token implementation separates out the rules for minting tokens into a separate admin contract. This is to allow custom rules without modifications to the token contract itself. Note that if you do modify the token contract, third parties such as wallets that want to integrate your token will need to integrate your modification into their own codebase. It is thus recommended to use the standard token contract when possible, and only modify the admin contract. diff --git a/sidebars.js b/sidebars.js index ae130f51e..a2814da7f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1337,6 +1337,7 @@ module.exports = { }, 'zkapps/roadmap', 'zkapps/faq', + 'zkapps/standards', ], }, {