blob: 67d6476facd1128063458b024540527b74aba568 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/**
* Implements bech32 and bech32m from
* [BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#specification)
* and [BIP-0350](https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki#specification).
*
* ```js
* import { fromBech32, toBech32 } from '@exodus/bytes/bech32.js'
* import { fromBech32m, toBech32m } from '@exodus/bytes/bech32.js'
* import { getPrefix } from '@exodus/bytes/bech32.js'
* ```
*
* @module @exodus/bytes/bech32.js
*/
/// <reference types="node" />
import type { Uint8ArrayBuffer } from './array.js';
/**
* Result of decoding a bech32 or bech32m string
*/
export interface Bech32DecodeResult {
/** The human-readable prefix */
prefix: string;
/** The decoded bytes */
bytes: Uint8ArrayBuffer;
}
/**
* Encode bytes to a bech32 string
*
* @param prefix - The human-readable prefix (e.g., 'bc' for Bitcoin)
* @param bytes - The input bytes to encode
* @param limit - Maximum length of the encoded string (default: 90)
* @returns The bech32 encoded string
*/
export function toBech32(prefix: string, bytes: Uint8Array, limit?: number): string;
/**
* Decode a bech32 string to bytes
*
* @param string - The bech32 encoded string
* @param limit - Maximum length of the input string (default: 90)
* @returns The decoded prefix and bytes
*/
export function fromBech32(string: string, limit?: number): Bech32DecodeResult;
/**
* Encode bytes to a bech32m string
*
* @param prefix - The human-readable prefix (e.g., 'bc' for Bitcoin)
* @param bytes - The input bytes to encode
* @param limit - Maximum length of the encoded string (default: 90)
* @returns The bech32m encoded string
*/
export function toBech32m(prefix: string, bytes: Uint8Array, limit?: number): string;
/**
* Decode a bech32m string to bytes
*
* @param string - The bech32m encoded string
* @param limit - Maximum length of the input string (default: 90)
* @returns The decoded prefix and bytes
*/
export function fromBech32m(string: string, limit?: number): Bech32DecodeResult;
/**
* Extract the prefix from a bech32 or bech32m string without full validation
*
* This is a quick check that skips most validation.
*
* @param string - The bech32/bech32m encoded string
* @param limit - Maximum length of the input string (default: 90)
* @returns The lowercase prefix
*/
export function getPrefix(string: string, limit?: number): string;
|
