A chain hash (32-byte hash identifying a blockchain).

Construct a chain hash from a 32-byte bytestring.

Returns Nothing if the input is not exactly 32 bytes.

Extract the raw bytes from a chain hash.

A 32-byte channel identifier.

Construct a ChannelId from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

Extract the raw bytes from a ChannelId.

The all-zeros channel ID (connection-level errors).

A 64-byte compact ECDSA signature.

Construct a Signature from a 64-byte ByteString.

Returns Nothing if the input is not exactly 64 bytes.

Extract the raw bytes from a Signature.

A 33-byte compressed secp256k1 public key.

Construct a Point from a 33-byte ByteString.

Returns Nothing if the input is not exactly 33 bytes.

Extract the raw bytes from a Point.

A 32-byte SHA256 payment hash.

Construct a PaymentHash from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

Extract the raw bytes from a PaymentHash.

A 32-byte payment preimage.

Construct a PaymentPreimage from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

Extract the raw bytes from a PaymentPreimage.

A 32-byte per-commitment secret.

Construct a PerCommitmentSecret from a 32-byte ByteString.

Returns Nothing if the input is not exactly 32 bytes.

Extract the raw bytes from a PerCommitmentSecret.

A short channel identifier (8 bytes packed as Word64).

Encodes block height (3 bytes), transaction index (3 bytes), and output index (2 bytes).

Construct a ShortChannelId from components.

Returns Nothing if block height or tx index exceed 24 bits.

Extract the packed Word64 from a ShortChannelId.

Extract the block height from a ShortChannelId.

Extract the transaction index from a ShortChannelId.

Extract the output index from a ShortChannelId.

Amount in satoshis.

Amount in millisatoshis.

Convert Satoshi to MilliSatoshi.

Convert MilliSatoshi to Satoshi (rounds down).

Encode a 16-bit unsigned integer (big-endian).

>>> encodeU16 0x0102
"\SOH\STX"

Encode a 32-bit unsigned integer (big-endian).

>>> encodeU32 0x01020304
"\SOH\STX\ETX\EOT"

Encode a 64-bit unsigned integer (big-endian).

>>> encodeU64 0x0102030405060708
"\SOH\STX\ETX\EOT\ENQ\ACK\a\b"

Encode an 8-bit signed integer.

>>> encodeS8 42
"*"
>>> encodeS8 (-42)
"\214"

Encode a 16-bit signed integer (big-endian two's complement).

>>> encodeS16 0x0102
"\SOH\STX"
>>> encodeS16 (-1)
"\255\255"

Encode a 32-bit signed integer (big-endian two's complement).

>>> encodeS32 0x01020304
"\SOH\STX\ETX\EOT"
>>> encodeS32 (-1)
"\255\255\255\255"

Encode a 64-bit signed integer (big-endian two's complement).

>>> encodeS64 0x0102030405060708
"\SOH\STX\ETX\EOT\ENQ\ACK\a\b"
>>> encodeS64 (-1)
"\255\255\255\255\255\255\255\255"

Encode a truncated 16-bit unsigned integer (0-2 bytes).

Leading zeros are omitted per BOLT #1. Zero encodes to empty.

>>> encodeTu16 0
""
>>> encodeTu16 1
"\SOH"
>>> encodeTu16 256
"\SOH\NUL"

Encode a truncated 32-bit unsigned integer (0-4 bytes).

Leading zeros are omitted per BOLT #1. Zero encodes to empty.

>>> encodeTu32 0
""
>>> encodeTu32 1
"\SOH"
>>> encodeTu32 0x010000
"\SOH\NUL\NUL"

Encode a truncated 64-bit unsigned integer (0-8 bytes).

Leading zeros are omitted per BOLT #1. Zero encodes to empty.

>>> encodeTu64 0
""
>>> encodeTu64 1
"\SOH"
>>> encodeTu64 0x0100000000
"\SOH\NUL\NUL\NUL\NUL"

Encode a signed 64-bit integer using minimal bytes.

Uses the smallest number of bytes that can represent the value in two's complement. Per BOLT #1 Appendix D test vectors.

>>> encodeMinSigned 0
"\NUL"
>>> encodeMinSigned 127
"\DEL"
>>> encodeMinSigned 128
"\NUL\128"
>>> encodeMinSigned (-1)
"\255"
>>> encodeMinSigned (-128)
"\128"
>>> encodeMinSigned (-129)
"\255\DEL"

Encode a BigSize value (variable-length unsigned integer).

>>> encodeBigSize 0
"\NUL"
>>> encodeBigSize 252
"\252"
>>> encodeBigSize 253
"\253\NUL\253"
>>> encodeBigSize 65536
"\254\NUL\SOH\NUL\NUL"

Decode a 16-bit unsigned integer (big-endian).

Decode a 32-bit unsigned integer (big-endian).

Decode a 64-bit unsigned integer (big-endian).

Decode an 8-bit signed integer.

Decode a 16-bit signed integer (big-endian two's complement).

Decode a 32-bit signed integer (big-endian two's complement).

Decode a 64-bit signed integer (big-endian two's complement).

Decode a truncated 16-bit unsigned integer (0-2 bytes).

Returns Nothing if the encoding is non-minimal (has leading zeros).

Decode a truncated 32-bit unsigned integer (0-4 bytes).

Returns Nothing if the encoding is non-minimal (has leading zeros).

Decode a truncated 64-bit unsigned integer (0-8 bytes).

Returns Nothing if the encoding is non-minimal (has leading zeros).

Decode a minimal signed integer (1, 2, 4, or 8 bytes).

Validates that the encoding is minimal: the value could not be represented in fewer bytes. Per BOLT #1 Appendix D test vectors.

Decode a BigSize value with minimality check.

Encode a length as u16, checking bounds.

Returns Nothing if the length exceeds 65535.