Pipeline helpers for building scripts in BSV.Contract modules.
When you use BSV.Contract, this module is automatically imported, providing:
Summary
Functions
Decode top stack item as unsigned integer (little-endian ScriptNum).
Iterate over an enumerable, applying a function that takes (element, contract).
Push OP_0 onto the script.
Push OP_0NOTEQUAL onto the script.
Push OP_1 onto the script.
Push OP_1ADD onto the script.
Push OP_1NEGATE onto the script.
Push OP_1SUB onto the script.
Push OP_2 onto the script.
Push OP_2DROP onto the script.
Push OP_2DUP onto the script.
Push OP_2OVER onto the script.
Push OP_2ROT onto the script.
Push OP_2SWAP onto the script.
Push OP_3 onto the script.
Push OP_3DUP onto the script.
Push OP_4 onto the script.
Push OP_5 onto the script.
Push OP_6 onto the script.
Push OP_7 onto the script.
Push OP_8 onto the script.
Push OP_9 onto the script.
Push OP_10 onto the script.
Push OP_11 onto the script.
Push OP_12 onto the script.
Push OP_13 onto the script.
Push OP_14 onto the script.
Push OP_15 onto the script.
Push OP_16 onto the script.
Push OP_ABS onto the script.
Push OP_ADD onto the script.
Push OP_AND onto the script.
Push OP_BIN2NUM onto the script.
Push OP_BOOLAND onto the script.
Push OP_BOOLOR onto the script.
Push OP_CAT onto the script.
Push OP_CHECKMULTISIG onto the script.
Push OP_CHECKMULTISIGVERIFY onto the script.
Push OP_CHECKSIG onto the script.
Push OP_CHECKSIGVERIFY onto the script.
Push OP_CODESEPARATOR onto the script.
Push OP_DEPTH onto the script.
Push OP_DIV onto the script.
Push OP_DROP onto the script.
Push OP_DUP onto the script.
Push OP_ELSE onto the script.
Push OP_ENDIF onto the script.
Push OP_EQUAL onto the script.
Push OP_EQUALVERIFY onto the script.
Push OP_0 onto the script.
Push OP_FROMALTSTACK onto the script.
Push OP_GREATERTHAN onto the script.
Push OP_GREATERTHANOREQUAL onto the script.
Push OP_HASH160 onto the script.
Push OP_HASH256 onto the script.
Push OP_IF onto the script.
Wrap handle_if between OP_IF and OP_ENDIF.
Wrap handle_if/handle_else between OP_IF, OP_ELSE, OP_ENDIF.
Push OP_IFDUP onto the script.
Push OP_INVERT onto the script.
Push OP_LESSTHAN onto the script.
Push OP_LESSTHANOREQUAL onto the script.
Push OP_LSHIFT onto the script.
Push OP_MAX onto the script.
Push OP_MIN onto the script.
Push OP_MOD onto the script.
Push OP_MUL onto the script.
Push OP_NEGATE onto the script.
Push OP_NIP onto the script.
Push OP_NOP onto the script.
Push OP_NOT onto the script.
Push OP_NOTIF onto the script.
Wrap handle between OP_NOTIF and OP_ENDIF.
Wrap handle_if/handle_else between OP_NOTIF, OP_ELSE, OP_ENDIF.
Push OP_NUM2BIN onto the script.
Push OP_NUMEQUAL onto the script.
Push OP_NUMEQUALVERIFY onto the script.
Push OP_NUMNOTEQUAL onto the script.
Push OP_OR onto the script.
Push OP_OVER onto the script.
Push OP_PICK onto the script.
Push OP_RETURN onto the script.
Push OP_RIPEMD160 onto the script.
Push OP_ROLL onto the script.
Push OP_ROT onto the script.
Push OP_RSHIFT onto the script.
Push OP_SHA1 onto the script.
Push OP_SHA256 onto the script.
Push OP_SIZE onto the script.
Push OP_SPLIT onto the script.
Push OP_SUB onto the script.
Push OP_SWAP onto the script.
Push OP_TOALTSTACK onto the script.
Push OP_1 onto the script.
Push OP_TUCK onto the script.
Push OP_VERIFY onto the script.
Push OP_WITHIN onto the script.
Push OP_XOR onto the script.
Push data (binary), an opcode tuple, or a list of items onto the script.
Repeat n times, calling fun.(index, contract).
Reverse the top stack item of length bytes using script ops.
Sign the transaction context and push the DER signature (with sighash flag) onto the script.
Extract bytes from top stack item: start index for length bytes.
Trim leading (positive) or trailing (negative) bytes from top stack item.
Functions
@spec decode_uint(BSV.Contract.t()) :: BSV.Contract.t()
Decode top stack item as unsigned integer (little-endian ScriptNum).
@spec each(BSV.Contract.t(), Enum.t(), (Enum.element(), BSV.Contract.t() -> BSV.Contract.t())) :: BSV.Contract.t()
Iterate over an enumerable, applying a function that takes (element, contract).
@spec op_0(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_0 onto the script.
@spec op_0notequal(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_0NOTEQUAL onto the script.
@spec op_1(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_1 onto the script.
@spec op_1add(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_1ADD onto the script.
@spec op_1negate(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_1NEGATE onto the script.
@spec op_1sub(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_1SUB onto the script.
@spec op_2(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_2 onto the script.
@spec op_2drop(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_2DROP onto the script.
@spec op_2dup(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_2DUP onto the script.
@spec op_2over(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_2OVER onto the script.
@spec op_2rot(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_2ROT onto the script.
@spec op_2swap(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_2SWAP onto the script.
@spec op_3(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_3 onto the script.
@spec op_3dup(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_3DUP onto the script.
@spec op_4(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_4 onto the script.
@spec op_5(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_5 onto the script.
@spec op_6(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_6 onto the script.
@spec op_7(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_7 onto the script.
@spec op_8(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_8 onto the script.
@spec op_9(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_9 onto the script.
@spec op_10(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_10 onto the script.
@spec op_11(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_11 onto the script.
@spec op_12(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_12 onto the script.
@spec op_13(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_13 onto the script.
@spec op_14(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_14 onto the script.
@spec op_15(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_15 onto the script.
@spec op_16(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_16 onto the script.
@spec op_abs(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_ABS onto the script.
@spec op_add(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_ADD onto the script.
@spec op_and(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_AND onto the script.
@spec op_bin2num(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_BIN2NUM onto the script.
@spec op_booland(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_BOOLAND onto the script.
@spec op_boolor(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_BOOLOR onto the script.
@spec op_cat(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_CAT onto the script.
@spec op_checkmultisig(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_CHECKMULTISIG onto the script.
@spec op_checkmultisigverify(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_CHECKMULTISIGVERIFY onto the script.
@spec op_checksig(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_CHECKSIG onto the script.
@spec op_checksigverify(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_CHECKSIGVERIFY onto the script.
@spec op_codeseparator(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_CODESEPARATOR onto the script.
@spec op_depth(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_DEPTH onto the script.
@spec op_div(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_DIV onto the script.
@spec op_drop(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_DROP onto the script.
@spec op_dup(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_DUP onto the script.
@spec op_else(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_ELSE onto the script.
@spec op_endif(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_ENDIF onto the script.
@spec op_equal(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_EQUAL onto the script.
@spec op_equalverify(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_EQUALVERIFY onto the script.
@spec op_false(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_0 onto the script.
@spec op_fromaltstack(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_FROMALTSTACK onto the script.
@spec op_greaterthan(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_GREATERTHAN onto the script.
@spec op_greaterthanorequal(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_GREATERTHANOREQUAL onto the script.
@spec op_hash160(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_HASH160 onto the script.
@spec op_hash256(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_HASH256 onto the script.
@spec op_if(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_IF onto the script.
@spec op_if(BSV.Contract.t(), (BSV.Contract.t() -> BSV.Contract.t())) :: BSV.Contract.t()
Wrap handle_if between OP_IF and OP_ENDIF.
@spec op_if( BSV.Contract.t(), (BSV.Contract.t() -> BSV.Contract.t()), (BSV.Contract.t() -> BSV.Contract.t()) ) :: BSV.Contract.t()
Wrap handle_if/handle_else between OP_IF, OP_ELSE, OP_ENDIF.
@spec op_ifdup(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_IFDUP onto the script.
@spec op_invert(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_INVERT onto the script.
@spec op_lessthan(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_LESSTHAN onto the script.
@spec op_lessthanorequal(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_LESSTHANOREQUAL onto the script.
@spec op_lshift(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_LSHIFT onto the script.
@spec op_max(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_MAX onto the script.
@spec op_min(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_MIN onto the script.
@spec op_mod(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_MOD onto the script.
@spec op_mul(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_MUL onto the script.
@spec op_negate(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NEGATE onto the script.
@spec op_nip(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NIP onto the script.
@spec op_nop(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NOP onto the script.
@spec op_not(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NOT onto the script.
@spec op_notif(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NOTIF onto the script.
@spec op_notif(BSV.Contract.t(), (BSV.Contract.t() -> BSV.Contract.t())) :: BSV.Contract.t()
Wrap handle between OP_NOTIF and OP_ENDIF.
@spec op_notif( BSV.Contract.t(), (BSV.Contract.t() -> BSV.Contract.t()), (BSV.Contract.t() -> BSV.Contract.t()) ) :: BSV.Contract.t()
Wrap handle_if/handle_else between OP_NOTIF, OP_ELSE, OP_ENDIF.
@spec op_num2bin(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NUM2BIN onto the script.
@spec op_numequal(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NUMEQUAL onto the script.
@spec op_numequalverify(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NUMEQUALVERIFY onto the script.
@spec op_numnotequal(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_NUMNOTEQUAL onto the script.
@spec op_or(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_OR onto the script.
@spec op_over(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_OVER onto the script.
@spec op_pick(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_PICK onto the script.
@spec op_return(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_RETURN onto the script.
@spec op_ripemd160(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_RIPEMD160 onto the script.
@spec op_roll(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_ROLL onto the script.
@spec op_rot(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_ROT onto the script.
@spec op_rshift(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_RSHIFT onto the script.
@spec op_sha1(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_SHA1 onto the script.
@spec op_sha256(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_SHA256 onto the script.
@spec op_size(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_SIZE onto the script.
@spec op_split(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_SPLIT onto the script.
@spec op_sub(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_SUB onto the script.
@spec op_swap(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_SWAP onto the script.
@spec op_toaltstack(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_TOALTSTACK onto the script.
@spec op_true(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_1 onto the script.
@spec op_tuck(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_TUCK onto the script.
@spec op_verify(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_VERIFY onto the script.
@spec op_within(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_WITHIN onto the script.
@spec op_xor(BSV.Contract.t()) :: BSV.Contract.t()
Push OP_XOR onto the script.
@spec push(BSV.Contract.t(), binary() | Script.chunk() | [binary() | Script.chunk()]) :: BSV.Contract.t()
Push data (binary), an opcode tuple, or a list of items onto the script.
@spec repeat(BSV.Contract.t(), pos_integer(), (non_neg_integer(), BSV.Contract.t() -> BSV.Contract.t())) :: BSV.Contract.t()
Repeat n times, calling fun.(index, contract).
@spec reverse(BSV.Contract.t(), pos_integer()) :: BSV.Contract.t()
Reverse the top stack item of length bytes using script ops.
@spec sig(BSV.Contract.t(), BSV.PrivateKey.t() | [BSV.PrivateKey.t()]) :: BSV.Contract.t()
Sign the transaction context and push the DER signature (with sighash flag) onto the script.
If the contract has a transaction context (ctx), computes the BIP-143 sighash
and signs with the private key. Otherwise pushes 71 zero bytes as a placeholder.
Accepts a single private key or a list (for multisig).
@spec slice(BSV.Contract.t(), integer(), non_neg_integer()) :: BSV.Contract.t()
Extract bytes from top stack item: start index for length bytes.
@spec trim(BSV.Contract.t(), integer()) :: BSV.Contract.t()
Trim leading (positive) or trailing (negative) bytes from top stack item.