Getting Started

In this chapter, we'll see how to install Sui binaries and how to add Sui client libraries as dependencies. Let's start with installing Sui binaries.

Sui Installation

Installing Sui for development is very easy with package managers. In your OS' terminal or shell, run the appropriate command as shown below:

brew install sui

choco install sui

In order to interact with Sui, we need a client. If you've run either of the above commands, you have a binary client installed that you can confirm by running sui --version in you terminal or shell. If successful, this should display the version of Sui installed.

To integrate the client as a library into your project, follow the instructions below:

Client Library Installation

The client libraries are available for various platforms. Ranging from specific platform libraries to multiplatform libraries. Follow the instructions below:

implementation("xyz.mcxross.ksui:<ksui-[platform]>:<$ksui_version>")

If you have a Kotlin Multiplaform project, add the following dependency to your projects' common sourceSet:

implementation("xyz.mcxross.ksui:ksui:<$ksui_version>")

For a purely Android project, add the following as a dependency:

implementation("xyz.mcxross.ksui:ksui-android:<$ksui_version>")

For a JVM projects, add the following as a dependency:

implementation("xyz.mcxross.ksui:ksui-jvm:<$ksui_version>")

Sui Client

Once you've successfully added the dependencies, create a Sui instance as showed below:

val sui = Sui()

This serves as the main entry point for the client. By default, it connects to the devnet network. However, you can customize the network configuration as follows:

            val config = SuiConfig(settings = SuiSettings(network = Network.MAINNET))
            val sui = Sui(config)
        

You can also set other things like connectAttempts, retryOnServerErrors, proxy, and much more:

            val settings = SuiSettings(clientConfig = ClientConfig(maxRetries = 5))
            val sui = Sui(SuiConfig(settings))
        

Our client is now ready for use. We can now call the various available methods on this sui object.

Last modified: 17 November 2024