kBorsh
0.1.3indexedImplements Borsh serialization for data encoding and decoding, supporting byte arrays, hex strings, and Base64 formats, enhancing interoperability with Borsh.io specifications.
1
Stars
3
Used by
dependents
—
Health
/ 100
kBorsh
Borsh Kotlin Serialization Format
This library provides a Borsh serialization format for kotlinx-serialization.
Usage
@Serializable
data class MyObject(val name: String, val id: Int, val price: Float)
// given a serializable object
val myObject = MyObject("Some Thing", , )
myObjectBorshEncoded: ByteArray = Borsh.encodeToByteArray(myObject)
myObjectDecoded: MyObject = Borsh.decodeFromByteArray<MyObject>(myObjectBorshEncoded)
From Hex String
@Serializable
data class MyObject(val name: String, val id: Int, val price: Float)
// given a Borsh encoded hex string
val myEncodedString = "0a000000536f6d65205468696e67d2040000f6f80d44"
// decode serializable object from string
val myObjectDecodedFromString: MyObject = Borsh.decodeFromHexString<MyObject>(myObjectBorshEncodedString)
From Base64
@Serializable
data class MyObject(val name: String, val id: Int, val price: Float)
// given a Borsh encoded Base64 string
val myEncodedBase64String = "CgAAAFNvbWUgVGhpbmfSBAAA9vgNRA=="
// can use any Base64 decoder you choose
val encodedBorshBytes: ByteArray = Base64.getDecoder().decode(myEncodedBase64String)
myObjectDecoded: MyObject = Borsh.decodeFromByteArray<MyObject>(encodedBorshBytes)