Skip to main content

Class: StorageDepositReturnUnlockCondition

A Storage Deposit Return Unlock Condition.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new StorageDepositReturnUnlockCondition(returnAddress, amount)

Parameters

NameTypeDescription
returnAddressAddressThe address to return the amount to.
amountstring | bigintThe amount the consuming transaction must deposit to returnAddress.

Overrides

UnlockCondition.constructor

Properties

type

Readonly type: UnlockConditionType

Inherited from

UnlockCondition.type


amount

Readonly amount: string

The amount the consuming transaction must deposit to returnAddress.


returnAddress

Readonly returnAddress: Address

The address to return the amount to.

Methods

getType

getType(): UnlockConditionType

Get the type of unlock condition.

Returns

UnlockConditionType

Inherited from

UnlockCondition.getType


parse

Static parse(data): UnlockCondition

Parse an unlock condition from a plain JS JSON object.

Parameters

NameType
dataany

Returns

UnlockCondition

Inherited from

UnlockCondition.parse


getAmount

getAmount(): bigint

Get the amount.

Returns

bigint


getReturnAddress

getReturnAddress(): Address

Get the return address.

Returns

Address