Skip to content

mettal-stable/mettal-icp-canisters

Repository files navigation

Mettal ICP Canisters Deployment Guide

This document outlines the steps to deploy the Mettal ICP Canisters, the URLs for the deployed canisters, and details about token minting and burning processes.

Frontend Details

The Frontend is a hybrid web application developed in React and hosted on Amazon S3 with CloudFront for distribution.

Hosted on
  [email protected]:mettal-stable/mettal-dashboard.git

High Level Mettal Token Application Architecture

High Level Mettal Token Architecture


Deployment Steps

  1. Clone Repository from:
[email protected]:mettal-stable/mettal-icp-canisters.git
  1. Navigate to the mettal-icp-canisters directory:
cd mettal-icp-canisters
  1. Start the Internet Computer framework in the background:
dfx start --background
  1. Deploy the canisters using the provided script:
./scripts/deploy.sh

Deployment Output

Upon successful deployment, the following canisters will be available:

Backend Canisters via Candid Interface:


Token Management

How to Mint Tokens

  • Token minting is restricted to the Minter Canister.
  • The Owner of the Minter Canister, authenticated via a .pem mechanism through the Web2 backend, is the sole entity authorized to generate new tokens for principals.

How to Burn Tokens

  • Users can sell their tokens through the Mettal Dashboard. The process is as follows:
  • Users, logged in using Internet Identity, can approve the Minter Owner to transfer tokens to the Minter Canister. This is done using the icrc2_approve method on the ICRC Ledger.
  • The Minter Owner calls the Minter Canister to transfer the approved token amount from the user's principal to the canister using the icrc2_transfer_from method.

About the Demo

This guide explains how to use the demo function of the Mettal Dashboard, which allows the Owner of the application to reward users for completing a KYC (Know Your Customer) process. Upon completion, users can sell Mettal Coin (MXND) for Mexican pesos.

1. Create an Account on Mettal Dashboard

  • Visit the Mettal Dashboard website and sign up for an account.

2. Link Your Account to Internet Identity

  • Log in to the Mettal Dashboard using Internet Identity and link your account to ensure secure access.

3. Complete the KYC Process

  • Start and complete the KYC (Know Your Customer) process by following the steps provided on the dashboard.
  • Once your KYC is verified and complete, you will receive a notification confirming that tokens have been credited to your wallet.

4. Sell Tokens for Mexican Pesos

  • Use the Sell Tokens option to exchange your Mettal Coins (MXND) for Mexican pesos:
    • The tokens will be transferred back to the Mint Account.
    • The tokens will be burned as part of the process.
    • The equivalent payment will be sent directly to your linked bank account.

Gallery

screen shot 2017-08-07 at 12 18 15 pm get_transactions screen shot 2017-08-07 at 12 18 15 pm icrcl_metadata screen shot 2017-08-07 at 12 18 15 pm about the token
screen shot 2017-08-07 at 12 18 15 pm get_account_transactions screen shot 2017-08-07 at 12 18 15 pm get_blocks screen shot 2017-08-07 at 12 18 15 pm icrcl_balance_of
screen shot 2017-08-07 at 12 18 15 pm User Dashboard Balance

ICP Frontend Integration

To Canister ledger :

  src/lib/transactions/data/icp/icp-canister.adapter.ts  

To Internet Identity :

 src/lib/auth/data/icp.provider.ts
Canister Ledger Frontend Integration Internet Identity Integration

For any additional support or questions, please contact the Mettal

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published