Skip to content

EasyA-Tech/immutable-handbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

The ImmutableX Handbook [WiP]

Welcome. This is EasyA's legendary handbook. If you want to learn ImmutableX like a legend, then you're in the right place.

Purpose

This handbook serves as a guide to the ImmutableX ecosystem, geared towards those just joining for the first time. It isn't just a beginners' handbook; it's a legendary handbook. Even if you've already immersed yourself in the ecosystem, you'll find tons of helpful tidbits around here!

The EasyA App

Of course, the best place to start is always the EasyA app! Download it here for the fastest and most fun way to learn about ImmutableX. Download it directly right here!

Table of Contents

Introduction

What is ImmutableX:

  • ImmutableX Website - The official website for ImmutableX, a Layer 2 scaling solution for NFTs on Ethereum.

Getting Started

The no-fluff starter:

Core Concepts

Explanation of fundamental concepts in the ImmutableX ecosystem:

  • NFT Minting - Explanation of how NFTs are minted on ImmutableX.

Development Tools

Key tools and environments for ImmutableX:

[To be Added]

Smart Contracts

How to write and deploy smart contracts on ImmutableX:

[To be Added]

ImmutableX Network

Going into the network level:

[To be Added]

Ecosystem Projects

Cool projects built on ImmutableX:

  • Gods Unchained - A competitive trading card game built on ImmutableX.
  • Guild of Guardians - A mobile RPG game utilizing ImmutableX for in-game assets.
  • Illuvium - An open-world RPG adventure game built on ImmutableX.

...and of course many more - check them out in the EasyA app!

Resources

Extra stuff:

Handy Code Snippets

Get a taste of ImmutableX development with these code snippets:

Connecting to ImmutableX

import { ImmutableXClient, Link } from '@imtbl/imx-sdk';

const client = await ImmutableXClient.build({ publicApiUrl: 'https://api.x.immutable.com/v1' });
console.log('Connected to ImmutableX');

Minting an NFT

const result = await client.mint({
  mints: [{
    etherKey: '0x...',  // The recipient's address
    tokens: [{
      type: 'ERC721',
      data: {
        tokenId: '1',
        blueprint: 'metadata:url',
        royalties: [
          { recipient: '0x...', percentage: 3.0 }
        ]
      }
    }]
  }]
});
console.log('NFT minted:', result);

These examples showcase:

  1. How to connect to the ImmutableX network using the ImmutableX SDK.
  2. How to mint an NFT on ImmutableX.

Contributing

We welcome contributions to make this handbook even more legendary! Here's how you can contribute:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-addition)
  3. Make your changes
  4. Commit your changes (git commit -am 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-addition)
  6. Create a new Pull Request

Please ensure your contributions align with our code of conduct and contribution guidelines.

Credit/Inspiration

This handbook was inspired by the famous awesome lists by sindresorhus. We need awesome lists for Web3 ecosystems, with more of a hacker's guide to how they work. This is the answer to that need.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors