Skip to content

Home

Jump to bottom
Enrico Rubboli edited this page Oct 5, 2023 · 13 revisions

Mintlayer Project Wiki

Welcome to the Mintlayer Project Wiki. This wiki is designed to guide you step-by-step based on what you want to achieve with the Mintlayer core project.

What Do You Want to Do?

Learn More About Mintlayer Node

Mintlayer is a Layer 2 solution for Bitcoin, optimized for issuing both fungible and non-fungible tokens that are interoperable with the Bitcoin network. For a technical introduction and detailed documentation, visit our docs.

Install a Mintlayer Node

Follow these detailed guides to install Mintlayer:

Use the Mintlayer Node GUI

The Mintlayer Node GUI is a user-friendly option, especially for those who are not familiar with command-line interfaces. It provides an intuitive graphical interface, simplifying the processes of setting up and managing your node.

We recommend downloading the pre-compiled binary directly from the Mintlayer website. This allows for a quick and hassle-free installation, getting you up and running in no time.

Familiarize with the Mintlayer Command Line Wallet (wallet-cli)

The Mintlayer Command Line Wallet, or wallet-cli, offers a more hands-on approach for users who are comfortable using terminal commands. It provides a powerful interface for managing your tokens, staking, managing transactions, and more, giving you full control and flexibility over your assets.

To begin using wallet-cli, you should first ensure that you have the Mintlayer node installed and running. The command line wallet interacts directly with the node to perform various operations, such as sending transactions, checking balances, and managing your tokens.

Here's a basic overview of how to interact with wallet-cli:

  1. Accessing the Wallet: Open your terminal or command prompt, and navigate to the directory where wallet-cli is located.
  2. Basic Options: You can view all available options by typing ./wallet-cli --help (on Linux/Mac) or wallet-cli.exe --help (on Windows), or directly here
  3. Wallet Commands: The list of all available commands can be listed once you have run the interactive wallet using the command help, or by checking the online documentation here.

Learn How to Stake Your Testnet Tokens

Staking your testnet tokens is a process that allows you to participate in the network's consensus mechanism, contributing to the security and stability of the network, and earning staking rewards in return.

  1. Ensure You Have Tokens: Before you can stake tokens, you need to have some in your wallet. If you're on a testnet, ensure you've acquired testnet tokens, if you want to run your own pool you need at least 40.000 TML.
  2. Access wallet-cli: As mentioned above, you’ll need to access wallet-cli. Make sure your node is running as the wallet interacts with it for staking.
  3. Staking or Delegating Command: Use specific commands to stake your tokens.

Detailed instructions on staking, including the commands and parameters needed, can be found in the Staking TML Tokens guide.

Report a Security Issue

Found a security issue? Please contact us confidentially at [email protected]. Check our bug bounty program for eligibility for a reward paid in ML. More info on our security policy can be found here.

Report a Bug

For non-security related bugs, open issues in the core Mintlayer repo and provide as much detail as possible.

Contribute to Mintlayer

Interested in making Mintlayer even better? Follow this contributing guide to learn how you can participate.

Building Mintlayer

To build the project, first install Rust (instructions in the contributing guide), then use cargo build to build and cargo test to run the tests.

Additional Resources

Clone this wiki locally