Interface IWrapTransaction

Description

This interface represents a wrap transaction. IWrapTransaction

interface IWrapTransaction {
    burnedBitcoin: BigNumberish;
    calldata: string | Buffer;
    contractAddress: string;
    contractSecret: string | Buffer;
    depositAddress: string;
    depositAmount: string | bigint;
    events: ContractEvents;
    from: string;
    gasUsed: string | bigint;
    hash: string;
    id: string;
    index: number;
    inputs: ITransactionInput[] | TransactionInput[];
    interactionPubKey: string | Buffer;
    minimumSignatures: number;
    OPNetType: InteractionType;
    outputs: ITransactionOutput[] | TransactionOutput[];
    penalized: boolean;
    pubKeys: string[];
    receipt?: string | Buffer;
    receiptProofs?: string[];
    revert?: string | Buffer;
    senderPubKeyHash: string | Buffer;
    vault: string;
    wasCompressed: boolean;
    wrappingFees: string | bigint;
}

Hierarchy (view full)

Implemented by

Properties

burnedBitcoin calldata contractAddress contractSecret depositAddress depositAmount events from gasUsed hash id index inputs interactionPubKey minimumSignatures OPNetType outputs penalized pubKeys receipt? receiptProofs? revert? senderPubKeyHash vault wasCompressed wrappingFees

Properties

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.

ReadonlycontractAddress

contractAddress: string

Description

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

ReadonlycontractSecret

contractSecret: string | Buffer

Description

The contract secret.

ReadonlydepositAddress

depositAddress: string

Description

The address where the deposit was made.

ReadonlydepositAmount

depositAmount: string | bigint

Description

The final amount that was deposited.

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.

ReadonlyminimumSignatures

minimumSignatures: number

Description

The minimum amount of signatures required for the vault.

ReadonlyOPNetType

OPNetType: InteractionType

Description

The type of the transaction.

Readonlyoutputs

outputs: ITransactionOutput[] | TransactionOutput[]

Description

The outputs of the transaction.

Readonlypenalized

penalized: boolean

Description

Was the wrapping transaction penalized due to invalid calldata?

ReadonlypubKeys

pubKeys: string[]

Description

The vault trusted public keys used for the wrap.

Optional Readonlyreceipt

receipt?: string | Buffer

Description

The receipt of the transaction.

Optional ReadonlyreceiptProofs

receiptProofs?: string[]

Description

The receipt proofs of the transaction.

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.

Readonlyvault

vault: string

Description

The vault used to store the Bitcoin.

ReadonlywasCompressed

wasCompressed: boolean

Description

Was the binary data compressed?

ReadonlywrappingFees

wrappingFees: string | bigint

Description

The fees that were paid for wrapping.

Settings

Member Visibility

On This Page

Properties