BECH32(3em)

🌸 NAME 🌸

okay so welcome to BECH32(3em), bestie — this is the page for the bech32 codec, and yes I folded the manual name in cutely instead of copy-pasting the header line 💅

bech32 — bech32 codec, periodt.

✨ SYNOPSIS ✨

local bech32 = require 'bech32'

bech32.mb_decode(output: byte_span, input: byte_span) (1)
bech32.mb_decode(input: byte_span) -> byte_span (2)

so you start with local bech32 = require 'bech32', then pick your fighter:

• (1) bech32.mb_decode(output: byte_span, input: byte_span) — you pass in an output and an input, no cap.
• (2) bech32.mb_decode(input: byte_span) -> byte_span — you pass just an input and get a byte_span back, iconic.

🎀 DESCRIPTION 🎀

the whole assignment is literally repack bits 🫶

it performs 5bit groups to 8bit groups conversion, where each group — either 5bit or 8bit — is encoded as a single byte. the 5bit groups only use the lower bits of a byte, meaning the highest possible value in each byte for the 5bit groups bytestream will be 0x1F 🔥 the 8bit groups concatenate the lower bits from consecutive byte-encoded 5bit groups to create each byte, and the value 0 is used as padding if necessary ✨

it raises an error on incomplete input — like a missing 5bit group to finish the last 8bit group, non-zero bits in the padding bits of a 5bit group, ... yeah those vibes 😭💀

xoxo, this page was brought to you by Emilua 0.12.1, dated 1980-01-01 — BECH32(3em) out 💅💖