Skip to main content

Object

Object​

class Object

An object on the IOTA blockchain

BCS

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

object = object-data owner digest u64

init(data:owner:previousTransaction:storageRebate:)​

convenience init(data: ObjectData, owner: Owner, previousTransaction: TransactionDigest, storageRebate: UInt64)

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

asPackage()​

func asPackage() -> MovePackage

Interpret this object as a move package

asPackageOpt()​

func asPackageOpt() -> MovePackage?

Try to interpret this object as a move package

asStruct()​

func asStruct() -> MoveStruct

Interpret this object as a move struct

asStructOpt()​

func asStructOpt() -> MoveStruct?

Try to interpret this object as a move struct

data()​

func data() -> ObjectData

Return this object's data

digest()​

func digest() -> ObjectDigest

Calculate the digest of this Object

This is done by hashing the BCS bytes of this Object prefixed

id()​

func id() -> ObjectId

Return this object's id

objectRef()​

func objectRef() -> ObjectReference

Return this object's reference

objectType()​

func objectType() -> ObjectType

Return this object's type

owner()​

func owner() -> Owner

Return this object's owner

previousTransaction()​

func previousTransaction() -> TransactionDigest

Return the digest of the transaction that last modified this object

storageRebate()​

func storageRebate() -> UInt64

Return the storage rebate locked in this object

Storage rebates are credited to the gas coin used in a transaction that deletes this object.

version()​

func version() -> Version

Return this object's version

!=(_:_:)​

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.

==(_:_:)​

static func == (self: Object, other: Object) -> Bool

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.