Core API Reference¶

Bool ¶

Bytes ¶

Construction Examples:

0xC0FFEE (hex)
0zSGVsbG8gV29ybGQ= (base64, = is optional)
bytes("Hello")
bytes($tx)
bytes(xpub661MyMwAZ92K…cotpLmSkMxrp99L)
cf24d08f2d5b63cc564ad83a4e6e1bae359a049c (0x is optional for lengths 20/32/33)

Coerces from:

String
Int | Bool – using CScriptNum serialization
Script | Transaction – using consensus serialization
Psbt – using the BIP 174 serialization format
PubKey<Xpub> | SecKey<Xpriv> – using the BIP 32 serialization format (78 bytes, key origin information is lost)
PubKey<SingleKey> | SecKey<SingleKey> – encoded as raw key (32/33 bytes, key origin information is lost)

Underlying type: Vec<u8>

bytes() ¶

bytes(String|Int|Bool|Script|Transaction|Psbt|PubKey|SecKey|Bytes) -> Bytes

Rust source code: src/stdlib/mod.rs:222

String ¶

str() ¶

str(Any) -> String

Rust source code: src/stdlib/mod.rs:205

Int ¶

int() ¶

int(Int|Float|String) -> Int

Rust source code: src/stdlib/mod.rs:180

MAX_INTEGER `Int` ¶

MAX_INTEGER = 9223372036854775807

MIN_INTEGER `Int` ¶

MIN_INTEGER = -9223372036854775808

Float ¶

float() ¶

float(Int|Float|String) -> Float

Rust source code: src/stdlib/mod.rs:191

MAX_FLOAT `Float` ¶

MIN_FLOAT `Float` ¶

NaN `Float` ¶

NaN = NaN_f64

Not a Number. Returned by some floating-point operations, like 0.0/0.0.

inf `Float` ¶

inf = +Inf_f64

Point at Infinity. Returned by some floating-point operations, like 1.0/0.0.

Symbol ¶

symbol() ¶

symbol(name: String = None) -> Symbol

Rust source code: src/stdlib/mod.rs:215

Function ¶

Array ¶

Array->(𝘢𝘯𝘺) ¶

ArrayLike ¶

The types listed below are Array-like – they have a len(), can be used with the . index access operator, work with array utility functions like map(), and can be unpacked using destructuring assignment.

Bytes ($bytes.N returns Int<u8>)
String ($str.N returns String)
PubKey<MultiPath> ($pubkey.N returns PubKey<SinglePath>)
SecKey<MultiPath> ($seckey.N returns SecKey<SinglePath>)
Descriptor<MultiPath> ($descriptor.N returns Descriptor<SinglePath>)

Policy<MultiPath> should be array-like too, but currently isn't.

General¶

typeof() ¶

typeof(Any) -> String

One of: int, float, bool, bytes, string, array, function, symbol, pubkey, seckey, policy, withprob, descriptor, address, script, transaction, network, tapinfo, wshinfo or psbt

Rust source code: src/stdlib/mod.rs:113

len() ¶

len(Array|Bytes|String|Script|Descriptor<MultiPath>|PubKey<MultiPath>|PubKey<MultiPath>) -> Int

Rust source code: src/stdlib/mod.rs:119

throw() ¶

throw(...String)

Rust source code: src/stdlib/mod.rs:292

concat() ¶

concat(Array<T>) -> T|null

Concatenates array elements by applying the + operator.

If there are no elements, null is returned.

Can be used with an explicit initial element to force a return type and avoid nulls.
For example: concat([0x]+$maybe_empty_array_of_bytes) or concat([""]+$array_to_stringify)

Works with all +-supporting types (Bytes|String|Array|Int|Float), however the specialized join()/flatten()/sum()/fsum() functions on top of concat() should be preferred since they return ""/[]/0/0.0 for empty arrays rather than null.

Minsc source code: src/stdlib/stdlib.minsc:42

Numeric¶

abs() ¶

abs(Int|Float) -> Int|Float

Minsc source code: src/stdlib/stdlib.minsc:68

min() ¶

min(Array<Int|Float>) -> Int|Float|null

Minsc source code: src/stdlib/stdlib.minsc:70

max() ¶

max(Array<Int|Float>) -> Int|Float|null

Minsc source code: src/stdlib/stdlib.minsc:69

sum() ¶

sum(Array<Int>) -> Int

Minsc source code: src/stdlib/stdlib.minsc:71

fsum() ¶

fsum(Array<Float>) -> Float

Minsc source code: src/stdlib/stdlib.minsc:72

String¶

join() ¶

join(strs: Array<String>, separator: String = "") -> String

Minsc source code: src/stdlib/stdlib.minsc:79

Array¶

map() ¶

map(arr: Array, fn: Function) -> Array

Minsc source code: src/stdlib/stdlib.minsc:24

flatMap() ¶

flatMap(arr: Array, fn: Function) -> Array

Minsc source code: src/stdlib/stdlib.minsc:26

filter() ¶

filter(arr: Array, predicate: Function) -> Array

Minsc source code: src/stdlib/stdlib.minsc:25

filterMap() ¶

filterMap(arr: Array, fn: Function) -> Array

Minsc source code: src/stdlib/stdlib.minsc:31

filterMap::skip `Symbol` ¶

each() ¶

each(arr: Array, fn: Function)

Minsc source code: src/stdlib/stdlib.minsc:27

reduce() ¶

reduce(arr: Array, fn: Function) -> Any

Minsc source code: src/stdlib/stdlib.minsc:29

