Frequently Asked Questions - ajuna-network/Polkadot.Unity.SDK GitHub Wiki

Welcome to the FAQ page for Polkadot SDK for Unity. Here, we've compiled a list of common questions and their answers to help you understand more about the project and resolve any issues you might encounter.

General Questions

What is Polkadot SDK for Unity?

Polkadot SDK for Unity is the integration for all substrate-based blockchains into Unity.

Who is Polkadot SDK for Unity intended for?

This SDK targets, everyone starting from a curious game dev, who wants to explore web3, and ending, at ecosystem blockchains, who want to create a dApp with Unity for their ecosystem.

How can I contribute to Polkadot SDK for Unity?

Please follow the contribution guidelines.

Getting started

How do I start integrating with substrate networks using the Polkadot SDK for Unity?

The first steps of the integration will involve the decision, on the target of your application. It's suggested to follow the first page.

What functionality does the SDK provide for balance, transfers, and transactions?

The SDK provides, not only functionalities like balance, and transfer, instead it also allows you to access and execute all exposed functionalities from the substrate blockchain, without any restrictions.

Why aren't there wrappers for transactions and balances, like in other ecosystem SDKs?

Every substrate-based blockchain provides different functionalities, even though they might use the same pallets/modules, they can be at a different version, which also implies different transaction parameters or storage access keys, see more details in accessing multiple blockchains. Therefore accessing a substrate-based chain starts with generating the necessary extension first, or using a provided extension, like Polkadot, Kusama, or Hexalem.

Where can I see all the information on the classes and methods exposed in the SDK?

The exposed classes and methods are all seen and documented in the Extension library of the specific blockchain, for Polkadot that is the Substrate.Polkadot.NET.NetApiExt, for Kusama it is the Substrate.Kusama.NET.NetApiExt, and for Hexalem it is the Substrate.Hexalem.NET.NetApiExt. If you generate your Extension, then it will be the Substrate.xyz.NET.NetApiExt.

Technical Questions

What are the system requirements for Polkadot SDK for Unity?

To be defined. For now, there are no limiting requirements, except to have either an internet connection or a locally running substrate blockchain.

How do I install Polkadot SDK for Unity?

The official Polkadot SDK for Unity is a verified solution in the Unity Asset Store, Link.

How do I update the SDK to a new version?

Make sure you read through the change logs, if there are breaking changes, they will be listed there including the workaround solutions. Major changes will have an in-detail description of the new features and new behaviors.

I'm using an older Unity Version, can I use the SDK?

The SDK was initially developed, when Unity 2019 was active, and it still builds the artifacts in NETStandard2.0, the SDK doesn't support older versions out of the box. But by creating the Libraries for your .NET profile, you should be able to integrate it.

Troubleshooting

My APK build doesn't connect to the node, but the development APK works?

Make sure that you allow Internet Access, as this feature needs to be set to Required, Player -> Other Settings -> Configuration -> Internet Access

How do I report a bug or suggest a feature?

Check the Support and Contact page.

Where can I find the documentation for Polakdot SDK for Unity?

Here! Wiki.

How to add Newtonsoft Json DLL, for the unity library?

The package includes its own copy of Newtonsoft Json DLL, which is commonly used by multiple Asset Store and Unity registry packages. To avoid clashing, it is recommended to include Newtonsoft Json as a package dependency:

  1. Open the Package Manager window
  2. Click on the + button on the top left and select 'Add package by name'
  3. Enter 'com.unity.nuget.newtonsoft-json'
  4. When exporting/uploading Polkadot SDK using the Asset Store Publishing Tools, select this package as a dependency and it will be included with the exported .unitypackage

Additional Information

Where can I stay updated about Polkadot SDK for Unity's developments?

Since this is a fully open-source project, best is to check the repository, and the ongoing PRs and Issues.

Are there any community guidelines for Polkadot SDK for Unity?

Stay friendly and constructive, and check out the Contribution Guidelines.

Note: This FAQ is a living document and will be updated as new questions arise and when additional information becomes available. If your question isn't answered here, feel free to contact us.