Class: StorageDepositReturnUnlockCondition

A Storage Deposit Return Unlock Condition.

Hierarchy

• UnlockCondition

  ↳ StorageDepositReturnUnlockCondition

Table of contents

Constructors

• constructor

Properties

• type
• amount
• returnAddress

Methods

• getType
• parse
• getAmount
• getReturnAddress

Constructors

constructor

• new StorageDepositReturnUnlockCondition(returnAddress, amount)

Parameters

Name	Type	Description
returnAddress	Address	The address to return the amount to.
amount	string | bigint	The 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

Name	Type
data	any

Returns

UnlockCondition

Inherited from

UnlockCondition.parse

---

getAmount

▸ getAmount(): bigint

Get the amount.

Returns

bigint

---

getReturnAddress

▸ getReturnAddress(): Address

Get the return address.

Returns

Address