Class BCUR2Encoder

Class for encoding Bitcoin transaction data into BCUR2 QR codes. Supports encoding of:

PSBT: Partially Signed Bitcoin Transactions in base64 format

Index

Constructors

Accessors

data maxFragmentLength qrFragments

Methods

encodePSBT estimateFragmentCount

Constructors

constructor

new BCUR2Encoder(
    data: string,
    maxFragmentLength?: number,
    registyType?: "crypto-psbt" | "bytes",
): BCUR2Encoder
Creates a new BCUR2 encoder instance
Parameters
- data: string
  The data to encode (e.g., base64 PSBT string)
- maxFragmentLength: number = 100
  Maximum length of each QR code fragment (default: 100)
- registyType: "crypto-psbt" | "bytes" = "crypto-psbt"
Returns BCUR2Encoder
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:34

Accessors

data

get data(): string
Gets the current data

Returns string
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:78
set data(data: string): void
Sets new data to encode
Parameters
- data: string
Returns void
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:71

maxFragmentLength

get maxFragmentLength(): number
Gets the current maximum fragment length

Returns number
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:92
set maxFragmentLength(length: number): void
Sets the maximum fragment length for QR codes
Parameters
- length: number
Returns void
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:85

qrFragments

get qrFragments(): string[]
Returns string[]
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:102

Methods

encodePSBT

encodePSBT(): string[]
Encodes a PSBT (Partially Signed Bitcoin Transaction) into BCUR2 QR code fragments

Returns string[]
Array of QR code fragments as strings

Throws
Error if encoding fails
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:60

estimateFragmentCount

estimateFragmentCount(): number
Estimates the number of QR code fragments that will be generated

Returns number
Estimated number of fragments
- Defined in packages/caravan-wallets/src/bcur2/encoder.ts:110