Basic guides
These guides provide information on how to execute key functionality of the Immutable platform using our developer tools.
Each guide provides information for building with:
- Core SDK - with the Wallet SDK for obtaining user signatures (recommended)
- JS SDK - with the Link SDK for obtaining user signatures
Read more about our SDKs and how they work together >
Guides:
📄️ Install and initialize
Core SDK
📄️ Get data
This guide provides information on how to get data about events on Immutable. Typically, this data is about current state (ie. asset ownership, open orders) or past transactions (ie. trades, asset transfers).
📄️ Generate signers
User signatures are required for certain types of operations on Immutable X. These are:
📄️ Register users
Following an upgrade from StarkEx v3 to StarkEx v4, on-chain user registration is only required in the following scenarios where the L1-L2 wallet pair needs to be recorded on Ethereum (L1):
📄️ Creating orders
Please refer to this guide to learn more about maker taker fees when you plan your migration to the upgraded v3 endpoints.
📄️ Creating trades
Creating a trade is also known as filling an order, or buying an asset. A user executes a trade by agreeing to purchase an asset at the terms specified in the order and then becomes the new owner of the asset.
📄️ Mint assets
Minting assets on Immutable means to bring into existence tokens from a smart contract. For more information on this concept, please see Deep dive into minting.
📄️ Asset transfers
A user might want to transfer their asset from one wallet to another for various reasons, ie. sending the asset as a gift.
📄️ Asset deposits and withdrawals
Applications may want to enable users to:
📄️ Crypto on and off-ramps
Typically, getting crypto onto Immutable X Layer 2 wallets is a multi-step process. A common flow is:
📄️ Primary Sales
A primary sale involves a game studio selling an NFT directly to a player in exchange for an ERC20 or Native token. The NFT can either be transferred from the game studio's inventory or directly minted to the player's wallet during the process.