Structures
The following structures are available globally.
-
Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach
See moreDeclaration
Swift
public struct Account : Codable, Hashable
extension Account: Identifiable
-
Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker
See moreDeclaration
Swift
public struct AggregateRewardInformation : Codable, Hashable, Equatable
-
An individual payment record denoting some payment in the past or future
See moreDeclaration
Swift
public struct RewardDetails : Codable
-
A model matching the response that comes back from BetterCallDev’s API:
See morev1/opg/<operation-hash>
Declaration
Swift
public struct BetterCallDevOperation : Codable
-
BetterCallDev structure for errors
See moreDeclaration
Swift
public struct BetterCallDevOperationError : Codable
-
Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs
See moreDeclaration
Swift
public struct DipDupChartData : Codable
-
Structure holding a data slice
See moreDeclaration
Swift
public struct DipDupChartObject : Codable
-
Wrapper object to map to network response type
See moreDeclaration
Swift
public struct DipDupExchangesAndTokensResponse : Codable
-
Wrapper object to map to network response type
See moreDeclaration
Swift
public struct DipDupExchangesAndTokens : Codable
-
A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps
See moreDeclaration
Swift
public struct DipDupExchange : Codable, Hashable, Equatable
-
Wrapper object to match network response type
See moreDeclaration
Swift
public struct DipDupPosition : Codable
-
A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address
See moreDeclaration
Swift
public struct DipDupPositionData : Codable, Hashable, Equatable
-
DipDup representation of a Token
See moreDeclaration
Swift
public struct DipDupToken : Codable, Hashable, Equatable
-
Model mapping to TzKT.io’s Account object
See moreDeclaration
Swift
public struct TzKTAccount : Codable, Equatable
-
Model mapping to TzKT.io’s Account.Delegate Object
See moreDeclaration
Swift
public struct TzKTAccountDelegate : Codable, Equatable
-
Details about a given contract
See moreDeclaration
Swift
public struct TzKTAddress : Codable
-
Object to denote the the setting parameters of the baker. Can be used seperately for both delegation and staking
See moreDeclaration
Swift
public struct TzKTBakerSettings : Codable
-
Data representing a baker from TzKT or Baking-Bad
See moreDeclaration
Swift
public struct TzKTBaker : Codable, Hashable
-
Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT
See moreDeclaration
Swift
public struct TzKTBalance : Codable
-
Model encapsulating information about the token itself
See moreDeclaration
Swift
public struct TzKTBalanceToken : Codable
-
Metadata object for the token
See moreDeclaration
Swift
public struct TzKTBalanceMetadata : Codable
-
Wrapper / Helper to extract metadata attribute content
See moreDeclaration
Swift
public struct TzKTBalanceMetadataAttributeKeyValue : Codable, Hashable
-
Object containing information about the various formats the media is available in
See moreDeclaration
Swift
public struct TzKTBalanceMetadataFormat : Codable
-
Object containing information about the dimensions of a given piece of media
See moreDeclaration
Swift
public struct TzKTBalanceMetadataDimensions : Codable
-
The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks
See moreDeclaration
Swift
public struct TzKTCycle : Codable
-
An object containing info on the reward a delegator should receive from a baker
See moreDeclaration
Swift
public struct TzKTDelegatorReward : Codable
-
A model matching the response that comes back from TzKT’s API:
See morev1/operations/<operation-hash>
Declaration
Swift
public struct TzKTOperation : Codable
-
TzKT’s more basic error object response
See moreDeclaration
Swift
public struct TzKTOperationError : Codable
-
FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions
See moreDeclaration
Swift
public struct TzKTTokenTransfer : Codable
-
A model matching the response that comes back from TzKT’s API:
See morev1/accounts/<address>/operations
Declaration
Swift
public struct TzKTTransaction : Codable, CustomStringConvertible, Hashable, Identifiable
-
Artifical object used to group related transactions into a more user friendly display For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed
See moreDeclaration
Swift
public struct TzKTTransactionGroup : Codable, Hashable, Identifiable, CustomStringConvertible
-
Structure representing the HEAD of the blockchain
See moreDeclaration
Swift
public struct BlockchainHead : Codable
-
A struct to control what messages get logged
See moreDeclaration
Swift
public struct LoggingConfig
-
A configuration object used to provide settings to the TezosNodeClient
See moreDeclaration
Swift
public struct TezosNodeClientConfig
-
The gneric container object holding the raw data
See moreDeclaration
Swift
public struct QuipuswapExchangeLedgerKey : Codable
-
The unique data inside the Ledger BigMap
See moreDeclaration
Swift
public struct QuipuswapExchangeLedger : Codable
-
Network wrapper object
See moreDeclaration
Swift
public struct QuipuswapExchangeStorageResponse : Codable
-
Unique Quipuswap contract storage object
See moreDeclaration
Swift
public struct QuipuswapExchangeStorage : Codable
-
The gneric container object holding the raw data
See moreDeclaration
Swift
public struct QuipuswapExchangeUserRewardsKey : Codable
-
The unique data inside the User Rewards BigMap
See moreDeclaration
Swift
public struct QuipuswapExchangeUserRewards : Codable
-
Dedicated “FailWith” parser for the codes received from Liquidity Baking contract
See moreDeclaration
Swift
public struct FailWithParserLiquidityBaking : FailWithParser
-
GraphQL error object
See moreDeclaration
Swift
public struct GraphQLError : Codable
-
Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries
See moreDeclaration
Swift
public struct GraphQLResponse<T> : Codable where T : Decodable, T : Encodable
-
GarpQL bulk response for a group of collections
See moreDeclaration
Swift
public struct ObjktCollections : Codable
-
Single collection item
See moreDeclaration
Swift
public struct ObjktCollection : Codable
-
Declaration
Swift
public struct ObjktCreator : Codable
-
GarpQL response for required data for a given token
See moreDeclaration
Swift
public struct ObjktTokenReponse : Codable
-
Single token item
See moreDeclaration
Swift
public struct ObjktToken : Codable
-
Declaration
Swift
public struct ObjktAttribute : Codable
-
Declaration
Swift
public struct ObjktAttributeData : Codable
-
Declaration
Swift
public struct ObjktAttributeCounts : Codable
-
Declaration
Swift
public struct ObjktSale : Codable
-
Declaration
Swift
public struct ObjktListing : Codable
-
Single event item
See moreDeclaration
Swift
public struct ObjktEvent : Codable
-
Single FA item
See moreDeclaration
Swift
public struct ObjktFa : Codable
-
Response object wrapper for querying an address in bulk
See moreDeclaration
Swift
public struct TezosDomainsAddressBulkResponse : Codable
-
Object containing an array of domains
See moreDeclaration
Swift
public struct TezosDomainsDomains : Codable
-
Response object wrapper for querying an address
See moreDeclaration
Swift
public struct TezosDomainsAddressResponse : Codable
-
Domain object containing details about the domain
See moreDeclaration
Swift
public struct TezosDomainsDomain : Codable
-
Response object wrapper for querying a reverse record
See moreDeclaration
Swift
public struct TezosDomainsDomainResponse : Codable
-
Response object wrapper for querying a reverse record in bulk
See moreDeclaration
Swift
public struct TezosDomainsDomainBulkResponse : Codable
-
Object containing an array of reverse records
See moreDeclaration
Swift
public struct TezosDomainsReverseRecords : Codable
-
Object containing all the info of the tezos domains record
See moreDeclaration
Swift
public struct TezosDomainsReverseRecord : Codable
-
Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)
See moreDeclaration
Swift
public struct LiquidityBakingData : Codable
-
An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet
See moreDeclaration
Swift
public struct NFT : Codable, Hashable
extension NFT: Identifiable
-
The contants that a given Tezos node is using for block times, blakc size etc
See moreDeclaration
Swift
public struct NetworkConstants : Codable
-
The version of the Tezos code being run by the given node
See moreDeclaration
Swift
public struct NetworkVersion : Codable
-
property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil
See moreDeclaration
Swift
@propertyWrapper public struct NilOnDecodingError<Wrapped>
extension NilOnDecodingError: Decodable where Wrapped: Decodable
extension NilOnDecodingError: Encodable where Wrapped: Encodable
-
Declaration
Swift
public struct OperationBlockHeader : Codable, Equatable
-
A structure representing the request that needs to be made when sending
See moreOpertion
‘s to the RPCDeclaration
Swift
public struct OperationPayload : Codable, Equatable
-
Structure representing the response returned from RPC endpoints such as
See more.../preapply/operations
Declaration
Swift
public struct OperationResponse : Codable
-
The main
See morecontent
of the JSON returnedDeclaration
Swift
public struct OperationResponseContent : Codable
-
The metadata belonging to the
OperationResponse
Declaration
Swift
public struct OperationResponseMetadata : Codable
-
Struct representing a change to the balance of the sender, destination or intermediary contract
Declaration
Swift
public struct BalanceUpdate : Codable
-
Declaration
Swift
public struct BalanceUpdateStake : Codable
-
The inner
result
key from theOeprationResponse
Declaration
Swift
public struct OperationResponseResult : Codable
-
Definition of the internal operation found inside
OperationResponse
Declaration
Swift
public struct OperationResponseInternalOperation : Codable
-
Definition of the outer Error object found inside
See moreOperationResponseInternalResult
Declaration
Swift
public struct OperationResponseInternalResultError : Codable, Equatable
-
The error string, error int (code), or micheline error object returned inside
See moreFailWith
Declaration
Swift
public struct FailWith : Codable, Equatable
-
Payload object needed when sending operations to …/run_operation
Declaration
Swift
public struct RunOperationPayload : Codable
-
Object for sending a request through SignalR to listen to operations for a given account
Declaration
Swift
public struct OperationSubscription : Codable
-
A struct to hold all the necessary calculations for a dex trade
See moreDeclaration
Swift
public struct DexSwapCalculationResult
-
A struct to hold all the necessary calculations for adding liquidity to a dex contract
See moreDeclaration
Swift
public struct DexAddCalculationResult
-
A struct to hold all the necessary calculations for removing liquidity from a dex contract
See moreDeclaration
Swift
public struct DexRemoveCalculationResult
-
A struct conforming to
See moreError
, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbaledescription
to ensure something useful is always shown to the user.Declaration
Swift
public struct KukaiError : CustomStringConvertible, Error
-
SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data
See moreDeclaration
Swift
public struct SubverifierWrapper