Package-level declarations

Types

Link copied to clipboard
@Serializable
sealed class Asset

Represents an asset on a blockchain network.

Link copied to clipboard
@Serializable
data class Balance(val asset: Asset, val balance: BigInteger)

Represents the balance of a blockchain asset.

Link copied to clipboard

Type alias for the result of a balance query operation.

Link copied to clipboard
object BigIntegerSerializer : KSerializer<BigInteger>

Serializer for ionspin BigInteger that converts to/from String. This is needed for kotlinx.serialization support.

Link copied to clipboard
@Serializable
data class Broadcast(val hash: String)

Represents the result of broadcasting a transaction to the blockchain.

Link copied to clipboard

Type alias for the result of a transaction broadcast operation.

Link copied to clipboard
object ByteArrayAsHexSerializer : KSerializer<ByteArray>

Serializer for ByteArray that converts to/from hex string. This matches the Dart-side expectation from the KSP-generated code which uses hex encoding for ByteArray fields.

Link copied to clipboard
@Serializable
@SerialName(value = "confirmed")
data class Confirmed(val hash: String, val blockNumber: BigInteger, val gasUsed: BigInteger) : TransactionStatus

Represents a confirmed transaction that has been successfully mined and included in a block.

Link copied to clipboard
@Serializable
@SerialName(value = "evm_eip1559")
data class EvmEip1559Fee(val maxFeeWei: BigInteger, val l1FeeWei: BigInteger? = null, val gasLimit: BigInteger, val baseFeePerGas: BigInteger, val maxPriorityFeePerGas: BigInteger, val maxFeePerGas: BigInteger) : Fee

Represents an EIP-1559 fee structure for EVM chains.

Link copied to clipboard
@Serializable
@SerialName(value = "evm_legacy")
data class EvmLegacyFee(val maxFeeWei: BigInteger, val l1FeeWei: BigInteger? = null, val gasLimit: BigInteger, val gasPrice: BigInteger) : Fee

Represents a legacy EVM fee structure (pre-EIP-1559).

Link copied to clipboard
@Serializable
@SerialName(value = "failed")
data class Failed(val hash: String, val error: String) : TransactionStatus

Represents a failed transaction that was mined but reverted.

Link copied to clipboard
@Serializable
sealed class Fee

Represents a transaction fee structure.

Link copied to clipboard
@Serializable
@SerialName(value = "native_coin")
data class NativeCoin(val network: Network, val contract: String? = null) : Asset

Represents a native blockchain coin (e.g., ETH, BTC).

Link copied to clipboard
@Serializable
@SerialName(value = "not_found")
data class NotFound(val hash: String) : TransactionStatus

Represents a transaction that was not found on the blockchain.

Link copied to clipboard
@Serializable
@SerialName(value = "pending")
data class Pending(val hash: String) : TransactionStatus

Represents a pending transaction that has been submitted to the mempool but has not yet been included in a block.

Link copied to clipboard
@Serializable
data class PreImageTx(val preSigningOutput: ByteArray, val signingInputData: ByteArray, val network: Network)

Container for pre-image hash data needed for MPC signing.

Link copied to clipboard
@Serializable
@SerialName(value = "token")
data class Token(val network: Network, val contract: String, val tokenType: TokenType, val symbol: String = "", val tokenId: String = "", val decimals: Int = 18) : Asset

Represents a token on a blockchain network (e.g., ERC-20).

Link copied to clipboard
@Serializable
enum TokenType : Enum<TokenType>

Token standard types supported for EVM blockchains.

Link copied to clipboard
@Serializable
sealed class Transaction

Represents a blockchain transaction.

Link copied to clipboard
@Serializable
sealed class TransactionStatus

Represents the status of a blockchain transaction.

Link copied to clipboard

Type alias for the result of a transaction status query operation.

Link copied to clipboard
@Serializable
data class TransactionStatusUpdate(val hash: String, val networkId: String, val status: TransactionStatus, val timestampMs: Long, val isFinal: Boolean, val error: String? = null)

Represents a transaction status update emitted by the polling tracker.

Link copied to clipboard
@Serializable
@SerialName(value = "transfer")
data class Transfer(val asset: Asset, val amount: BigInteger, val to: String, val isMax: Boolean = false, val memo: String? = null) : Transaction

Represents a simple asset transfer transaction.