Skip to main content

Interface: OwnerLike

Enum of different types of ownership for an object.

BCS

The BCS serialized form for this type is defined by the following ABNF:

owner = owner-address / owner-object / owner-shared / owner-immutable

owner-address = %d00 address
owner-object = %d01 object-id
owner-shared = %d02 u64
owner-immutable = %d03

Methods​

addressOrObject()​

addressOrObject(): AddressLike | undefined;

Returns an Address if this object is owned by an address or object, and None if it is shared or immutable.

Returns​

AddressLike | undefined


asAddress()​

asAddress(): AddressLike;

Convert this owner into an address owner if it is one, or panic otherwise

Returns​

AddressLike


asObject()​

asObject(): ObjectIdLike;

Convert this owner into an object owner if it is one, or panic otherwise

Returns​

ObjectIdLike


asOptAddress()​

asOptAddress(): AddressLike | undefined;

Convert this owner into an address owner if it is one, or return None otherwise

Returns​

AddressLike | undefined


asOptObject()​

asOptObject(): ObjectIdLike | undefined;

Convert this owner into an object owner if it is one, or return None otherwise

Returns​

ObjectIdLike | undefined


asOptShared()​

asOptShared(): VersionLike | undefined;

Convert this owner into a shared owner if it is one, or return None otherwise

Returns​

VersionLike | undefined


asShared()​

asShared(): VersionLike;

Convert this owner into a shared owner if it is one, or panic otherwise

Returns​

VersionLike


isAddress()​

isAddress(): boolean;

Check if this is an address owner

Returns​

boolean


isImmutable()​

isImmutable(): boolean;

Check if this is an immutable owner

Returns​

boolean


isObject()​

isObject(): boolean;

Check if this is an object owner

Returns​

boolean


isShared()​

isShared(): boolean;

Check if this is a shared owner

Returns​

boolean