Class BCUR2Decoder

Class for decoding BCUR2 QR codes containing Bitcoin wallet data. Supports decoding of:

crypto-account: Contains output descriptors with keys
crypto-hdkey: Contains hierarchical deterministic keys

Index

Constructors

constructor

Methods

getDecodedData getDecodedPSBT getError getProgress isComplete percentComplete receivePart reset

Constructors

constructor

new BCUR2Decoder(
decoder?: URRegistryDecoder,
cryptoPSBTFromCBOR?: (_cborPayload: Buffer) => CryptoPSBT,
): BCUR2Decoder
Creates a new BCUR2 decoder instance
Parameters
- Optionaldecoder: URRegistryDecoder
  Optional URRegistryDecoder instance. If not provided, creates a new one.
- cryptoPSBTFromCBOR: (_cborPayload: Buffer) => CryptoPSBT = CryptoPSBT.fromCBOR
Returns BCUR2Decoder
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:68

Methods

getDecodedData

getDecodedData(network?: BitcoinNetwork): null | string | ExtendedPublicKeyData
Gets the decoded wallet data, if available
Parameters
- network: BitcoinNetwork = Network.MAINNET
  The Bitcoin network to use for decoding
Returns null | string | ExtendedPublicKeyData
The decoded data or null
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:243

getDecodedPSBT

getDecodedPSBT(): null | string
Gets the decoded PSBT data, if available

Returns null | string
The PSBT in base64 format or null
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:272

getError

getError(): null | string
Gets the last error message, if any

Returns null | string
The error message or null
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:234

getProgress

getProgress(): string
Gets the current progress of the decoding process

Returns string
The progress message
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:226

isComplete

isComplete(): boolean
Checks if the decoding process is complete

Returns boolean
True if complete, false otherwise
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:214

percentComplete

percentComplete(): number
Returns number
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:218

receivePart

receivePart(text: string): void
Receives a part of the QR code data and processes it
Parameters
- text: string
  The text data from the QR code
Returns void
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:191

reset

reset(
decoder?: URRegistryDecoder,
cryptoPSBTFromCBORFactory?: (_cborPayload: Buffer) => CryptoPSBT,
): void
Resets the decoder state to initial values
Parameters
- decoder: URRegistryDecoder = ...
  Optional URRegistryDecoder instance. If not provided, creates a new one.
- OptionalcryptoPSBTFromCBORFactory: (_cborPayload: Buffer) => CryptoPSBT
  Optional factory function for creating CryptoPSBT instances from CBOR
Returns void
- Defined in packages/caravan-wallets/src/bcur2/decoder.ts:81

Class BCUR2Decoder

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BCUR2Decoder

Methods

getDecodedData

Parameters

Returns null | string | ExtendedPublicKeyData

getDecodedPSBT

Returns null | string

getError

Returns null | string

getProgress

Returns string

isComplete

Returns boolean

percentComplete

Returns number

receivePart

Parameters

Returns void

reset

Parameters

Returns void

Settings

On This Page