libnexakotlin/org.nexa.libnexakotlin/Pay2TemplateDestination

Pay2TemplateDestination

open class Pay2TemplateDestination(chain: ChainSelector) : PayDestination

Inheritors

InteractiveMultisigDestination

MultisigDestination

Constructors

Pay2TemplateDestination

constructor(chain: ChainSelector)

Types

Companion

object Companion

Properties

address

open override val address: PayAddress

Get the %budoc/glossary/P2SH or %budoc/glossary/P2PKH address associated with this destination Note that only a subset of PayDestinations have addresses. A PayAddress will only exist if this destination constrains spending to require a signature (in the P2PKH case) or a script (P2SH case)

atomicSpending

open val atomicSpending: Boolean = true

All derived classes that require the execution of a potentially interactive protocol to spend should set this to false and implement member fns

bloomFilterData

open override val bloomFilterData: ByteArray?

Return a set of bytes that can be put into a bloom filter to select any transaction that contains this destination

chainSelector

val chainSelector: ChainSelector

derivedType

open override val derivedType: Int

What type of destination is this?

group

var group: GroupInfo?

index

open var index: Long

If a Bip44 wallet, this is be the BIP44 index. Otherwise its the an incrementing integer every time a new destination is created

oneUse

var oneUse: Boolean

An indication to retire this address as soon as coins are received (typically used for change). RAM only

pubkey

open override val pubkey: ByteArray? = null

Get the public key if a single signature is needed to spend this destination

secret

open override var secret: Secret?

Get the secret key if a single signature is needed to spend this destination

useHash160ForConstraintArgs

var useHash160ForConstraintArgs: Boolean

useHash160ForTemplate

var useHash160ForTemplate: Boolean

Functions

BCHdeserialize

open override fun BCHdeserialize(stream: BCHserialized): BCHserialized

BCHserialize

open override fun BCHserialize(format: SerializationType): BCHserialized

beginProposal

open fun beginProposal(tx: iTransaction, inputIdx: Int): SpendingProposal?

If atomicSpending is false, this is how you initiate whatever protocol is needed to sign this transaction. This should only be called if this is your own spending proposal (it is expected that the user has already agreed to this spend)

constraintArgsHash

open fun constraintArgsHash(): ByteArray?

groupedLockingScript

open override fun groupedLockingScript(groupId: GroupId, groupAmount: Long): SatoshiScript

Get the output script needed to send tokens to this group destination. This script will contain spend constraints in the non-P2SH case, or in the P2SH case this script only constrains spending to execution of the redeemScript and any additional constraints are located in the redeemScript

lockingScript

open override fun lockingScript(): SatoshiScript

Get the locking script needed to send coins to this destination. This script will contain spend constraints in the non-template case, or in the template/P2SH case this script contains the hash of the template/redeem script.

output

open fun output(satoshis: Long): iTxOutput

Get an output (constrained to this destination) suitable for placing in a transaction

pkh

fun pkh(): ByteArray?

Calculate the public key hash (PKH)

satisfierScript

open override fun satisfierScript(flatTx: ByteArray, inputIdx: Long, sigHashType: ByteArray, inputAmount: Long, spendingProposal: SpendingProposal?): SatoshiScript

serializeDerived

open override fun serializeDerived(format: SerializationType): BCHserialized

serializeTypeAndDerived

fun serializeTypeAndDerived(ser: BCHserialized): BCHserialized

fun serializeTypeAndDerived(st: SerializationType): BCHserialized

serialize any derived class & the type indicator

templateScript

open override fun templateScript(): SatoshiScript

Get the template script needed to spend this destination. This script is committed to in the locking script via hash, and must be provided in full in the unlocking script. For P2SH blockchains, this will return the redeemScript since templates are a generalization of P2SH.

toByteArray

open fun toByteArray(format: SerializationType = SerializationType.UNKNOWN): ByteArray

ungroupedLockingScript

open fun ungroupedLockingScript(): SatoshiScript

Get the output script needed to send native coins to this destination. This script will contain spend constraints in the non-P2SH case, or in the P2SH case this script only constrains spending to execution of the redeemScript and any additional constraints are located in the redeemScript

unlockingScript

open override fun unlockingScript(vararg params: ByteArray): SatoshiScript

Create a spend (input) script that will satisfy the constraints specified by the lockingScript and the templateScript (if applicable). This script will contain the redeemScript in the P2SH case.

open override fun unlockingScript(flatTx: ByteArray, inputIdx: Long, sigHashType: ByteArray, inputAmount: Long, spendingProposal: SpendingProposal?): SatoshiScript

Create a spend (input) script that will satisfy the constraints specified by the lockingScript and the templateScript (if applicable). This script will contain the redeemScript in the P2SH case. Many scripts require signatures. This API provides the data needed for this class to craft signatures, and provides additional derived-class defined params.