Class BIP21

Index

Constructors

Methods

amountSats create parse

Constructors

constructor

new BIP21(): BIP21
Returns BIP21

Methods

`Static`amountSats

amountSats(uri: string): number | undefined
Integer-sats amount encoded in a BIP21 URI (amount= is BTC), or undefined when absent or the URI is unparseable. Shared by the payment rails, which accept either a bare address or a BIP21 URI.
Parameters
- uri: string
  BIP21 URI (or bare address) to read the amount from
Returns number | undefined
The amount in satoshis, or undefined
- Defined in packages/ts-sdk/src/utils/bip21.ts:107

`Static`create

create(params: BIP21Params): string
Create a BIP21 URI from the provided parameters.
Parameters
- params: BIP21Params
  BIP21 parameters to encode
Returns string
Encoded BIP21 URI
- Defined in packages/ts-sdk/src/utils/bip21.ts:49

`Static`parse

parse(uri: string): BIP21ParseResult
Parse a BIP21 URI and return its decoded parameters.
Parameters
- uri: string
  BIP21 URI to parse
Returns BIP21ParseResult
Parsed BIP21 URI data

Throws
Error if the URI does not start with the bitcoin: scheme
- Defined in packages/ts-sdk/src/utils/bip21.ts:123