BECH32(3em)

🎀 NAME 🎀

okay so this is the bech32 page from the 3em manual, and it's literally the bech32 codec 💅. bestie, we're decoding a very specific little variant, so stay with me 🫶.

✨ SYNOPSIS ✨

local bech32 = require 'bech32'

bech32.bolt11_decode(output: byte_span, input: byte_span|string) -> string, byte_span, "m"|nil (1)
bech32.bolt11_decode(input: byte_span|string) -> string, byte_span, "m"|nil (2)

so there are two call shapes, numbered (1) and (2) above — one takes output plus input, and the other takes just input. both hand you back that same string, byte_span, "m"|nil tuple situation 🌸.

💖 DESCRIPTION 💖

okay so this decodes a non-compliant BECH32 variant that is friendlier to BOLT11 — yes, it's giving "special little guy" energy, and we love that for it 🔥.

here's the tea:

• the 5bit groups are not converted into 8bit groups — i.e. the highest value you’ll be able to find in each byte from the returned slice is 0x1F 👀.
• it MAY exceed the 90-character limit specified in BIP-0173, so do not come in here expecting vanilla BIP-0173 behavior, bestie 😭.

output should have at least bolt11_decode_output_length(input) bytes. like, that's the requirement — don't skimp on the output buffer 💀.

it returns a tuple with these elements:

• the lower-case version of the human-readable part — lowercase era, periodt ✨.
• the slice of output that was used to decode the address 🎀.
• the encoding variant — or nil on none 🦋.

🌈 real talk: this is a non-compliant BECH32 variant, so the vibe check is "friendlier to BOLT11", not "standard BIP-0173 rules apply." iykyk 💅.

✨ that's the whole page, bestie — this bech32(3em) manual is from Emilua 0.12.1, dated 1980-01-01. mwah 💋🫶