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.

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

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()

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

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

Return an object of the expected Wallet Contract Interface