Contracts have a UI; they need to display stuff and solicit user input. This defines a text-based interface into contracts. You can ask the WalletContract for a particular UI bu class via the WalletContract.ui function.

TimeLockTextUI

class TimeLockTextUI(val contract: TimeLockVault) : TextUI

TimeLockVault

class TimeLockVault(val name: String, val account: Bip44Wallet, var contractIndex: Long = 1, val chain: ChainSelector = account.chainSelector) : WalletContract

Wallet-facing half of the time lock vault: a non-interactive contract that locks coins to an address until a committed unlock value — a block height or, at/above the BIP-65 500,000,000 split, a Unix timestamp — is reached, after which only the holder of the committed private key can spend them.

TimeLockVaultDestination

class TimeLockVaultDestination(chain: ChainSelector, var unlockValue: Long, _secret: Secret, var hdIndex: Long, var contractName: String? = null) : Pay2TemplateDestination

Pay-to-Template destination for a single time lock vault.

TimeLockVaultType

object TimeLockVaultType : WalletContractType

WalletContract

interface WalletContract

WalletContractType

interface WalletContractType

Properties

contractCoCtxt

val contractCoCtxt: CloseableCoroutineDispatcher

contractTypes

val contractTypes: MutableMap<String, WalletContractType>

multisigLock

val multisigLock: iMutex

This map makes sure multiple interactions with the same transaction resolve to a single object in memory

multisigTxConstructionCache

val multisigTxConstructionCache: MutableMap<Hash256, iTransaction>

MultisigWakeupCount

var MultisigWakeupCount: Int

OneImd

val OneImd: MutableMap<String, InteractiveMultisigDestination>

OneImdLock

val OneImdLock: iMutex

Functions

clearOneImd

fun clearOneImd()

formMultisig

fun formMultisig(cs: ChainSelector, requiredSigs: Int, dests: Array<Bytes>): SatoshiScript

handleContractFormationInvitation

fun handleContractFormationInvitation(invitation: String, w: Wallet)

Given an invitation from someone else, call this function to begin the formation of a multi-party contract

fun handleContractFormationInvitation(invt: ContractFormationInvitation, w: Wallet)

initializeMultisigContractLibrary

fun initializeMultisigContractLibrary()

initializeTimeLockVaultLibrary

fun initializeTimeLockVaultLibrary()

Register the TimeLockVaultDestination deserializer so wallets can rehydrate spendables that carry one as their backingPayDestination. Call once at startup, after org.nexa.libnexakotlin.initializeLibNexa. Without this, any wallet that has signed a vault spend will throw "destination type not handled" on the next load.

interactiveMultisigDestinationOf

fun interactiveMultisigDestinationOf(chainSelector: ChainSelector, stream: BCHserialized, index: Long): InteractiveMultisigDestination

Deserialize an InteractiveMultisigDestination

fun interactiveMultisigDestinationOf(chainSelector: ChainSelector, walletName: String, contractName: String, convoSecret: ByteArray, minSigs: Int, pubkeys: Array<Bytes>, privkeys: Array<Secret?>, comms: ProtocolCommunication): InteractiveMultisigDestination

Create a InteractiveMultisigDestination, storing this object for later use since we really need one per destination to share communications channels

isQuote

fun Char.isQuote(): Boolean

isValidContractName

fun isValidContractName(name: String): Boolean

oneImdUniqueName

fun oneImdUniqueName(walletName: String, contractName: String, pubkeys: Array<Bytes>, minSigs: Int): String

timeLockVaultDestinationOf

fun timeLockVaultDestinationOf(chainSelector: ChainSelector, stream: BCHserialized, index: Long): TimeLockVaultDestination

Deserializer factory for the DestinationDeserializer map. Reads a TimeLockVaultDestination from a disk-format byte stream.

inline fun <T> WalletContract.ui(): T?

Return an object of the expected Wallet Contract Interface