Interface IUnwrapTransaction

Description

This interface represents an unwrap transaction. IUnwrapTransaction

interface IUnwrapTransaction {
    authorizedBy: string[];
    burnedBitcoin: BigNumberish;
    calldata: string | Buffer;
    consolidatedVault: undefined | PartialWBTCUTXODocument | ParsedPartialWBTCUTXODocument;
    contractAddress: string;
    contractSecret: string | Buffer;
    events: ContractEvents;
    from: string;
    gasUsed: string | bigint;
    hash: string;
    id: string;
    index: number;
    inputs: ITransactionInput[] | TransactionInput[];
    interactionPubKey: string | Buffer;
    OPNetType: InteractionType;
    outputs: ITransactionOutput[] | TransactionOutput[];
    receipt?: string | Buffer;
    receiptProofs?: string[];
    requestedAmount: string | bigint;
    revert?: string | Buffer;
    senderPubKeyHash: string | Buffer;
    unwrapAmount: string | bigint;
    usedUTXOs: UsedUTXO[];
    wasCompressed: boolean;
}

Hierarchy (view full)

Implemented by

Properties

authorizedBy burnedBitcoin calldata consolidatedVault contractAddress contractSecret events from gasUsed hash id index inputs interactionPubKey OPNetType outputs receipt? receiptProofs? requestedAmount revert? senderPubKeyHash unwrapAmount usedUTXOs wasCompressed

Properties

ReadonlyauthorizedBy

authorizedBy: string[]

Description

The trusted indexers that authorized this transaction.

ReadonlyburnedBitcoin

burnedBitcoin: BigNumberish

Description

Returns the amount of satoshi that were burned in the transaction.

Readonlycalldata

calldata: string | Buffer

Description

The calldata of the transaction.

ReadonlyconsolidatedVault

consolidatedVault: undefined | PartialWBTCUTXODocument | ParsedPartialWBTCUTXODocument

Description

The consolidated vault. If any.

ReadonlycontractAddress

contractAddress: string

Description

This indicates which contract the transaction was sent to. (AKA to)

ReadonlycontractSecret

contractSecret: string | Buffer

Description

The contract secret.

Readonlyevents

events: ContractEvents

Description

If the interaction returned events, they will be stored here.

Readonlyfrom

from: string

Description

Who sent the transaction. (ALWAYS TAPROOT. This address is generated from the P2TR of the pubkey of the deployer.)

ReadonlygasUsed

gasUsed: string | bigint

Description

The amount of gas used by the transaction.

Readonlyhash

hash: string

Description

The transaction "hash".

Readonlyid

id: string

Description

The transaction ID (hash).

Readonlyindex

index: number

Description

The index of the transaction in the block.

Readonlyinputs

inputs: ITransactionInput[] | TransactionInput[]

Description

The inputs of the transaction.

ReadonlyinteractionPubKey

interactionPubKey: string | Buffer

Description

The interaction public key.

ReadonlyOPNetType

OPNetType: InteractionType

Description

The type of the transaction.

Readonlyoutputs

outputs: ITransactionOutput[] | TransactionOutput[]

Description

The outputs of the transaction.

Optional Readonlyreceipt

receipt?: string | Buffer

Description

The receipt of the transaction.

Optional ReadonlyreceiptProofs

receiptProofs?: string[]

Description

The receipt proofs of the transaction.

ReadonlyrequestedAmount

requestedAmount: string | bigint

Description

The requested amount.

Optional Readonlyrevert

revert?: string | Buffer

Description

If the transaction was reverted, this field will contain the revert message.

ReadonlysenderPubKeyHash

senderPubKeyHash: string | Buffer

Description

The sender's public key hash.

ReadonlyunwrapAmount

unwrapAmount: string | bigint

Description

The amount to unwrap.

ReadonlyusedUTXOs

usedUTXOs: UsedUTXO[]

Description

The UTXOs used in this transaction.

ReadonlywasCompressed

wasCompressed: boolean

Description

Was the binary data compressed?

Settings

Member Visibility

On This Page

Properties