TzKTTransaction

public struct TzKTTransaction : Codable, CustomStringConvertible, Hashable, Identifiable

A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations


                    
                    
                    dateFormatter

Declaration

Swift

public static let dateFormatter: DateFormatter

Types


                    
                    
                    TransactionStatus

Declaration

Swift

public enum TransactionStatus : String, Codable


                    
                    
                    TransactionType

Declaration

Swift

public enum TransactionType : String, Codable


                    
                    
                    TransactionSubType

Declaration

Swift

public enum TransactionSubType : String, Codable


                    
                    
                    TransactionError

Declaration

Swift

public struct TransactionError : Codable

Properties

type
Declaration
Swift

public let type: TransactionType
id
Declaration
Swift

public let id: Decimal
level
Declaration
Swift

public let level: Decimal
timestamp
Declaration
Swift

public let timestamp: String
hash
Declaration
Swift

public let hash: String
counter
Declaration
Swift

public let counter: Decimal
initiater
Declaration
Swift

public let initiater: TzKTAddress?
sender
Declaration
Swift

public let sender: TzKTAddress
bakerFee
Declaration
Swift

public var bakerFee: XTZAmount
storageFee
Declaration
Swift

public var storageFee: XTZAmount
allocationFee
Declaration
Swift

public var allocationFee: XTZAmount
target
Declaration
Swift

public var target: TzKTAddress?
prevDelegate
Declaration
Swift

public let prevDelegate: TzKTAddress?
newDelegate
Declaration
Swift

public let newDelegate: TzKTAddress?
amount
Declaration
Swift

public var amount: TokenAmount


                    
                    
                    parameter

Declaration

Swift

public let parameter: [String : String]?

status
Declaration
Swift

public let status: TransactionStatus
hasInternals
Declaration
Swift

public let hasInternals: Bool


                    
                    
                    tokenTransfersCount

Declaration

Swift

public let tokenTransfersCount: Decimal?

errors
Declaration
Swift

public let errors: [TransactionError]?
date
Declaration
Swift

public let date: Date?


                    
                    
                    tzktTokenTransfer

Declaration

Swift

public var tzktTokenTransfer: TzKTTokenTransfer? { get set }

subType
Declaration
Swift

public var subType: TransactionSubType?
entrypointCalled
Declaration
Swift

public var entrypointCalled: String?
primaryToken
Declaration
Swift

public var primaryToken: Token?

CustomStringConvertible

description
Declaration
Swift

public var description: String { get }

Hashable


                    
                    
                    hash(into:)

Declaration

Swift

public func hash(into hasher: inout Hasher)


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: TzKTTransaction, rhs: TzKTTransaction) -> Bool

Codable Protocol


                    
                    
                    CodingKeys

Declaration

Swift

public enum CodingKeys : String, CodingKey


                    
                    
                    init(type:id:level:timestamp:hash:counter:initiater:sender:bakerFee:storageFee:allocationFee:target:prevDelegate:newDelegate:amount:parameter:status:hasInternals:tokenTransfersCount:errors:)

Manually init a TzKTTransaction

Declaration

Swift

public init(type: TransactionType, id: Decimal, level: Decimal, timestamp: String, hash: String, counter: Decimal, initiater: TzKTAddress?, sender: TzKTAddress, bakerFee: XTZAmount, storageFee: XTZAmount, allocationFee: XTZAmount, target: TzKTAddress?, prevDelegate: TzKTAddress?, newDelegate: TzKTAddress?, amount: TokenAmount, parameter: [String : String]?, status: TransactionStatus, hasInternals: Bool, tokenTransfersCount: Decimal?, errors: [TransactionError]?)

init(from:)
Convert a TzKTTokenTransfer into a TzKTTransaction
Declaration
Swift

public init(from: TzKTTokenTransfer)


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws


                    
                    
                    encode(to:)

Declaration

Swift

public func encode(to encoder: Encoder) throws


                    
                    
                    placeholder(withStatus:opHash:type:counter:fromWallet:destination:xtzAmount:parameters:primaryToken:)

Used for creating “Pending” transactions

Declaration

Swift

public static func placeholder(withStatus status: TransactionStatus, opHash: String, type: TransactionType, counter: Decimal, fromWallet: WalletMetadata, destination: TzKTAddress, xtzAmount: TokenAmount, parameters: [String : String]?, primaryToken: Token?) -> TzKTTransaction


                    
                    
                    placeholder(withStatus:opHash:type:counter:fromWallet:newDelegate:)

Used for createing a “Pending” delegation transaction

Declaration

Swift

public static func placeholder(withStatus status: TransactionStatus, opHash: String, type: TransactionType, counter: Decimal, fromWallet: WalletMetadata, newDelegate: TzKTAddress?) -> TzKTTransaction

Helpers


                    
                    
                    parameterValueAsArray()

Declaration

Swift

public func parameterValueAsArray() -> [Any]?


                    
                    
                    parameterValueAsDict()

Declaration

Swift

public func parameterValueAsDict() -> [String : Any]?


                    
                    
                    parameterValueAsArrayOfDictionary()

Declaration

Swift

public func parameterValueAsArrayOfDictionary() -> [[String : Any]]?


                    
                    
                    parameterValueAsType(type:)

Declaration

Swift

public func parameterValueAsType<T>(type: T.Type) -> T?

getEntrypoint()
Declaration
Swift

public func getEntrypoint() -> String?


                    
                    
                    processAdditionalData(withCurrentWalletAddress:)

Declaration

Swift

public mutating func processAdditionalData(withCurrentWalletAddress currentWalletAddress: String)


                    
                    
                    createPrimaryToken()

Declaration

Swift

public func createPrimaryToken() -> Token?

getFaTokenTransferData()
The TzKT transaction API doesn’t provide all the info needed to normalise Token amounts. It only gives address and rpc amount. Burried inside the michelson, the dex contract needs to be told the token id, and the target will contain the address. This function will try to extract address, token id and rpc amount and return them in the standard objects, so that they can be used in conjuction with other functions to fetch the decimal data. e.g. DipDup client can fetch all tokens from dexes, containing all token info. Using the address and id, the rest could be found via that, assuming zero for anything else (such as NFTs)
Declaration
Swift

public func getFaTokenTransferData() -> Token?


                    
                    
                    getTokenTransferDestination()

Declaration

Swift

public func getTokenTransferDestination() -> String?

errorString()
Declaration
Swift

public func errorString() -> String?