bitcoin-kmp/fr.acinq.bitcoin/Script

Script

object Script

Types

data class Context( val tx: Transaction, val inputIndex: Int, val amount: Satoshi, val prevouts: List<TxOut>)

Execution context of a tx script. A script is always executed in the "context" of a transaction that is being verified.

data class ExecutionData( val annex: ByteVector?, val tapleafHash: ByteVector32?, val validationWeightLeft: Int? = null, val codeSeparatorPos: Long = 4294967295)

class Runner(val context: Script.Context, val scriptFlag: Int = ScriptFlags.MANDATORY_SCRIPT_VERIFY_FLAGS)

Functions

fun checkLockTime( lockTime: Long, tx: Transaction, inputIndex: Int): Boolean

fun checkSequence( sequence: Long, tx: Transaction, inputIndex: Int): Boolean

fun cost(op: ScriptElt): Int

createMultiSigMofN

fun createMultiSigMofN(m: Int, pubkeys: List<PublicKey>): List<ScriptElt>

Creates a m-of-n multisig script.

fun decodeNumber( input: ByteVector, checkMinimalEncoding: Boolean, maximumSize: Int = 4): Long

fun decodeNumber( input: ByteArray, checkMinimalEncoding: Boolean, maximumSize: Int = 4): Long

fun <T> List<T>.dropCheck(n: Int): List<T>

fun encodeNumber(value: Int): ByteVector

fun encodeNumber(value: Long): ByteVector

fromSimpleValue

fun fromSimpleValue(value: Byte): ScriptElt

getWitnessVersion

fun getWitnessVersion(script: ByteVector): Int?

fun getWitnessVersion(script: List<ScriptElt>): Int?

fun isDisabled(op: ScriptElt): Boolean

isNativeWitnessScript

fun isNativeWitnessScript(script: ByteVector): Boolean

fun isNativeWitnessScript(script: List<ScriptElt>): Boolean

fun isOpSuccess(opcode: Int): Boolean

fun isPay2pkh(script: ByteArray): Boolean

fun isPay2pkh(script: List<ScriptElt>): Boolean

fun isPay2sh(script: ByteArray): Boolean

fun isPay2sh(script: List<ScriptElt>): Boolean

fun isPay2wpkh(script: ByteArray): Boolean

fun isPay2wpkh(script: List<ScriptElt>): Boolean

fun isPay2wsh(script: ByteArray): Boolean

fun isPay2wsh(script: List<ScriptElt>): Boolean

fun isPayToScript(script: ByteArray): Boolean

fun isPushOnly(script: List<ScriptElt>): Boolean

fun isSimpleValue(op: ScriptElt): Boolean

isUpgradableNop

fun isUpgradableNop(op: ScriptElt): Boolean

fun parse(blob: ByteVector): List<ScriptElt>

fun parse(blob: ByteArray): List<ScriptElt>

fun parse(hex: String): List<ScriptElt>

fun parse(input: Input): List<ScriptElt>

parse a script from a input stream of binary data

fun pay2pkh(pubKey: PublicKey): List<ScriptElt>

fun pay2pkh(pubKeyHash: ByteArray): List<ScriptElt>

fun pay2sh(script: ByteArray): List<ScriptElt>

fun pay2sh(script: List<ScriptElt>): List<ScriptElt>

fun pay2tr(pubkey: XonlyPublicKey): List<ScriptElt>

fun pay2wpkh(pubKey: PublicKey): List<ScriptElt>

fun pay2wpkh(pubKeyHash: ByteArray): List<ScriptElt>

fun pay2wsh(script: ByteVector): List<ScriptElt>

fun pay2wsh(script: ByteArray): List<ScriptElt>

fun pay2wsh(script: List<ScriptElt>): List<ScriptElt>

fun pushSize(op: ScriptElt): Int?

removeSignature

fun removeSignature(script: List<ScriptElt>, signature: ByteVector): List<ScriptElt>

removeSignatures

fun removeSignatures(script: List<ScriptElt>, sigs: List<ByteVector>): List<ScriptElt>

fun scriptIterator(input: Input): Iterator<ScriptElt>

fun scriptIterator(script: ByteArray): Iterator<ScriptElt>

fun sigHashType(sig: ByteVector): Int

fun sigHashType(sig: ByteArray): Int

fun simpleValue(op: ScriptElt): Byte

fun <T> List<T>.tail(): List<T>

witnessMultiSigMofN

fun witnessMultiSigMofN(pubKeys: List<PublicKey>, sigs: List<ByteVector>): ScriptWitness

witnessPay2wpkh

fun witnessPay2wpkh(pubKey: PublicKey, sig: ByteVector): ScriptWitness

fun write(script: List<ScriptElt>): ByteArray

fun write(script: List<ScriptElt>, out: Output)

Properties

val False: ByteVector

LOCKTIME_THRESHOLD

const val LOCKTIME_THRESHOLD: Long = 500000000

MAX_OPS_PER_SCRIPT

const val MAX_OPS_PER_SCRIPT: Int = 201

MAX_SCRIPT_ELEMENT_SIZE

const val MAX_SCRIPT_ELEMENT_SIZE: Int = 520

MAX_SCRIPT_SIZE

const val MAX_SCRIPT_SIZE: Int = 10000

const val MAX_STACK_SIZE: Int = 1000

TAPROOT_LEAF_MASK

const val TAPROOT_LEAF_MASK: Int = 254

TAPROOT_LEAF_TAPSCRIPT

const val TAPROOT_LEAF_TAPSCRIPT: Int = 192

val True: ByteVector

VALIDATION_WEIGHT_OFFSET

const val VALIDATION_WEIGHT_OFFSET: Int = 50

VALIDATION_WEIGHT_PER_SIGOP_PASSED

const val VALIDATION_WEIGHT_PER_SIGOP_PASSED: Int = 50

WITNESS_V0_KEYHASH_SIZE

const val WITNESS_V0_KEYHASH_SIZE: Int = 20

WITNESS_V0_SCRIPTHASH_SIZE

const val WITNESS_V0_SCRIPTHASH_SIZE: Int = 32

WITNESS_V1_TAPROOT_SIZE

const val WITNESS_V1_TAPROOT_SIZE: Int = 32