libnexakotlin/org.nexa.libnexakotlin/PayDestination

PayDestination

abstract class PayDestination(val chainSelector: ChainSelector) : BCHserializable

A destination for payments. This includes all the information needed to send and spend from this destination. It is often assumed that Bitcoin addresses are payment destinations, but this is not true. You really need an output script, and also (if P2SH) a redeem script. The reason why P2PKH addresses "work" as payment destinations is because they imply a specific script. But "baking in" this assumption will make the wallet a lot less flexible.

Inheritors

Pay2PubKeyHashDestination

Pay2PubKeyTemplateDestination

Pay2ScriptPubKeyDestination

Pay2ScriptHashDestination

Constructors

PayDestination

constructor(chainSelector: ChainSelector)

Types

Companion

object Companion

Properties

address

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

bloomFilterData

open 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 val derivedType: Int = 0

What type of destination is this?

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

abstract val pubkey: ByteArray?

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

secret

abstract val secret: Secret?

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

Functions

argsHash

open fun argsHash(): ByteArray?

BCHdeserialize

open override fun BCHdeserialize(stream: BCHserialized): BCHserialized

BCHserialize

open override fun BCHserialize(format: SerializationType): BCHserialized

constraintScript

fun constraintScript(): SatoshiScript

Get the constraint script needed to send 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

groupedConstraintScript

fun groupedConstraintScript(groupId: GroupId, groupAmount: Long): SatoshiScript

groupedOutputScript

open fun groupedOutputScript(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

grouplessConstraintScript

open fun grouplessConstraintScript(): SatoshiScript

Get the groupless suffix constraint script needed to send coins to this destination. In other words, this is not a complete output script -- it needs a prefix to either choose no group (NEXA) or a group. It is used as a fragment in script template operations.

output

open fun output(satoshis: Long): iTxOutput

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

outputScript

open fun outputScript(): SatoshiScript

pkh

fun pkh(): ByteArray?

Calculate the public key hash (PKH)

redeemScript

open fun redeemScript(): SatoshiScript

Get the %budoc/glossary/P2SH %budoc/glossary/redeem_script needed to spend this destination.

satisfierScript

fun satisfierScript(flatTx: ByteArray, inputIdx: Long, sigHashType: ByteArray, inputAmount: Long, vararg params: ByteArray): SatoshiScript

serializeDerived

abstract fun serializeDerived(format: SerializationType): BCHserialized

serializeTypeAndDerived

fun serializeTypeAndDerived(ser: BCHserialized): BCHserialized

fun serializeTypeAndDerived(st: SerializationType): BCHserialized

serialize any derived class & the type indicator

spendScript

open fun spendScript(vararg params: ByteArray): SatoshiScript

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

open fun spendScript(flatTx: ByteArray, inputIdx: Long, sigHashType: ByteArray, inputAmount: Long, vararg params: ByteArray): SatoshiScript

Create a spend (input) script that will satisfy the constraints specified by the outputScript and the redeemScript (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.

toByteArray

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

ungroupedOutputScript

open fun ungroupedOutputScript(): 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