Getting Started
Installation
Quick Start
The Scala Brambl SDK is published to Maven Central and is
built for Scala 2.13. To use it in your project, add the following to your build.sbt:
val bramblVersion = "2.0.0" // replace with the latest version
libraryDependencies += "co.topl" %% "brambl-sdk" % bramblVersion
The list of versions can be found here.
Service Kit
Wallet functionality in the Brambl SDK requires an implementation of a ServiceKit which is responsible for implementing
any un-implemented, application-specific, traits in
the DataApi
package. Specifically, it handles data persistence. The SDK provides a default implementation of
the ServiceKit
that is published to Maven Central for your convenience.
This default implementation uses local storage and SQLite. To learn more, see Overview of Service Kit.
To use it in your project, add the following to your build.sbt:
val bramblVersion = "2.0.0" // replace with the latest version
libraryDependencies += "co.topl" %% "service-kit" % bramblVersion
Other Libraries
There are 3 other Topl libraries relevant to the SDK; crypto,
quivr4s,
and protobuf. These libraries are not required to be added
to a project since they are mainly meant to be used internally by the SDK. However, advanced users may find them useful
to use to implement their own custom functionality in their application.
Contributing
The Brambl SDK is completely open source and we welcome contributions. To get started, check out the GitHub repository.