Skip to content

Commit bbc8d47

Browse files
committed
Native tokens documentation
Update multi-assets.md Rename doc/reference/multi-assets.md to doc/reference/native-tokens/multi-assets.md Rename multi-assets.md to 01-multi-assets.md Rename getting-started.md to 02-getting-started.md Create 03-exercises.md Update 01-multi-assets.md Create 04-exchange-scenarios.md delete general intro to include in readme add native tokens intro to readme file delete duplicated script samples Update README.rst Delete extra details & point to readmes Shorten the native tokens overview add links to native tokens tutorials Adding a link to getting started tutorial
1 parent c9457d4 commit bbc8d47

File tree

6 files changed

+786
-122
lines changed

6 files changed

+786
-122
lines changed

README.rst

+9-5
Original file line numberDiff line numberDiff line change
@@ -405,15 +405,19 @@ Byron vote submission:
405405
Native Tokens
406406
****
407407

408-
Native tokens is a new feature that enables the transacting of multi-assets on Cardano. Native tokens are now supported on mainnet and users can transact with ada, and an unlimited number of user-defined (custom) tokens natively.
408+
Native tokens is a new feature that enables the transacting of multi-assets on Cardano. Native tokens are now supported on mainnet and users can transact with ada, and an unlimited number of user-defined (custom) tokens natively. Note that users who do not need to create new assets (“token holders”) will be able to send and receive existing multi-asset tokens using a wallet such as Daedalus or Yoroi, and with no requirement to use any CLI commands.
409409

410-
To help you get started we have compiled a handy list of resources:
410+
To help you get started, see:
411411

412-
`Cardano Forum discussion <https://forum.cardano.org/c/developers/cardano-tokens/150>`_
412+
- `Cardano Forum discussion <https://forum.cardano.org/c/developers/cardano-tokens/150>`_
413413

414-
`Documentation for native tokens <https://docs.cardano.org/native-tokens/learn>`_
414+
- `Ledger explanations: native tokens <https://cardano-ledger.readthedocs.io/en/latest/>`_. Covers explainers about assets, tokens, token bundles, minting policies, comparison to ERC20, and minimum ada value requirements.
415415

416-
You can also read more about `native tokens and how they compare to ada and ERC20 <https://github.com/input-output-hk/cardano-ledger-specs/blob/master/doc/explanations/features.rst>`_. Browse native tokens created on the Cardano blockchain and see their transactions in an interactive dashboard that allows filtering and searching: nativetokens.da.iogservices.io.
416+
- `A tutorial on how to get started with native tokens <../../../doc/reference/native-tokens/02-getting-started.md>`_. Explains how to create new currencies and assets, submit and send transactions containing multi-asset tokens, send and receive token bundles, manage your addresses and values.
417+
418+
- `Native tokens exercises <../../../doc/reference/native-tokens/03-exercises.md>`_
419+
420+
To start, please ensure that you are familiar with setting up and operating the `Cardano node <https://github.com/input-output-hk/cardano-node>`_. Alternatively, see instructions on how to `start your node <https://github.com/input-output-hk/cardano-node/blob/master/doc/stake-pool-operations/2_start_your_nodes.md>`_ to submit the commands. You will not need to set up and start a full block producing node ('stake pool'), just a much simpler relay node. This node will need to connect to a Cardano network that is capable of processing native tokens (e.g., the native token pre-production environment (PPE), or the Cardano mainnet).
417421

418422
****
419423
API Documentation

doc/reference/multi-assets.md

-117
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Multi-asset support
2+
3+
From the Mary ledger upgrade and onwards, Cardano supports [multi-assets](https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/specs.shelley-ma/latest/download-by-type/doc-pdf/shelley-ma), also referred to as a *native tokens* feature. This feature extends the ledger’s accounting infrastructure (originally designed for processing ada-only transactions) to accommodate transactions using a range of assets. These assets include ada and a variety of user-defined token types, the mixture of which can be transacted in a single tx output.
4+
5+
## What is a multi-asset?
6+
7+
Multi-assets are user-defined, custom tokens. They are supported natively, which means that the ledger handles the accounting and tracking of token-related activities. This offers distinct advantages for developers as there is no need to create smart contracts to mint or burn custom tokens, removing a layer of added complexity and potential for manual errors.
8+
9+
An asset is uniquely identified by an *asset ID*, which is a pair of both the *policy ID* and an *asset name*:
10+
11+
+ *PolicyID* - the unique identifier that is associated with a minting policy (hash of the minting policy).
12+
+ *Asset name* - an (immutable) property of an asset that is used to distinguish different assets within the same policy. Unlike the policyID, the asset name does not refer to any code or set of rules. It is an arbitrary sequence of bytes. In simplest case it is an ASCII-encoded common word, eg. ‘couttscoin’. In this document we use asset name `"636f75747473636f696e" = hex("couttscoin")` as an example.
13+
14+
Tokens that have the same asset ID have the property of being fungible with each other, and are not fungible with tokens that have a different asset ID.
15+
16+
Further reading:
17+
18+
- [Native token explainers](https://cardano-ledger.readthedocs.io/en/latest/)
19+
- [Getting started with native tokens](../../../doc/reference/native-tokens/02-getting-started.md). Includes script examples for minting, transferring, and burning tokens.

0 commit comments

Comments
 (0)