SDKs overview
Immutable provide SDKs for a range of languages and frameworks that make it easy for application developers to execute basic, as well as more advanced, functionality.
There are three types provided:
- Core SDKs - provides a wrapper for the API endpoints as well as workflow functions that make common actions easier to implement. It facilitates all the functionality that the Immutable X platform provides.
- Wallet SDKs - enables applications to facilitate user transactions by connecting with user wallets on various platforms and enabling user authorization (signing) of state-updating transactions (ie. creating sell orders, transferring ownership of assets). It can be used with the Core SDK.
- Link SDK - provides all functionality required to facilitate user transactions, including a user interface for users to see, sign and approve these transactions.
What are user transactions?
User transactions are those that deal with changes in asset ownership that require the approval (signature) of asset owners. These transactions update the state of things on the blockchain, as opposed to just reading data.
How do the SDKs work together?
The Core SDK is responsible for the bulk of functionality that is available on the Immutable X platform. It can be used with the Wallet SDK in order to establish a connection with users' wallets to sign certain transactions that require users' approval.
The Link SDK provides end-to-end functionality for the bulk of user transactions and does not need to be used in conjunction with other SDKs.
Example functionality matrix
| Connect to user wallet | Actions requiring user signatures | Actions not requiring user signatures | |||||||
|---|---|---|---|---|---|---|---|---|---|
| Sign transactions | Register users | Create orders and trades | L1-L2 transfers (deposits and withdrawals) | Mint tokens on L2 | Get list of assets | Get orders | Get trades | Get user balances | |
| Wallet SDK | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Link SDK | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Core SDK | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Core SDKs
Wallet SDKs
Link SDK
Open API Specification
Immutable's Open API specification empowers developers to be able to interact efficiently with our APIs by supporting the automatic client generation in many languages.