Register token

docs/build/isc/v1.0.0-rc.6/docs/_admonitions/_ownership.md

@@ -0,0 +1,7 @@
+:::info Ownership
+
+You might want to look into making the function ownable with, for example,
+[OpenZeppelin](https://docs.openzeppelin.com/contracts/5.x/access-control#ownership-and-ownable)
+so only owners of the contract can call certain functionalities of your contract.
+
+:::

docs/build/isc/v1.0.0-rc.6/docs/_admonitions/_payable.md

@@ -0,0 +1,6 @@
+:::info Payable
+
+Instead of making the function payable, you could let the contract pay for the storage deposit. 
+If so, you will need to change the `require` statement to check if the contract's balance has enough funds.
+
+:::

docs/build/isc/v1.0.0-rc.6/docs/how-tos/token/create-foundry.md

@@ -0,0 +1,75 @@
+---
+description: How to create a L1 foundry
+image: /img/logo/WASP_logo_dark.png
+tags:
+  - foundry
+  - EVM
+  - how-to
+---
+
+import Ownership from '../../_admonitions/_ownership.md';
+import Payable from '../../_admonitions/_payable.md';
+
+# Create a Foundry
+## About Foundries
+
+The Stardust update allows you to create your own native tokens. Native tokens are minted by a [Foundry](/tips/tips/TIP-0018/#foundry-output). 
+The Foundry allows you to specify your native token's maximum supply **once** and change the circulating supply. 
+This guide will show you how to create an L1 foundry using a L2 smart contract.
+
+## Example Code
+
+<Ownership/>
+
+1. Check if the amount paid to the contract is the same as the required [storage deposit](/learn/protocols/stardust/core-concepts/storage-deposit) and set the allowance.
+
+```solidity
+        require(msg.value == _storageDeposit*(10**12), "Please send exact funds to pay for storage deposit");
+        ISCAssets memory allowance;
+        allowance.baseTokens = _storageDeposit;
+```
+
+<Payable/>
+
+2. Define the `NativeTokenScheme`:
+
+```solidity
+        NativeTokenScheme memory nativeTokenScheme = NativeTokenScheme({
+            mintedTokens: _mintedTokens,
+            meltedTokens: _meltedTokens,
+            maximumSupply: _maximumSupply
+        });
+```
+
+3. Create the foundry by calling the `ISC.accounts.foundryCreateNew(nativeTokenScheme, allowance)` function:
+
+```solidity
+        uint32 foundrySN = ISC.accounts.foundryCreateNew(nativeTokenScheme, allowance);
+```
+
+### Full Example Code 
+
+```solidity
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import "@iota/iscmagic/ISC.sol";
+
+contract CreateFoundry {
+    event CreatedFoundry(uint32 foundrySN);
+
+    function createFoundry(uint _mintedTokens, uint _meltedTokens, uint _maximumSupply, uint64 _storageDeposit) public payable {
+        require(msg.value == _storageDeposit*(10**12), "Please send exact funds to pay for storage deposit");
+        ISCAssets memory allowance;
+        allowance.baseTokens = _storageDeposit;
+        NativeTokenScheme memory nativeTokenScheme = NativeTokenScheme({
+            mintedTokens: _mintedTokens,
+            meltedTokens: _meltedTokens,
+            maximumSupply: _maximumSupply
+        });
+        uint32 foundrySN = ISC.accounts.foundryCreateNew(nativeTokenScheme, allowance);
+        emit CreatedFoundry(foundrySN);
+    }
+}
+```

docs/build/isc/v1.0.0-rc.6/docs/how-tos/token/mint-token.md

@@ -0,0 +1,51 @@
+---
+description: How to mint native token on an L1 foundry.
+image: /img/logo/WASP_logo_dark.png
+tags:
+  - foundry
+  - EVM
+  - how-to
+  - native tokens
+  - mint
+---
+
+import Ownership from '../../_admonitions/_ownership.md';
+import Payable from '../../_admonitions/_payable.md';
+
+# Mint Native Tokens
+
+To mint tokens from a foundry, you first need to be aware that only the foundry owner can mint token so you might execute that function 
+in the same contract as [creating](./create-foundry.md) the foundry. You can then call the `ISC.accounts.mintNativeTokens` function.
+
+## Example Code
+
+<Ownership/>
+
+1. First we check if the payed amount to the contract is the same as the [storage deposit](/learn/protocols/stardust/core-concepts/storage-deposit) we want to allow and set the allowance
+
+```solidity
+        require(msg.value == _storageDeposit*(10**12), "Please send exact funds to pay for storage deposit");
+        ISCAssets memory allowance;
+        allowance.baseTokens = _storageDeposit;
+```
+
+<Payable/>
+
+2. Mint the native token specifying the foundry serial number, the amount to mint and the allowance.
+```solidity
+        ISC.accounts.mintNativeTokens(_foundrySN, _amount, allowance);
+```
+
+## Full Example Code
+
+```solidity
+    event MintedNativeTokens(uint32 foundrySN, uint amount);
+
+    function mintNativeTokens(uint32 _foundrySN, uint _amount, uint64 _storageDeposit) public payable {
+        require(msg.value == _storageDeposit*(10**12), "Please send exact funds to pay for storage deposit");
+        ISCAssets memory allowance;
+        allowance.baseTokens = _storageDeposit;
+        ISC.accounts.mintNativeTokens(_foundrySN, _amount, allowance);
+        emit MintedNativeTokens(_foundrySN, _amount);
+    }
+```

docs/build/isc/v1.0.0-rc.6/docs/how-tos/token/register-token.md

@@ -0,0 +1,59 @@
+---
+description: How to register a native token as ERC20
+image: /img/logo/WASP_logo_dark.png
+tags:
+  - ERC20
+  - EVM
+  - how-to
+---
+
+import Ownership from '../../_admonitions/_ownership.md';
+import Payable from '../../_admonitions/_payable.md';
+
+# Register Tokens
+
+To properly use your native tokens, you should register them as ERC20 using the `registerERC20NativeToken` function from the ISC magic contract.
+
+## Example Code
+
+<Ownership/>
+
+1. First we check if the payed amount to the contract is the same as the [storage deposit](/learn/protocols/stardust/core-concepts/storage-deposit) we want to allow and set the allowance
+
+```solidity
+require(msg.value == _storageDeposit*(10**12), "Please send exact funds to pay for storage deposit");
+ISCAssets memory allowance;
+allowance.baseTokens = _storageDeposit;
+```
+
+<Payable/>
+
+2. Register the native tokens specifying:
+* the foundry serial number
+* a name
+* a symbol
+* it's decimals 
+* the allowance.
+```solidity
+ISC.sandbox.registerERC20NativeToken(_foundrySN, _name, _symbol, _decimals, allowance);
+```
+
+3. Get the ERC20 contract address with `erc20NativeTokensAddress`:
+```solidity
+address erc20address = ISC.sandbox.erc20NativeTokensAddress(_foundrySN);
+```
+
+### Full Example Code
+
+```solidity
+event ERC20Address(address erc20address);
+
+function registerERC20NativeToken(uint32 _foundrySN, string calldata _name, string calldata _symbol, uint8 _decimals, uint64 _storageDeposit) public payable {
+require(msg.value == _storageDeposit*(10**12), "Please send exact funds to pay for storage deposit");
+ISCAssets memory allowance;
+allowance.baseTokens = _storageDeposit;
+ISC.sandbox.registerERC20NativeToken(_foundrySN, _name, _symbol, _decimals, allowance);
+address erc20address = ISC.sandbox.erc20NativeTokensAddress(_foundrySN);
+emit ERC20Address(erc20address);
+}
+```

docs/build/isc/v1.0.0-rc.6/sidebars.js

@@ -156,6 +156,27 @@ module.exports = {
               label: 'Send Tokens to L1',
               id: 'how-tos/send-tokens-to-l1',
             },
+            {
+              type: 'category',
+              label: 'Token',
+              items: [
+                {
+                  type: 'doc',
+                  label: 'Create Foundry',
+                  id: 'how-tos/token/create-foundry',
+                },
+                {
+                  type: 'doc',
+                  label: 'Mint Token',
+                  id: 'how-tos/token/mint-token',
+                },
+                {
+                  type: 'doc',
+                  label: 'Register Token as ERC20',
+                  id: 'how-tos/token/register-token',
+                },
+              ],
+            },
           ],
         },
       ],