LYNC Metamask Wallet SDK is a one-stop solution for game developers to easily integrate Metamask into their game engine and deploy their game on multiple networks with just a few clicks. This SDK allows game developers to monitor gamers’ data via LYNC analytics system and update the SDK without leaving the game engine.
Please get your API key before downloading the SDK from https://www.lync.world/form.html
Download the LYNC - Metamask Wallet SDK from here. Import the SDK .unitypackage file to your project. or simply drag and drop .unitypackage file to your project.
Once the Metamask Wallet SDK package has finished importing into your Unity project, you can begin integrating it into your game. To do this, open the ConnectWallet scene provided by the LYNC - Metamask SDK.
Path : Assets ->LYNC-Metamask-SDK -> Scenes
After opening ConnectWallet scene, Go to Interface. In the "Inspector" window, go to the API key & Enter the API key.
To choose the blockchain network, simply go to the CurrentChain drop-down menu and pick the network of your preference to deploy your game on.
The Transactions are divided into 2 parts:
- No Code Transactions
- Modular Transactions
Note: Make sure to have "TransactionManager.cs" in your scene.
Check the No-Code-Transaction Scene in the Scenes folder.
Check the No-Code TransactionExample GameObject, you can just pass in a few parameters to write on any custom contract inside the game. Just pass the following parameters:
- Contract Address - Type any contract address on the chain you selected in the LYNCInterface GameObject.
- ABI - You can get the contract ABI of a verified contract on the explorer.
- Function Name - Write the exact function name from the contract
- Cost - The cost required to do the transaction, if it's free you can pass 0 else pass the value in wei.
- Arguments - The arguments required by the transaction, are left blank if none.
Check the Transaction Scene in the Scenes folder.
Check the TransactionExample GameObject, it has a TransactionExample.cs file attached.
This example contains 3 types of transaction transactions, ERC-721, ERC-1155 and ERC-20.
In this example:
- send20Trx is a button to disable the button click once the transaction is initiated.
- contractAddress - is the contract address for a custom transaction. (In this case, it's an ERC-20 contract address on Mumbai Testnet)
- ABI - You can get the contract ABI of a verified contract on the explorer.
- functionName - Write the exact function name from the contract (In this case, sendToken)
- cost - The cost required to do the transaction, if it's free you can pass 0 else pass the value in wei. (In this case, as the function is not payable the value is 0).
- ParametersOfFunctions - You can pass in the arguments required for the transaction. (In this example, the argument is how much amount you want to send, 10000000000000000 is the value in wei, i.e 0.01 eth. You can pass n number of arguments separated with a comma( , ) ).
- args - Converts compatible to be a JSON
- Sending transaction -
TransactionManager.Instance.SendTransaction(LoadingScreen, contractAddress, ABI, functionName, args, cost, On20TrxCompleted, On20TrxFailed);
The above example explains a requirement for doing transactions.
You can use the "TransactionManager.Instance.SendTransaction()" to send transactions from anywhere in the project, make sure to add the TransactionManager.cs file in the scene. It takes a LoadingScreen GameObject, contractAddress, ABI, functionName, args, and cost, as explained above and 2 more functions of type "System.Action". These are not compulsory functions but they handle the Transaction Success or Failure.
**On20TrxCompleted **- Handles once the transaction is completed. (It returns a transaction hash). On20TrxFailed - Handles if the transaction failed. (It returns a reason for transaction failure).
To deploy your Unity project, it's necessary to set up the Player Settings in Unity. Follow these steps to select the LYNC WebGL template.
In the "Build Settings" window, place ConnectWallet and FetchWallet at the top of this section.
Go to "Player Settings" and navigate to "Resolution and Presentation". Select LYNC - Template in WebGL Template
After completing all the necessary steps and configuring the Player Settings with the LYNC WebGL template, you can now build and run your game. To do this, go to "File" on the top menu bar in the Unity editor and select "Build and Run."
Congratulation, you have successfully integrated the Metamask wallet with your favourite blockchain network using LYNC SDK.
NOTE: If you wish to use wallet address inside game after user's wallet is connected, use:
PlayerPrefs.GetString("WalletAddress");
If you face any error, while Build and Run.
PLEASE ADD, Unity package install by git link:
com.unity.nuget.newtonsoft-json
