Skip to main content

iota_sdk.types.unlock_condition

UnlockConditionType Objects​

class UnlockConditionType(IntEnum)

Unlock condition variants.

Attributes:

  • Address 0 - An address unlock condition.
  • StorageDepositReturn 1 - A storage deposit return unlock condition.
  • Timelock 2 - A timelock unlock condition.
  • Expiration 3 - An expiration unlock condition.
  • StateControllerAddress 4 - A state controller address unlock condition.
  • GovernorAddress 5 - A governor address unlock condition.
  • ImmutableAliasAddress 6 - An immutable alias address unlock condition.

UnlockCondition Objects​

@dataclass
class UnlockCondition()

Base class for unlock conditions.

AddressUnlockCondition Objects​

@dataclass
class AddressUnlockCondition(UnlockCondition)

An address unlock condition.

Arguments:

  • address - An address unlocked with a private key.

StorageDepositReturnUnlockCondition Objects​

@dataclass
class StorageDepositReturnUnlockCondition(UnlockCondition)

A storage-deposit-return unlock condition.

Arguments:

  • amount - The amount of base coins the consuming transaction must deposit to return_address.
  • return_address - The address to return the amount to.

TimelockUnlockCondition Objects​

@dataclass
class TimelockUnlockCondition(UnlockCondition)

A timelock unlock condition.

Arguments:

  • unix_time - The Unix timestamp marking the end of the timelock.

ExpirationUnlockCondition Objects​

@dataclass
class ExpirationUnlockCondition(UnlockCondition)

An expiration unlock condition.

Arguments:

  • unix_time - Unix timestamp marking the expiration of the claim.
  • return_address - The return address if the output was not claimed in time.

StateControllerAddressUnlockCondition Objects​

@dataclass
class StateControllerAddressUnlockCondition(UnlockCondition)

A state controller address unlock condition.

Arguments:

  • address - The state controller address that owns the output.

GovernorAddressUnlockCondition Objects​

@dataclass
class GovernorAddressUnlockCondition(UnlockCondition)

A governor address unlock condition.

Arguments:

  • address - The governor address that owns the output.

ImmutableAliasAddressUnlockCondition Objects​

@dataclass
class ImmutableAliasAddressUnlockCondition(UnlockCondition)

An immutable alias address unlock condition.

Arguments:

  • address - The permanent alias address that owns this output.