fold() ¶

fold(arr: Array, initial: Any, fn: Function) -> Any

Rust source code: src/stdlib/mod.rs:135

foldUntil() ¶

foldUntil(arr: Array, initial: Any, fn: Function) -> Any

Rust source code: src/stdlib/mod.rs:148

slice() ¶

slice(arr: Array<T>, start: Int, len: Int = {ALL}) -> Array<T>

Minsc source code: src/stdlib/stdlib.minsc:18

tail() ¶

tail(Array<T>) -> Array<T>

Minsc source code: src/stdlib/stdlib.minsc:19

initial() ¶

initial(Array<T>) -> Array<T>

Minsc source code: src/stdlib/stdlib.minsc:20

last() ¶

last(Array<T>) -> T

Minsc source code: src/stdlib/stdlib.minsc:15

find() ¶

find(arr: Array<T>, predicate: Function) -> T|null

Minsc source code: src/stdlib/stdlib.minsc:34

some() ¶

some(arr: Array<T>, predicate: Function) -> Bool

Minsc source code: src/stdlib/stdlib.minsc:35

every() ¶

every(arr: Array<T>, predicate: Function) -> Bool

Minsc source code: src/stdlib/stdlib.minsc:36

contains() ¶

contains(arr: Array<T>, needle: T) -> Bool

Minsc source code: src/stdlib/stdlib.minsc:38

startsWith() ¶

startsWith(arr: Array<T>, prefix: Array<T>) -> Bool

Minsc source code: src/stdlib/stdlib.minsc:40

indices() ¶

indices(Array) -> Array<Int>

Minsc source code: src/stdlib/stdlib.minsc:17

enumerated() ¶

enumerated(Array<T>) -> Array<Int:T>

Minsc source code: src/stdlib/stdlib.minsc:21

reverse() ¶

reverse(Array<T>) -> Array<T>

Minsc source code: src/stdlib/stdlib.minsc:39

flatten() ¶

flatten(Array<Array<T>>) -> Array<T>

Minsc source code: src/stdlib/stdlib.minsc:43

fillArray() ¶

fillArray(size: Int, value: Any|Function) -> Array

Rust source code: src/stdlib/mod.rs:168

range() ¶

range(start: Int, end: Int) -> Array<Int>

Minsc source code: src/stdlib/stdlib.minsc:16

Tagged Arrays¶

keys() ¶

keys(Array<Key:Val>) -> Array<Key>

Minsc source code: src/stdlib/stdlib.minsc:52

values() ¶

values(Array<Key:Val>) -> Array<Val>

Minsc source code: src/stdlib/stdlib.minsc:53

get() ¶

get(tagged: Array<Key:Val>, key: Key, default_val: Any = null) -> Val|default_val

Get the value for key, or the default_val (null) if it does not exists.

Typically the $tagged->key field getter syntax can be used instead, however it throws an error when the field doesn't exists rather than return a default.

If the key has multiple values, returns MULTIVAL_TAG. Use mget() to get the actual values as an array.

Minsc source code: src/stdlib/stdlib.minsc:49

mget() ¶

mget(tagged: Array<Key:Val>, key: Key) -> Array<Val>

Get the value(s) for the given key as an array. Returns an empty array if none exists.

To get a single value, use the $tagged->key field getter syntax or get().

Minsc source code: src/stdlib/stdlib.minsc:50

set() ¶

set(original: Array<Key:Val>, fields: Array<Key:Val>) -> Array<Key:Val>

Minsc source code: src/stdlib/stdlib.minsc:55

set::UNSET `Symbol` ¶

unset() ¶

unset(original: Array<Key:Val>, keys: Array<Key>) -> Array<Key:Val>

Minsc source code: src/stdlib/stdlib.minsc:61

MULTIVAL_TAG `Symbol` ¶

A sentinel value returned by get() and $tagged->key to indicate the requested key has multiple values. mget() can be used to get them.

Encoding¶

hex() ¶

hex(Bytes) -> String

base64() ¶

base64(Bytes) -> String

repr() ¶

repr(Any) -> String

Rust source code: src/stdlib/mod.rs:251

pretty() ¶

pretty(Any) -> String

Rust source code: src/stdlib/mod.rs:259

le64() ¶

le64(Int) -> Bytes<8>

Also see: compactsize() and scriptnum()

Rust source code: src/stdlib/mod.rs:229

Logging¶

print() ¶

print(...String)

Rust source code: src/stdlib/mod.rs:298

log() ¶

log(...String)

Rust source code: src/stdlib/mod.rs:310

warn() ¶

warn(...String)

Rust source code: src/stdlib/mod.rs:317

Symbols¶

null `Symbol` ¶

default `Symbol` ¶

BOO `Symbol` ¶

Boo

Dev Utils¶

debug() ¶

debug(Any) -> String

Get the debug representation of the given value in Rust's std::fmt::Debug formatting

Rust source code: src/stdlib/mod.rs:236

env() ¶

env(depth: Int = -1) -> Array<Key:Value>

Rust source code: src/stdlib/mod.rs:279

env::debug() ¶

env::debug(depth: Int = -1) -> Symbol

Minsc source code: src/stdlib/stdlib.minsc:104

env::repr() ¶

env::repr(depth: Int = -1) -> Symbol

Minsc source code: src/stdlib/stdlib.minsc:103

env::pretty() ¶

env::pretty(depth: Int = -1) -> Symbol

Minsc source code: src/stdlib/stdlib.minsc:102