Class P2WSHEncoder

Main P2WSH Data Encoder implementation

Implements

IDataEncoder<P2WSHData, P2WSHEncodingOptions>

Index

Constructors

Methods

decode decodeFromWitnessScripts encode getMaxDataSize getType validate

Constructors

constructor

new P2WSHEncoder(network?: Network, dustValue?: number): P2WSHEncoder
Parameters
- network: Network = bitcoin.networks.bitcoin
- dustValue: number = BinaryDataUtils.DEFAULT_DUST_VALUE
Returns P2WSHEncoder
- Defined in encoders/p2wsh-encoder.ts:263

Methods

decode

decode(outputs: TransactionOutput[]): P2WSHData
Decode binary data from P2WSH outputs
Parameters
- outputs: TransactionOutput[]
Returns P2WSHData
Implementation of IDataEncoder.decode
- Defined in encoders/p2wsh-encoder.ts:342

decodeFromWitnessScripts

decodeFromWitnessScripts(witnessScripts: Buffer<ArrayBufferLike>[]): P2WSHData
Decode from witness scripts (when available)
Parameters
- witnessScripts: Buffer<ArrayBufferLike>[]
Returns P2WSHData
- Defined in encoders/p2wsh-encoder.ts:362

encode

encode(
    data: P2WSHData,
    options?: P2WSHEncodingOptions,
    customTemplate?: any,
): P2WSHEncodingResult
Encode binary data using P2WSH standard
Parameters
- data: P2WSHData
- Optionaloptions: P2WSHEncodingOptions
- OptionalcustomTemplate: any
Returns P2WSHEncodingResult
Implementation of IDataEncoder.encode
- Defined in encoders/p2wsh-encoder.ts:274

getMaxDataSize

getMaxDataSize(): number
Get maximum data size that can be encoded

Returns number
Implementation of IDataEncoder.getMaxDataSize
- Defined in encoders/p2wsh-encoder.ts:409

getType

getType(): string
Get encoder type

Returns string
Implementation of IDataEncoder.getType
- Defined in encoders/p2wsh-encoder.ts:417

validate

validate(data: P2WSHData): boolean
Validate P2WSH data
Parameters
- data: P2WSHData
Returns boolean
Implementation of IDataEncoder.validate
- Defined in encoders/p2wsh-encoder.ts:392