Interface IDataEncoder

interface IDataEncoder {
    decode(outputs: TransactionOutput[]): P2WSHData | SRC20Data | StampData;
    encode(
        data: P2WSHData | SRC20Data | StampData,
        options?: EncodingOptions,
    ): EncodingResult;
    getMaxDataSize(): number;
    getType(): string;
    validate(data: P2WSHData | SRC20Data | StampData): boolean;
}

Index

Methods

decode encode getMaxDataSize getType validate

Methods

decode

decode(outputs: TransactionOutput[]): P2WSHData | SRC20Data | StampData
Decode data from transaction outputs
Parameters
- outputs: TransactionOutput[]
Returns P2WSHData | SRC20Data | StampData
- Defined in interfaces/encoder.interface.ts:35

encode

encode(
data: P2WSHData | SRC20Data | StampData,
options?: EncodingOptions,
): EncodingResult
Encode data into transaction outputs
Parameters
- data: P2WSHData | SRC20Data | StampData
- Optionaloptions: EncodingOptions
Returns EncodingResult
- Defined in interfaces/encoder.interface.ts:27

getMaxDataSize

getMaxDataSize(): number
Get maximum data size supported

Returns number
- Defined in interfaces/encoder.interface.ts:45

getType

getType(): string
Get encoder type/protocol name

Returns string
- Defined in interfaces/encoder.interface.ts:50

validate

validate(data: P2WSHData | SRC20Data | StampData): boolean
Validate if data can be encoded
Parameters
- data: P2WSHData | SRC20Data | StampData
Returns boolean
- Defined in interfaces/encoder.interface.ts:40