Installation Guide

📘

Note

Please read the section in the SDKs and Library module around Installing Bifrost which includes BramblSC as one of the packages included in this library.

• Add the following to your build.sbt

📘

Note:

Please replace x.x.x with the most recent BramblSC release version

resolvers +=  "Sonatype OSS Staging" at "https://s01.oss.sonatype.org/content/repositories/staging"
libraryDependencies ++= Seq(
  "co.topl" %% "brambl" % "x.x.x"
)

Description

Bifrost implements an JSON-RPC API layer that is accessible via HTTP using AkkA-Http. The dependency above will provide access to several Topl packages including client, topl-rpc, akka-http-rpc, and common. These packages provide needed codecs for encoding requests and decoding the response. These decoders leverage the common package heavily. This package is where all shared data types are located for the Topl protocol (definitions for Blocks, Transactions, Keyfiles, etc.).

The Rpc requests are executed using HttpRequests via the akka-http-rpc package which is a generic interface for implementing an RPC sevrer using Akka-Http that conforms to the OpenRPC standard defined at https://spec.open-rpc.org/. The client package defines a convenience Provider trait that defines the network prefix, URI, and api-key needed to access a specific provider.

Compiling from Source Code:

git clone [email protected]:Topl/BramblSc.git