compact-engine/com.midnight.kuira.core.compact

Package-level declarations

Types

AlignedValue

data class AlignedValue(val value: List<ByteArray>, val alignmentJson: String)

Represents a field-aligned byte array value from the Midnight runtime.

BalanceProgress

sealed class BalanceProgress

Granular progress updates during the balance+submit pipeline.

CircuitExecutionException

class CircuitExecutionException(message: String) : Exception

Thrown when circuit execution or transaction assembly fails.

CircuitExecutor

class CircuitExecutor(context: Context, ioDispatcher: CoroutineDispatcher = Dispatchers.IO)

Executes Compact smart contract circuits on Android via QuickJS + Rust FFI.

CircuitResult

data class CircuitResult(val proofData: ProofData, val stateHandle: Long, val contractAddress: String, val entryPoint: String, val zswapLocalStateJson: String, val privateStateJson: String)

Full result from executing a contract circuit in QuickJS.

ContractCallException

sealed class ContractCallException : Exception

Typed errors from MidnightContract.call — each stage has its own subclass.

ContractCallStage

sealed class ContractCallStage

Progress stages emitted during MidnightContract.call.

ContractRuntime

object ContractRuntime

Native bridge to the Rust contract runtime.

DAppConnectorClient

class DAppConnectorClient(wsUrl: String) : TransactionBalancer

Connects to a DApp Connector wallet (e.g., mn serve) via WebSocket JSON-RPC.

DeployExecutionResult

data class DeployExecutionResult(val unprovenTxHex: String, val contractAddress: String)

Result of contract deployment assembly.

DeployResult

data class DeployResult(val contractAddress: String, val timings: DeployTimings)

Result of deploying a contract to the blockchain.

DeployTimings

data class DeployTimings(val executeMs: Long, val proveMs: Long, val balanceMs: Long)

ExecutionResult

data class ExecutionResult(val unprovenTxHex: String, val txParamsJson: String)

Result of circuit execution and transaction assembly.

KeyStorePrivateStateProvider

typealias KeyStorePrivateStateProvider = com.midnight.kuira.core.compact.state.KeyStorePrivateStateProvider

LedgerReadException

class LedgerReadException(message: String) : Exception

Thrown by LedgerEvaluator.readAll when the JS read pipeline fails.

LocalProofProvider

class LocalProofProvider(provingKeyManager: ProvingKeyManager) : ProofProvider

Proves transactions locally on the phone using cached proving keys.

MidnightConfig

class MidnightConfig

Configuration for Midnight contract operations.

MidnightContract

class MidnightContract

High-level interface for calling Midnight smart contract circuits from Android.

MidnightLedger

class MidnightLedger

A typed, eagerly-evaluated snapshot of a deployed contract's ledger.

MissingLedgerFieldException

class MissingLedgerFieldException(val fieldName: String, val knownFields: Set<String>) : Exception

Thrown when MidnightLedger is asked for a field that doesn't exist in the contract's schema. The exception lists knownFields so a typo or version mismatch can be diagnosed immediately.

PipelineTimings

data class PipelineTimings(val fetchStateMs: Long = 0, val executeMs: Long = 0, val proveMs: Long = 0, val balanceMs: Long = 0, val submitMs: Long = 0)

Timing breakdown for each pipeline stage (milliseconds).

PreparedTransaction

data class PreparedTransaction(val provenTxHex: String, val contractAddress: String, val circuitName: String, val timings: PipelineTimings)

Result of MidnightContract.prepare — a proven transaction ready for later submission via MidnightConfig.submit.

PrivateStateProvider

typealias PrivateStateProvider = com.midnight.kuira.core.compact.state.PrivateStateProvider

ProofData

data class ProofData(val input: AlignedValue, val output: AlignedValue, val publicTranscriptJson: String, val privateTranscriptOutputs: List<AlignedValue>)

Proof data produced by a circuit execution.

ProofProvider

interface ProofProvider

Generates ZK proofs for unproven transactions.

ProvingException

class ProvingException(message: String) : Exception

Thrown when ZK proof generation fails.

TransactionBalancer

interface TransactionBalancer

Abstracts the wallet operations needed to finalize a proven transaction: adding dust fee inputs (balancing) and submitting to the blockchain.

TransactionReceipt

data class TransactionReceipt(val txHash: String?, val status: TransactionStatus, val timings: PipelineTimings, val provenTxHex: String)

Result of a successful MidnightContract.call.

TransactionStatus

enum TransactionStatus : Enum<TransactionStatus>

WitnessKind

enum WitnessKind : Enum<WitnessKind>

How the witness's WitnessResult.data bytes should be presented to the Compact runtime when the witness function is called from JS.

WitnessProvider

fun interface WitnessProvider

Provides witness data for circuit execution.

WitnessResult

data class WitnessResult(val privateState: Any?, val data: ByteArray, val kind: WitnessKind = WitnessKind.BYTES)

Result of a witness callback.

WrongLedgerFieldTypeException

class WrongLedgerFieldTypeException(val fieldName: String, val expected: String, val actualValue: Any?) : Exception

Thrown when a typed accessor's expectation doesn't match what the contract's getter returned. Indicates schema drift, version mismatch, or a wrong-type call on the caller's side.